REST Reference Pilot implemented
This is the first portal-native rendered REST reference route. It is deliberately simple: it proves the portal can expose a browsable API reference path backed by the synced OpenAPI artifact without adopting a full renderer before the playground decision is complete.
Contract Source
| Artifact | Purpose | Link |
|---|---|---|
| OpenAPI draft | Canonical REST contract copied during docs-portal-check | OpenAPI YAML |
| Scalar-compatible copy | Generated renderer compatibility copy from the same source | Scalar OpenAPI YAML |
Domain Families
The full contract includes these high-value API families:
| Family | Reader intent |
|---|---|
| Health and auth | Check service health and learn access flows |
| Users, tenants, projects, memberships | Understand account, tenancy, and project scope |
| Catalog, SKUs, nodes, allocations | Browse capacity and manage GPU allocation lifecycle |
| Terminal and storage | Access provisioned nodes and manage data paths |
| Billing, payments, ledger, refunds | Understand money-domain read/write boundaries |
| Admin and platform routes | Operate users, nodes, evidence, IAM, lifecycle, and readiness |
| App platform routes | Build, register, promote, and operate GPUaaS apps |
Renderer Status
Next Step
The next implementation slice should add a full renderer behind this route once the team selects Stoplight, Scalar, Docusaurus OpenAPI Docs, or another option. Live calls remain out of scope until the API Playground controls are implemented.