OpenAPI Components Parameters Example Error (Edit)

Parameters must always possess a example to help define the format and shape of the parameter, setting expections with consumers about what should be passed in

OpenAPIComponentsParametersExample

Rule Definition

openapi-components-parameters-example-error.yaml 
{"openapi-components-parameters-example-error":{"description":"Parameters must always possess a example to help define the format and shape of the parameter, setting expections with consumers about what should be passed in","message":"Parameters MUST Have Example","given":"$.components.parameters.*","then":{"field":"example","function":"truthy"}}}

Back to All of the Rules