OpenAPI Components Parameters Description Error (Edit)

Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle

OpenAPIComponentsParametersMetadataDefault

Rule Definition

openapi-components-parameters-description-error.yaml
{"openapi-components-parameters-description-error":{"description":"Having a parameters description provides more depth to what a parameter does and will be displayed via documentation, and other tooling used across the API lifecycle","message":"Parameters MUST Have a Description","given":"$.paths.*.*.parameters.*","then":{"field":"description","function":"truthy"}}}

Back to All of the Rules