Skip to main content

rate-limit-headers

Requires concrete 2xx and 4xx responses to declare a recognized rate-limit header set.

AttributeValue
CategoryOperations
MaturityPlatinum
OpenAPISwagger 2.0; OpenAPI 3.0, 3.1, 3.2
StarterOff
LenientWarning
Recommended–CompleteError

Intent

Rate-limit metadata helps clients pace requests and recover before limits become repeated failures.

Flags

Every numeric status from 200–299 or 400–499 that contains none of these case-insensitive header sets:

  • X-RateLimit-Limit;
  • X-Rate-Limit-Limit;
  • both RateLimit-Limit and RateLimit-Reset; or
  • RateLimit.

Referenced responses are resolved.

Does not flag

Other status classes, nonnumeric range or default responses, or a response containing any complete accepted set.

See it fail

responses:
'200':
description: OK

Diagnostic: 2xx and 4xx responses should define rate limiting headers.

Fix it

Choose one supported convention:

responses:
'200':
description: OK
headers:
RateLimit:
schema:
type: string

Configure

profiles:
default:
rules:
extends: [recommended]
override:
rate-limit-headers: warn

Nearby: define-429-response, retry-after-for-429.