@@ -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
3333REST 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 |
0 commit comments