OpenAPI Security Schemes API Keys Name Error (Edit)

Having components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a name of api_key set.

OpenAPISecurityDefault

Rule Definition

openapi-security-schemes-api-key-name-error.yaml
{"openapi-security-schemes-api-key-name-error":{"description":"Having components security schemes which possesses an api-key property that allows to configure how API keys are applied to operations have a name of api_key set.","message":"Components MUST Have a Security Schemes API Keys Name","severity":"error","given":"$.components.securitySchemes.apiKeys","then":[{"field":"name","function":"pattern","functionOptions":{"match":"\\b(api-key)\\b"}}]}}

Back to All of the Rules