carbond.collections.UpdateConfig

extends CollectionOperationConfig

The update operation config

Instance Properties

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

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

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

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

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

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

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

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

returnsUpsertedObjects	boolean
Default	false
Description	Whether or not the HTTP layer returns objects created via an upsert

schema	Object
Default	undefined
Description	The schema used to validate the request body. No validation will be performed if this is left undefined.

supportsUpsert	boolean
Default	false
Description	Whether of not the client is allowed to create objects in the collection using the PATCH method