OpenAPI specification

Goal

Obtain the machine-readable OpenAPI 3 document for Public API v1.

Who it is for

Integrators generating clients and contract tests.

Preconditions

• Help Center is reachable (or you have the YAML from the repo).

Steps

1. Download the YAML: public-api-v1-openapi.yaml.
2. Import it into Insomnia, Postman, openapi-generator, or your CI contract suite.
3. Align human notes with Public API v1 and the narrative reference.

Result

Client stubs and tests match the shipped read-only contract.

Note

The YAML published in Help is kept in docs/help/public/. When the API contract changes, update the Help copy in the same change set as the backend routes.

Related

• Public API v1
• Narrative reference