carbond.mongodb.MongoDBFindConfig¶

The MongoDB find operation config

Instance Properties¶

allowUnauthenticated	`boolean` Inherited from`FindConfig`
Default	false
Description	Allow unauthenticated requests to the operation

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

example	`object` Inherited from`FindConfig`
Default	undefined
Description	An example response body used for documentation

idParameterName	`string` Inherited from`FindConfig` (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.

maxPageSize	`number` Inherited from`FindConfig`
Required
Description	If set, then the “limit” parameter will be restricted to min(limit, maxPageSize)

noDocument	`boolean` Inherited from`FindConfig`
Default	false
Description	Exclude the operation from “docgen” API documentation

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

pageSize	`boolean` Inherited from`FindConfig`
Required
Description	The page size

parameters	`object.<string, carbond.OperationParameter>`
Required
Description	The “query” parameter definition (will be omitted if `supportsQuery` is `false`)

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

supportsIdQuery	`boolean` Inherited from`FindConfig`
Required
Description	Support id queries (id query parameter)

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.