carbond.mongodb.MongoDBFindObjectConfig

extends FindObjectConfig

The MongoDB find object operation config

Instance Properties

allowUnauthenticated	boolean Inherited fromFindObjectConfig
Default	false
Description	Allow unauthenticated requests to the operation

description	string Inherited fromFindObjectConfig
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 fromFindObjectConfig (read-only)
Description	The parent endpoint/collection that this configuration is a member of

example	object Inherited fromFindObjectConfig
Default	undefined
Description	An example response body used for documentation

idParameterName	string Inherited fromFindObjectConfig (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 fromFindObjectConfig
Default	false
Description	Exclude the operation from “docgen” API documentation

options	object.<string, *> Inherited fromFindObjectConfig
Required
Description	Any additional options that should be added to options passed down to a handler.

parameters	object.<string, carbond.OperationParameter>
Required
Description	The “projection” parameter definition

responses	Object.<string, carbond.OperationResponse> Inherited fromFindObjectConfig
Required
Description	Add custom responses for an operation. Note, this will override all default responses.