OpenAPI Request Bodies Description Error (Edit)

It is helpful to provide a description for request bodies, providing a simple explanation of what can be configured as part of the request payload

OpenAPIRequest BodiesMetadata

Rule Definition

openapi-request-bodies-description-error.yaml
{"openapi-request-bodies-description-error":{"description":"It is helpful to provide a description for request bodies, providing a simple explanation of what can be configured as part of the request payload","message":"Request Bodies MUST Have a Description","severity":"error","given":"$.paths.*.requestBody","then":{"field":"description","function":"truthy"}}}

Back to All of the Rules