carbond.collections.RemoveConfig

extends CollectionOperationConfig

The remove operation config

Instance Properties

allowUnauthenticated
boolean
Inherited fromCollectionOperationConfig
Default false
Description Allow unauthenticated requests to the operation
description
string
Inherited fromCollectionOperationConfig
Default undefined
Description A brief description of the operation used by the documentation generator
endpoint
Endpoint
Inherited fromCollectionOperationConfig
(read-only)
Description The parent endpoint/collection that this configuration is a member of
example
object
Inherited fromCollectionOperationConfig
Default undefined
Description An example response body used for documentation
idParameterName
string
Inherited fromCollectionOperationConfig
(read-only)
Description The collection object id property name. Note, this is configured on the top level Collection and set on the configure during initialzation.
noDocument
boolean
Inherited fromCollectionOperationConfig
Default false
Description Exclude the operation from “docgen” API documentation
options
object.<string, *>
Inherited fromCollectionOperationConfig
Required
Description Any additional options that should be added to options passed down to a handler.
parameters
object.<string, carbond.OperationParameter>
Inherited fromCollectionOperationConfig
Required
Description Operation specific parameters (e.g., “skip”, “limit”). These will be passed down to the operation handlers via the options parameter if they are not explicitly passed via another leading parameter (e.g., “id” and “update” for updateObject).
responses
Object.<string, carbond.OperationResponse>
Inherited fromCollectionOperationConfig
Required
Description Add custom responses for an operation. Note, this will override all default responses.
returnsRemovedObjects
boolean
Default false
Description Whether or not the HTTP layer returns objects removed