From 9d4f287c6d39c53aaa9d4739ba9e3a980d85a3b6 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 26 Jun 2026 11:36:05 +0000 Subject: [PATCH] docs: add missing error examples and .gitignore MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Claude-Session: https://claude.ai/code/session_01RFwjFQy3pjgWk8S9jmtwvs --- .gitignore | 20 ++++++++++++++++++++ asm/openapi.yaml | 8 ++++++++ 2 files changed, 28 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0fdc80a --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +# Environment files — never commit API keys or secrets +.env +.env.* +!.env.example + +# Editor and OS artifacts +.DS_Store +Thumbs.db +.vscode/ +.idea/ +*.swp +*.swo +*~ + +# Node (if tooling is added later) +node_modules/ +npm-debug.log* + +# Build output from deploy-docs.yml (local runs) +_site/ diff --git a/asm/openapi.yaml b/asm/openapi.yaml index af46c80..17214f9 100644 --- a/asm/openapi.yaml +++ b/asm/openapi.yaml @@ -456,6 +456,10 @@ components: application/json: schema: $ref: '#/components/schemas/Error' + example: + error: + code: bad_request + message: "targets must contain at least one entry" RateLimited: description: Rate limit exceeded headers: @@ -467,6 +471,10 @@ components: application/json: schema: $ref: '#/components/schemas/Error' + example: + error: + code: rate_limited + message: "Rate limit exceeded. Retry after 42 seconds." schemas: # ── Enums ──────────────────────────────────────────────────────────────────