REST API contracted
The REST API source of truth is doc/api/openapi.draft.yaml. The portal should
render generated reference docs from that contract rather than hand-writing
endpoint shapes.
Current Implementation
- Link the canonical OpenAPI artifact copied by
docs-portal-check. - Expose a REST reference pilot that groups API families by reader intent.
- Keep domain authoring fragments internal to the repo workflow until bundling and generated output are stable.
- Defer a full OpenAPI renderer until the reference-rendering and playground decisions are complete.
Synced Artifact
The portal check copies the committed OpenAPI contract into the static portal bundle:
API Consumer Path
- Start with Auth And Access before wiring a controller or CI integration.
- Use Idempotency And Retries for mutation retry behavior.
- Use Contract Artifacts for synced YAML artifact links and generated-reference roadmap.
- Use REST Reference Pilot to orient by API family without treating the portal page as a copied endpoint catalog.