Environments
The API is documented once per environment. Both specs come from the same ts-rest contract, so paths, schemas, and responses match; they differ only in the values below.
| Test | Production | |
|---|---|---|
| Spec file | openapi/test.json |
openapi/prod.json |
| Reference | API Reference (Test) | API Reference (Prod) |
| Published | On every merge to main |
When a GitHub release is published |
| Source | Committed at docs/public/openapi/test.json |
Release asset openapi-prod.json |
| Last updated | November 5, 2026 | Not yet published |
| SSO issuer | Test SSO realm (test.loginproxy.gov.bc.ca) |
Production SSO realm (loginproxy.gov.bc.ca) |
How it works
Section titled “How it works”- Test is regenerated by a pre-commit hook and checked for drift on every pull request, so the Test reference always matches
main. - Production is generated during the release workflow using the PROD environment’s OIDC settings and attached to the release. The docs site is then rebuilt with that asset.
- Until the first release is published, the Production reference is an empty placeholder.