API versioning

The version is part of the URL. The current documentation is v6 and uses:

https://api.blogvault.net/api/v6

Versioned API documentation URLs are canonical: /api/v6/, /api/v6/reference/, and /api/v6/openapi.json. The /api/ alias points to the latest stable API version configured in docs.config.json; the site root is reserved for general BlogVault documentation.

Compatibility

Within a version, treat operation IDs, request fields, response fields, status values, and error codes as a public contract. Breaking API changes should ship under a new version and be recorded in the changelog.

Older versions remain available while supported. Select a version from the header on every documentation page, and do not reuse an existing version URL for a materially different API.

Machine-readable outputs

The version-specific OpenAPI JSON is authoritative. The Markdown reference and LLM context are generated from that same bundled document.