Skip to content

Commit 3d540cd

Browse files
authored
docs(platform): low-level b3 API reference (#139)
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>
1 parent 29f56bf commit 3d540cd

57 files changed

Lines changed: 37130 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

api.html

Lines changed: 41 additions & 0 deletions
Large diffs are not rendered by default.

docs/platform/api/_index.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: api
6+
name: API Reference
7+
weight: 40
8+
menu_name: docsplatform_{{.version}}
9+
section_menu_id: api
10+
---
11+
12+
# ACE Platform API Reference
13+
14+
Low-level reference for the AppsCode Cloud Engine (ACE) platform backend (`b3`)
15+
REST API. Every endpoint lists its HTTP method, path, authentication, path/query
16+
parameters, and request/response shapes so you can implement a client directly
17+
against it.
18+
19+
All routes are served under the `/api/v1` prefix unless noted otherwise. The
20+
marketplace webhook service is a separate listener rooted at `/marketplace/api/v1`.
21+
22+
## Authentication
23+
24+
Most endpoints require a personal access token. Send it as an HTTP header:
25+
26+
```
27+
Authorization: token <YOUR_TOKEN>
28+
```
29+
30+
You can also pass it as a `token` or `access_token` query parameter. Token-management
31+
endpoints accept HTTP Basic auth. The web console uses a session cookie
32+
(`i_like_ace`); a session cookie alone does **not** authenticate the token-guarded
33+
REST endpoints — use a token.
34+
35+
A machine-readable [OpenAPI 3.0.3 specification](../openapi.yaml) of this API is also
36+
available (`openapi.yaml`) — load it into any OpenAPI tool (Swagger UI, Redoc,
37+
`openapi-generator`) to explore the API or generate a client. A self-contained
38+
Swagger UI viewer (`api.html`, with the spec inlined) is available at the repository
39+
root.
40+
41+
## API groups
42+
43+
| Group | What it covers |
44+
|---|---|
45+
| [Identity: Users & Settings](../users-settings/) | Accounts, profile/security settings, tokens, credentials |
46+
| [Identity: Organizations & Teams](../organizations-teams/) | Orgs, members, teams, org tokens |
47+
| [Administration](../administration/) | Admin console, site settings |
48+
| [Authorization](../authorization/) | Custom roles & permissions |
49+
| [Cluster Management v1](../cluster-management-v1/) | Cluster lifecycle, Kubernetes proxy, Helm |
50+
| [Cluster Management v2](../cluster-management-v2/) | Hub-aware cluster API, subscriptions, gateways |
51+
| [Multi-cluster (OCM)](../multicluster-ocm/) | Hub/spoke, cluster sets, feature sets |
52+
| [Client Organizations](../client-organizations/) | Managed-service client orgs |
53+
| [Cloud Providers](../cloud-providers/) | Provider discovery for provisioning |
54+
| [ACE Installer](../ace-installer/) | Self-host installer bundles |
55+
| [ACE Upgrade](../ace-upgrade/) | Platform & cluster upgrades |
56+
| [Licensing & Contracts](../licensing-contracts/) | Contracts, licenses, registration |
57+
| [Billing Dashboard](../billing-dashboard/) | Usage reports & billing dashboards |
58+
| [Marketplace](../marketplace/) | Cloud-marketplace webhooks & metering |
59+
| [Monitoring & Telemetry](../monitoring-telemetry/) | Telemetry stack, Trickster auth proxy |
60+
| [Rancher Integration](../rancher/) | Rancher sync & proxy |
61+
| [Chart Repositories](../chart-repositories/) | Public Helm chart repositories |
62+
| [Miscellaneous](../miscellaneous/) | Version, markdown, health |
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: api-ace-installer
6+
name: ACE Installer
7+
parent: api
8+
weight: 100
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: api
11+
---
12+
13+
# ACE Installer API
14+
15+
The ACE Installer API generates and manages self-host installer bundles for the
16+
AppsCode Container Engine (ACE) platform. It serves the installer options schema,
17+
generates and imports installer bundles, lists and inspects generated installers,
18+
and supports reconfigure/upgrade/versioning and marketplace-installer status.
19+
20+
> **AppsCode-hosted only.** Every route under `/api/v1/ace-installer/...` is available
21+
> only on the AppsCode-hosted (SaaS) deployment. On self-hosted ACE installations these
22+
> routes are not registered and return `404 Not Found`. All calls require a bearer token,
23+
> an org context (resolved from the `org` query param), and per-action authorization
24+
> checks (`view_installers`, `create_installers`, `import_installers`,
25+
> `reconfigure_installers`, `upgrade_installers`, `download_installers`,
26+
> `delete_installers`).
27+
28+
## Pages
29+
30+
- [ACE Installer](../ace-installer.md) — schema/model, generate/import,
31+
installer metadata and latest version, installers CRUD, reconfigure/upgrade,
32+
versions/archives, and marketplace installer status.

0 commit comments

Comments
 (0)