carbond.mongodb.MongoDBRemoveConfig

extends RemoveConfig

The MongoDB remove operation config

Instance Properties

allowUnauthenticated
boolean
Inherited fromRemoveConfig
Default false
Description Allow unauthenticated requests to the operation
description
string
Inherited fromRemoveConfig
Default undefined
Description A brief description of the operation used by the documentation generator
driverOptions
object.<string, *>
Required
Description Options to be passed to the mongodb driver (XXX: link to leafnode docs)
endpoint
Endpoint
Inherited fromRemoveConfig
(read-only)
Description The parent endpoint/collection that this configuration is a member of
example
object
Inherited fromRemoveConfig
Default undefined
Description An example response body used for documentation
idParameterName
string
Inherited fromRemoveConfig
(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 fromRemoveConfig
Default false
Description Exclude the operation from “docgen” API documentation
options
object.<string, *>
Inherited fromRemoveConfig
Required
Description Any additional options that should be added to options passed down to a handler.
parameters
object.<string, carbond.OperationParameter>
Required
Description The “query” parameter definition (will be omitted if supportsQuery is false)
responses
Object.<string, carbond.OperationResponse>
Inherited fromRemoveConfig
Required
Description Add custom responses for an operation. Note, this will override all default responses.
returnsRemovedObjects
boolean
Inherited fromRemoveConfig
Default false
Description Whether or not the HTTP layer returns objects removed
supportsQuery
boolean
Default true
Description Whether or not the query parameter is supported. Note, “query” here refers to a MongoDB query and not the query string component of the URL.