Skip to content

Commit 5c3892b

Browse files
tamalsahatamalsaha
authored
docs(platform): add API Reference landing page (fix /api/ 404) (#140)
Signed-off-by: Tamal Saha <tamal@appscode.com>
1 parent 3d540cd commit 5c3892b

2 files changed

Lines changed: 66 additions & 52 deletions

File tree

‎docs/platform/api/README.md‎

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

‎docs/platform/api/_index.md‎

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,3 @@ menu:
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: api
1010
---
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 |

0 commit comments

Comments
 (0)