Rename rate-limit headers to X-RateLimit-* (closes #265) - #271
Merged
getorymckeag merged 1 commit intoSep 23, 2026
Merged
Conversation
The spec and the narrative articles used X-Rate-Limit-{Limit,Remaining,Reset}.
The de-facto convention that predates the IETF RateLimit header fields draft
(and which the issue asks for) is X-RateLimit-*, so rename the header
components, the shared 304/429 header blocks and every example response.
The released docs/openapi-1.0.yaml is left untouched; it is regenerated from
docs/_spec/openapi-split.yaml by the documentation workflow.
getorymckeag
approved these changes
Sep 23, 2026
getorymckeag
left a comment
getorymckeag
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the contribution! I was supposed to get to this.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Title: Rename rate-limit headers to
X-RateLimit-*(closes #265)What
Renames
X-Rate-Limit-Limit/X-Rate-Limit-Remaining/X-Rate-Limit-ResettoX-RateLimit-Limit/X-RateLimit-Remaining/X-RateLimit-Reseteverywhere in thedev spec and the docs:
docs/_spec/openapi-split.yaml— the threecomponents.headersentries and the shared&rate-limited-headersblock that the 304 and 429 responses reusedocs/articles/conditional-GET.md,docs/articles/how-units-are-handled.md,docs/example-narratives/submitting-forecasts.md— example responsesWhy
#265: the
X-Rate-Limit-*spelling doesn't match the widely-usedX-RateLimit-*convention that preceded the IETF
RateLimitheader draft. This PR follows the spellingthe issue asks for. If the working group would rather jump straight to the un-prefixed
IETF
RateLimit-*fields, I'm happy to redo it that way — it's the same set of files.Not changed
docs/openapi-1.0.yamlis the published 1.0 bundle; the documentation workflow regeneratesit from
openapi-split.yaml, so I didn't hand-edit it.trolie/java-client-sdkdoesn't read these headers, so no client change is needed.Testing
redocly lint trolie@dev(same CLI version as the lint workflow, 1.8.2) reports the same22 pre-existing findings before and after this change; none reference the renamed headers.