OpenAPI Response RateLimit Headers (Edit)

API responses must include the standard rate limit header trio (ratelimit-limit, ratelimit-remaining, ratelimit-reset) to inform consumers of their current usage against rate limits.

OpenAPIResponsesRate LimitingHeaders

Rule Definition

openapi-response-ratelimit-headers-error.yaml
{"openapi-response-ratelimit-headers-error":{"description":"API responses must include the standard rate limit header trio (ratelimit-limit, ratelimit-remaining, ratelimit-reset) to inform consumers of their current usage against rate limits.","message":"Responses MUST include ratelimit-limit, ratelimit-remaining, and ratelimit-reset headers.","given":"$..responses[?(@property.match(/^2/))].headers","severity":"error","then":[{"field":"ratelimit-limit","function":"truthy"},{"field":"ratelimit-remaining","function":"truthy"},{"field":"ratelimit-reset","function":"truthy"}]}}

Back to All of the Rules