carbond.collections.CollectionOperationConfig

The base class for all collection configs

Instance Properties

allowUnauthenticated	boolean
Default	false
Description	Allow unauthenticated requests to the operation

description	string
Default	undefined
Description	A brief description of the operation used by the documentation generator

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

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

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

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

parameters	object.<string, carbond.OperationParameter>
Required
Description	Operation specific parameters (e.g., “skip”, “limit”). These will be passed down to the operation handlers via the options parameter if they are not explicitly passed via another leading parameter (e.g., “id” and “update” for updateObject).

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