OpenAPI Request Bodies Description Info (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-info.yaml
{"openapi-request-bodies-description-info":{"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 Have a Description","severity":"info","given":"$.paths.*.requestBody","then":{"field":"description","function":"falsy"}}}

Back to All of the Rules