Ownerproof API versioning and deprecation policy
Ownerproof versions the public HTTP API in the URL path (`/api/public`, `/api/v2/quiz/questions`) and in the OpenAPI `info.version` field. Agents should pin to the documented paths in https://ownerproof.io/openapi.json rather than scraping undocumented routes.
How versions work
- The current public surface is version 1.0.0 of the Ownerproof Public API, served from https://ownerproof.io. - Additive, backward-compatible changes (new fields, new optional endpoints) do not require a new path. - Breaking changes get a new path prefix (for example `/api/v3/...`) or a new OpenAPI version. The previous path stays live through the sunset window below.
How deprecation is signaled
When an Ownerproof public endpoint will be removed:
1. The OpenAPI operation is marked `deprecated: true`. 2. Responses include a `Deprecation` header (RFC 9745) and a `Sunset` header (RFC 8594) with the UTC date the path will stop. 3. This page and https://ownerproof.io/llms.txt name the successor path.
Nothing on the current public catalog is deprecated. There is no sunset date. If that changes, this page is the policy agents should poll.
Compatibility window
Ownerproof keeps a deprecated public path available for at least 180 days after the Sunset date is first advertised. Authenticated owner APIs follow the same header convention.
CLI: `npx ownerproof help`. Docs: https://ownerproof.io/developers.
Ownerproof LLC, 1859 28th St, Denver, CO 80216. Phone (720) 535-5505. Sales [email protected]. Support [email protected].