OpenAPI Components Parameters Description Info (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-info.yaml
{"openapi-components-parameters-description-info":{"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 Have a Description","severity":"info","given":"$.components.parameters.*","then":{"field":"description","function":"falsy"}}}

Back to All of the Rules