docs: add missing error examples in ASM spec and .gitignore#28
Open
dmchaledev wants to merge 1 commit into
Open
docs: add missing error examples in ASM spec and .gitignore#28dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
Add example bodies for the BadRequest and RateLimited shared response components in the ASM OpenAPI spec — Unauthorized and NotFound already had examples, so this fills the gap and makes all four error cases render correctly in the Redoc interactive docs. Add .gitignore to prevent accidental commits of .env credential files, editor configs, OS artifacts, and local _site/ build output. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RFwjFQy3pjgWk8S9jmtwvs
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.
Summary
BadRequestandRateLimitedshared response components were missingexample:bodies.UnauthorizedandNotFoundalready had examples, so this gap caused those two error cases to render as blank in the Redoc interactive docs — unhelpful for developers trying to understand what a 400 or 429 response looks like..gitignore: The repo had no.gitignore. Added entries for.env*credential files, common editor/OS artifacts (.DS_Store,.idea/,.vscode/), and the_site/build output from the deploy workflow. Prevents accidental commit of API keys or tokens during local testing.Changes
asm/openapi.yamlexample:blocks toBadRequestandRateLimitedshared responses.gitignore.env*, editor configs, OS files,_site/Test plan
400 Bad Requestand429 Rate Limitedwith example bodies in the interactive docs🤖 Generated with Claude Code
https://claude.ai/code/session_01RFwjFQy3pjgWk8S9jmtwvs
Generated by Claude Code