> For the complete documentation index, see [llms.txt](https://apinf.gitbook.io/api-guidelines/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apinf.gitbook.io/api-guidelines/versioning.md). # Versioning When APIs are upgraded with a breaking change, it may lead to breaking existing products or services using upgraded APIs. Examples of breaking changes: * renaming fields or resource paths or endpoints * changing field type (e.g. from string to a list of strings) * changing structure of payload (removing/renaming/retyping fields) * altering HTTP verbs * changing response HTTP codes In case of breaking changes making a new version of the updated API is mandatory. There are mixed opinions around about the way the versioning is indicated: whether API version should be included in the URL or in a header. **The APInf convention is to have the version in the URL of APIs**. The reason is to ensure browser explorability of the resources across versions. Example: `https://apinf.io/rest/v1/apis` If there is any major breaking update, the new set of APIs is named as `v2` . --- # 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 current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://apinf.gitbook.io/api-guidelines/versioning.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.