carbond.mongodb.MongoDBInsertConfig

extends InsertConfig

The MongoDB insert operation config

Instance Properties

allowUnauthenticated
boolean
Inherited fromInsertConfig
Default false
Description Allow unauthenticated requests to the operation
description
string
Inherited fromInsertConfig
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
Inherited fromInsertConfig
(read-only)
Description The parent endpoint/collection that this configuration is a member of
example
Inherited fromInsertConfig
Default undefined
Description An example response body used for documentation
idParameterName
string
Inherited fromInsertConfig
(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 fromInsertConfig
Default false
Description Exclude the operation from “docgen” API documentation
options
object.<string, *>
Inherited fromInsertConfig
Required
Description Any additional options that should be added to options passed down to a handler.
parameters
object.<string, carbond.OperationParameter>
Inherited fromInsertConfig
Required
Description The body parameter definition
responses
Object.<string, carbond.OperationResponse>
Inherited fromInsertConfig
Required
Description Add custom responses for an operation. Note, this will override all default responses.
returnsInsertedObjects
boolean
Inherited fromInsertConfig
Default true
Description Whether or not the HTTP layer returns the objects inserted in the response
schema
Inherited fromInsertConfig
Default undefined
Description The schema used to validate the request body. If this is undefined, the collection level schema (adapted for arrays) will be used. Note, schema takes precedence.