Skip to content

Commit 543ad1b

Browse files
committed
docs(platform): fix api reference internal links; add OpenAPI spec + 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>
1 parent 568dd1d commit 543ad1b

31 files changed

Lines changed: 23180 additions & 69 deletions

File tree

api.html

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

docs/platform/api/_index.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -32,27 +32,31 @@ endpoints accept HTTP Basic auth. The web console uses a session cookie
3232
(`i_like_ace`); a session cookie alone does **not** authenticate the token-guarded
3333
REST endpoints — use a token.
3434

35-
A machine-readable OpenAPI 3.0.3 description of this API is also available.
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.
3640

3741
## API groups
3842

3943
| Group | What it covers |
4044
|---|---|
41-
| [Identity: Users & Settings](users-settings/) | Accounts, profile/security settings, tokens, credentials |
42-
| [Identity: Organizations & Teams](organizations-teams/) | Orgs, members, teams, org tokens |
43-
| [Administration](administration/) | Admin console, site settings |
44-
| [Authorization](authorization/) | Custom roles & permissions |
45-
| [Cluster Management v1](cluster-management-v1/) | Cluster lifecycle, Kubernetes proxy, Helm |
46-
| [Cluster Management v2](cluster-management-v2/) | Hub-aware cluster API, subscriptions, gateways |
47-
| [Multi-cluster (OCM)](multicluster-ocm/) | Hub/spoke, cluster sets, feature sets |
48-
| [Client Organizations](client-organizations/) | Managed-service client orgs |
49-
| [Cloud Providers](cloud-providers/) | Provider discovery for provisioning |
50-
| [ACE Installer](ace-installer/) | Self-host installer bundles |
51-
| [ACE Upgrade](ace-upgrade/) | Platform & cluster upgrades |
52-
| [Licensing & Contracts](licensing-contracts/) | Contracts, licenses, registration |
53-
| [Billing Dashboard](billing-dashboard/) | Usage reports & billing dashboards |
54-
| [Marketplace](marketplace/) | Cloud-marketplace webhooks & metering |
55-
| [Monitoring & Telemetry](monitoring-telemetry/) | Telemetry stack, Trickster auth proxy |
56-
| [Rancher Integration](rancher/) | Rancher sync & proxy |
57-
| [Chart Repositories](chart-repositories/) | Public Helm chart repositories |
58-
| [Miscellaneous](miscellaneous/) | Version, markdown, health |
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 |

docs/platform/api/ace-installer/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ and supports reconfigure/upgrade/versioning and marketplace-installer status.
2727
2828
## Pages
2929

30-
- [ACE Installer](../ace-installer/ace-installer.md) — schema/model, generate/import,
30+
- [ACE Installer](../ace-installer.md) — schema/model, generate/import,
3131
installer metadata and latest version, installers CRUD, reconfigure/upgrade,
3232
versions/archives, and marketplace installer status.

docs/platform/api/ace-upgrade/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ across two pages:
3535

3636
## Pages
3737

38-
- [Platform Upgrade](../ace-upgrade/platform-upgrade.md) — the
38+
- [Platform Upgrade](../platform-upgrade.md) — the
3939
`/api/v1/upgrade*` endpoints: platform upgrade status, job status, history, and
4040
current version, plus triggering a platform upgrade. Requires site-admin org
4141
authorization.
42-
- [Cluster Upgrade](../ace-upgrade/cluster-upgrade.md) — the
42+
- [Cluster Upgrade](../cluster-upgrade.md) — the
4343
`/api/v1/clusters/{owner}/{cluster}/upgrade*` and `.../spoke/upgrade*`
4444
endpoints: imported-cluster and spoke-cluster upgrade status, history, current
4545
and latest versions, plus triggering cluster/spoke upgrades. Gated by cluster

docs/platform/api/administration/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ required.
3131

3232
## Pages
3333

34-
- [Administrative-Org Admin](../administration/admin-org.md)`/api/v1/admin/*`: manage users and their organizations.
35-
- [Site Admin Console](../administration/site-admin-console.md)`/api/v1/accounts/admin/*`: dashboard, users, orgs, clusters, auth sources.
36-
- [Site Settings](../administration/site-settings.md)`/allowed-domains`, `/disable-registration`, `/branding`.
34+
- [Administrative-Org Admin](../admin-org.md)`/api/v1/admin/*`: manage users and their organizations.
35+
- [Site Admin Console](../site-admin-console.md)`/api/v1/accounts/admin/*`: dashboard, users, orgs, clusters, auth sources.
36+
- [Site Settings](../site-settings.md)`/allowed-domains`, `/disable-registration`, `/branding`.

docs/platform/api/authorization/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ and membership of that organization are required.
2626

2727
## Pages
2828

29-
- [Roles & Permissions](../authorization/roles-permissions.md) — object
29+
- [Roles & Permissions](../roles-permissions.md) — object
3030
allowed-permissions lookups (single and batch), the available-permissions
3131
catalog, role CRUD, and role principal listings.

docs/platform/api/billing-dashboard/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ Routes in this group fall into three authorization tiers:
4646

4747
## Pages
4848

49-
- [Admin Billing Dashboard](../billing-dashboard/admin-dashboard.md) — the
49+
- [Admin Billing Dashboard](../admin-dashboard.md) — the
5050
site-admin `/api/v1/dashboard/*` routes: licensed users, their clusters,
5151
per-cluster licenses and licensed products, resource/event histories, marketplace
5252
subscriptions, and system-outage records.
53-
- [User Billing Dashboard](../billing-dashboard/user-dashboard.md) — the
53+
- [User Billing Dashboard](../user-dashboard.md) — the
5454
owner-scoped `/api/v1/dashboard/clusters/*` routes (`view:contracts`): an
5555
organization's own active clusters, licenses, licensed products, and event counts.
56-
- [Usage Reports](../billing-dashboard/usage-reports.md) — the
56+
- [Usage Reports](../usage-reports.md) — the
5757
`/api/v1/dashboard/summary/*` monthly usage-report views and PDF download, plus
5858
the `/api/v1/dbaas/billing/*` namespace billing reports.

docs/platform/api/billing-dashboard/user-dashboard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Returns cluster information for a cluster owned by the request owner.
8383
| `cid` | string | Cluster UID. |
8484

8585
- **Response:** `200 OK` — a single `ClusterInfo` object (the same shape documented
86-
on the [Admin Billing Dashboard](../billing-dashboard/admin-dashboard.md) page;
86+
on the [Admin Billing Dashboard](../admin-dashboard.md) page;
8787
`status` is a free-form Kubernetes-style object). `404` if the cluster is unknown
8888
or not owned by the org.
8989

docs/platform/api/chart-repositories/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ role is required. Only `GET` requests are exposed here.
2525

2626
## Pages
2727

28-
- [Chart Repositories](../chart-repositories/chart-repositories.md) — list the
28+
- [Chart Repositories](../chart-repositories.md) — list the
2929
known chart repositories, list the charts inside a repository, and list the
3030
versions of a named chart.

docs/platform/api/client-organizations/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ user access on behalf of each client.
1919

2020
There are two concerns, split across two pages:
2121

22-
- [Client Org Management](../client-organizations/management.md) — site-admin
22+
- [Client Org Management](../management.md) — site-admin
2323
lifecycle of client organizations: list/get/create/delete client orgs, add or
2424
remove clusters, and query client-org status. Routes live under
2525
`/api/v1/user/client*`.
26-
- [Cluster User Permissions](../client-organizations/cluster-user-permissions.md)
26+
- [Cluster User Permissions](../cluster-user-permissions.md)
2727
— organization-admin management of the OCM users belonging to a client org on
2828
a specific cluster: list users, create a user with permissions, inspect and
2929
update permissions, generate a kubeconfig, and remove a user. Routes live

0 commit comments

Comments
 (0)