API lifecycle and versioning
Source-reviewed draft; deployment and release verification pending.
Draft — source-reviewed on 22 October 2026. The release policy below is a proposal for review, not an implemented compatibility guarantee.
Three version concepts have different purposes:
| Version | Meaning |
|---|---|
| API URL prefix | The reviewed default is /api/v1. It identifies an application API namespace; it does not prove every future response change will be backward compatible. |
Reference schema_version | The public reference response currently emits 2026-10-19.1. It is metadata, not a complete schema fingerprint: it must not be used to infer that later classification additions are absent. |
| ReadMe documentation version or branch | A review and publication mechanism for the documentation. A draft branch neither deploys the API nor changes the API URL. |
Current Feature 110 status
The repository contains public routes, schemas, projections and tests. Phase 9 release readiness work remains distinct from those implementations. This documentation task has not enabled feature flags, migrated an environment, run live acceptance calls or verified a production deployment.
Website-owned catalog keys have a proposed_handoff status in the reviewed registry. Agree them with the website team before external deployment. Do not interpret this draft as a released catalog contract.
Proposed documentation maintenance policy
The following is a recommended policy requiring owner adoption:
- Keep Website Property API as a separate scoped OpenAPI definition in the shared hub.
- Review implementation changes and all affected request/response definitions before updating docs.
- Add new APIs as additional definitions and focused integration sections in the same hub.
- Review breaking changes with consumer teams and document migration steps before a stable publication.
- Verify saved documentation and API references on a restricted review branch before promoting them.
This policy does not create server-side version negotiation, a deprecation header, a support window or a compatibility promise. None should be coded into a client based only on this proposal.
Changelog
The hub's native Changelog section is reserved for actual API updates and breaking-change notices. No release entry is fabricated for this draft. Future entries should identify the changed operation or field, consumer action, applicable deployment and effective date once verified.
Before sharing as a released contract
Confirm the approved API origin, route prefix, feature enablement, CORS, catalog handoff, media readiness, privacy acceptance and remaining Feature 110 Phase 9 checks. Reconcile source/contract discrepancies and approve public documentation publication separately from technical deployment.
Related operations
GET /api/v1/public/property-reference supplies schema_version and destination extent version. The same release review applies to every operation in the Website Property API definition.
Updated 1 day ago