OpenAPI Parameters Required Examples (Edit)

Required parameters should include examples to support API mocking, testing, and documentation. Examples help consumers understand expected values and enable tools like Microcks to generate realistic mock responses.

OpenAPIParametersExamplesMocking

Rule Definition

openapi-parameters-required-examples-warn.yaml 
{"openapi-parameters-required-examples-warn":{"description":"Required parameters should include examples to support API mocking, testing, and documentation. Examples help consumers understand expected values and enable tools like Microcks to generate realistic mock responses.","message":"Required parameters SHOULD include examples.","given":"$.paths[*][*].parameters[?(@.required==true)]","severity":"warn","then":{"function":"xor","functionOptions":{"properties":["example","examples"]}}}}

Back to All of the Rules