carbond.collections.FindConfig

extends CollectionOperationConfig

The find operation config

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
(read-only)
Description The parent endpoint/collection that this configuration is a member of
example
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.
maxPageSize
number
Required
Description If set, then the “limit” parameter will be restricted to min(limit, maxPageSize)
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.
pageSize
boolean
Required
Description The page size
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>
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)
supportsSkipAndLimit
boolean
Required
Description Support skip and limit

Methods