carbond.collections.FindConfig¶

The find operation config

Instance Properties¶

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

description	`string` Inherited from`CollectionOperationConfig`
Default	undefined
Description	A brief description of the operation used by the documentation generator

endpoint	`Endpoint` Inherited from`CollectionOperationConfig` (read-only)
Description	The parent endpoint/collection that this configuration is a member of

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

idParameterName	`string` Inherited from`CollectionOperationConfig` (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`
Required
Description	If set, then the “limit” parameter will be restricted to min(limit, maxPageSize)

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

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

parameters	`object.<string, carbond.OperationParameter>`
Required
Description	The id query parameter (will use `idParameterName` as name) (will be omitted if `supportsIdQuery` is `false`)

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

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

supportsPagination	`boolean`
Required
Description	Support pagination (note, if true, overrides `supportsPagination`)