Add OpenAPI endpoint reference docs#17
Open
anth-volk wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
448c639 to
40160ec
Compare
40160ec to
5581464
Compare
5581464 to
c9b00e7
Compare
c9b00e7 to
0804356
Compare
0804356 to
2314afd
Compare
2314afd to
880aee7
Compare
880aee7 to
66df75b
Compare
66df75b to
cb89846
Compare
cb89846 to
ce9c940
Compare
ce9c940 to
8bf6224
Compare
8bf6224 to
a54d67f
Compare
Contributor
Author
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.


Fixes #18
Summary
versionas limited tocurrent,frontier, or an exact numerical version string such as1.691.1.Response samplepanel for 200, 200 with deprecated-variable warning, 400 validation failures, 401, 403, 404, and 500 responses.max-w-4xlgutter as the rest of the API guide./_zones/household-api-docsfor 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_explainerand 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 installbun run build/us/api/page includes the request sample selector, response sample selector, updatedversionallowed-value copy, and noRequest keysorResponse optionssections./python-guide/..../_zones/household-api-docs/...assets for the deployed multi-zone route.