docs(asm): document X-RateLimit-Limit/Remaining response headers on all endpoints#23
Open
dmchaledev wants to merge 1 commit into
Open
docs(asm): document X-RateLimit-Limit/Remaining response headers on all endpoints#23dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
…nse headers The info description promised these headers on every response but no endpoint declared them, so SDK generators and Redoc rendered no trace of them. Adds reusable header components and wires them into all 2xx responses across every endpoint. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D8aK5iFD2dh7B5Z4vtf5m5
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
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.
Problem
The
info.descriptioninasm/openapi.yamlexplicitly tells API consumers:But no endpoint actually declared these headers in its response objects. That means:
Fix
components/headerssection with reusableX-RateLimit-LimitandX-RateLimit-Remainingheader definitions (type, description, example value)Changes
asm/openapi.yaml— +72 lines, no breaking changesTest plan
spectral lint asm/openapi.yaml --ruleset spectral:oaspasses (CI will verify)🤖 Generated with Claude Code
https://claude.ai/code/session_01D8aK5iFD2dh7B5Z4vtf5m5
Generated by Claude Code