> For the complete documentation index, see [llms.txt](https://docs.brokvix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brokvix.com/rest-api/contract-and-compatibility.md). # Contract and compatibility Each operation in the published Client API reference must state its API version, environment, authentication and authorization requirements, headers, parameters, request and response schemas, documented errors, pagination or idempotency rules where relevant, and a synthetic example. A changelog must distinguish behavioral contract changes from documentation corrections. The approved OpenAPI file is the source of operation pages. It must be filtered and reviewed **before** publication: the server's full Swagger document may also contain admin, provider callback, internal, or tenant-specific routes that do not belong in a public client reference. Never include bearer tokens, real client records, private hostnames, or production credentials in examples. Breaking changes need a migration path and an agreed overlap period before older clients are retired. Recheck generated pages and examples against a sandbox and the intended release. A successful import or build does not prove that an operation is available to an external integrator. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.brokvix.com/rest-api/contract-and-compatibility.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.