docs(platform): low-level b3 API reference#139
Merged
Conversation
![kodiak-appscode[bot]](https://avatars.githubusercontent.com/in/92481?s=60&v=4){kind=small}
Add a new "API Reference" section under docs/platform/api/ documenting the ACE platform backend (b3) REST API at the endpoint level: HTTP method, path, authentication, path/query parameters, and request/response schemas for every operation, so a client can be implemented directly against it. - 18 API groups (hld grouping) as folders, with per-subgroup pages and an index; 483 endpoints across 55 markdown files. - GET endpoints were verified against a live deployment; each carries an inline verification note (status + reason for non-200s such as availability gating). - Examples are sanitized (no secrets, hosts, emails, or tokens). Signed-off-by: Tamal Saha <tamal@appscode.com>
tamalsaha
force-pushed
the
docs/b3-api-reference
branch
from
July 13, 2026 20:24
e4c5595 to
a3553de
Compare
Hugo's front-matter YAML parser rejected 'name: Identity: Users & Settings' (mapping values are not allowed in this context). Quote the two affected group names so the site builds. Signed-off-by: Tamal Saha <tamal@appscode.com>
|
Visit the preview URL for this PR (updated for commit 543ad1b): https://kubedb-v2-hugo--pr139-docs-b3-api-referenc-knmkd0c4.web.app (expires Mon, 20 Jul 2026 20:47:31 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
…viewer - Fix intra-group and cross-section relative links to satisfy the repo's extra-"../" convention (verified with the CI liche fork + -s): same-directory siblings use ../<file>, cross-group/section links get one additional ../. - Add docs/platform/api/openapi.yaml — the machine-readable OpenAPI 3.0.3 spec, served verbatim as a page resource and linked from the API reference index. - Add api.html at the repo root — a self-contained Swagger UI viewer with the spec inlined (kept out of docs/ so the link checker does not scan its inlined URLs and Hugo does not wrap it in the site theme). Signed-off-by: Tamal Saha <tamal@appscode.com>
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
1 participant
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.
What
Adds a new API Reference section under
docs/platform/api/— low-level, endpoint-by-endpoint documentation of the ACE platform backend (b3) REST API, detailed enough to implement a client directly._index.mdand per-subgroup pages — 55 markdown files, 483 documented endpoints.section_menu_id: api, weight 40).Live verification
GET endpoints were verified against a live deployment (hub + monitoring/dbaas spokes). Each carries an inline
> **Verified:**note with the status code and, for non-200s, the reason (e.g. AppsCode-hosted-only or non-billing routes returning 404 = availability gating; missing preconditions returning 500). Only GET requests were issued — no mutating verbs.Approx outcomes: ~128 × 2xx, 75 × 404 (feature/deployment gating), 22 × 500 (missing precondition), plus a handful of 302/400/403 — all annotated.
Safety
No secrets, tokens, hosts, emails, or names are committed — the tree passed a PII/secret scan.
Notes for reviewers
../convention; I have not runlicheyet — happy to if preferred./chartsreturns name strings; the user billing dashboard lives at/api/v1/dashboard/clusters/*).