OpenAPI Request Bodies Examples Content (Edit)

Request body content should include examples to support API mocking, testing, and documentation. Examples enable tools to generate realistic mock requests and help consumers understand expected payloads.

OpenAPIRequest BodiesExamplesMocking

Rule Definition

openapi-request-bodies-examples-content-warn.yaml 
{"openapi-request-bodies-examples-content-warn":{"description":"Request body content should include examples to support API mocking, testing, and documentation. Examples enable tools to generate realistic mock requests and help consumers understand expected payloads.","message":"Request body content SHOULD include examples.","given":"$.paths[*][*].requestBody.content.*","severity":"warn","then":{"function":"xor","functionOptions":{"properties":["example","examples"]}}}}

Back to All of the Rules