OpenAPI Components Parameters Name Length Error (Edit)

Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests

OpenAPIComponentsParametersMetadataDefault

Rule Definition

openapi-components-parameters-name-length-error.yaml 
{"openapi-components-parameters-name-length-error":{"description":"Providing short and concise names for your parameters helps make it easier for API consumers to understand how they are able to configure their API requests","message":"Parameters Name Length MUST Be Less Than 25 Characters","given":"$.components.parameters[?(@.in=='path')].name","then":{"field":"summary","function":"length","functionOptions":{"max":25}}}}

Back to All of the Rules