Skip to content

Add OpenAPI endpoint reference docs#17

Open
anth-volk wants to merge 1 commit into
mainfrom
codex/openapi-reference-section
Open

Add OpenAPI endpoint reference docs#17
anth-volk wants to merge 1 commit into
mainfrom
codex/openapi-reference-section

Conversation

@anth-volk

@anth-volk anth-volk commented May 19, 2026

Copy link
Copy Markdown
Contributor

Fixes #18

Summary

  • Add an API endpoint reference section to the country API docs pages.
  • Add a selectable request sample panel mirroring the response sample component, with focused JSON snippets and explanatory notes for each allowed key.
  • Document version as limited to current, frontier, or an exact numerical version string such as 1.691.1.
  • Add a Spotify-style selectable Response sample panel for 200, 200 with deprecated-variable warning, 400 validation failures, 401, 403, 404, and 500 responses.
  • Make request and response sample code blocks scroll horizontally instead of widening the page layout.
  • Make the endpoint reference section use the same max-w-4xl gutter as the rest of the API guide.
  • Make the docs app self-contained in local dev by clearing the zone asset prefix, while keeping /_zones/household-api-docs for production builds.

This keeps the production multi-zone asset shape, but avoids requiring app-v2 as the parent just to review local docs styling.

AI Explainer Note

This documentation exposes enable_ai_explainer and the AI explainer flow. No customer uses that endpoint today, and it is not fully implemented, so reviewers should explicitly decide whether exposing it in customer-facing docs is acceptable.

Validation

  • bun install
  • bun run build
  • Verified the running local /us/api/ page includes the request sample selector, response sample selector, updated version allowed-value copy, and no Request keys or Response options sections.
  • Verified local public chart assets serve at /python-guide/....
  • Confirmed production app-v2 already proxies /_zones/household-api-docs/... assets for the deployed multi-zone route.

@vercel

vercel Bot commented May 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
household-api-docs Ready Ready Preview, Comment May 19, 2026 7:09pm

Request Review

@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 448c639 to 40160ec Compare May 19, 2026 15:22
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 40160ec to 5581464 Compare May 19, 2026 16:20
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 5581464 to c9b00e7 Compare May 19, 2026 16:54
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from c9b00e7 to 0804356 Compare May 19, 2026 17:01
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 0804356 to 2314afd Compare May 19, 2026 17:41
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 2314afd to 880aee7 Compare May 19, 2026 17:45
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 880aee7 to 66df75b Compare May 19, 2026 17:53
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from 66df75b to cb89846 Compare May 19, 2026 18:12
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from cb89846 to ce9c940 Compare May 19, 2026 18:22
@anth-volk anth-volk force-pushed the codex/openapi-reference-section branch from ce9c940 to 8bf6224 Compare May 19, 2026 18:50
@anth-volk

Copy link
Copy Markdown
Contributor Author
Screenshot 2026-05-19 at 9 13 25 PM Screenshot 2026-05-19 at 9 13 35 PM

@anth-volk anth-volk marked this pull request as ready for review May 19, 2026 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document household API calculate request and response examples

1 participant