Skip to main content

parameter-description

Requires every parameter object to have a present, non-blank string description.

AttributeValue
CategoryParameters
MaturitySilver
Starter–RecommendedOff
StrictWarning
CompleteError

See it fail

- in: query
name: status
schema: { type: string }

Fix it

- in: query
name: status
description: Return payments with this status.
schema: { type: string }

Referenced component parameters are checked at their definitions.

Nearby: boolean-parameter-prefixes, parameter-length-required.