# Versioning policy

The Apentis API follows a dual versioning model:

* **Contract version** (Path-based)
* **Release version** (Semantic versioning)

### 1. Contract version (path prefix)

The contract version is defined in the request path:

Example: `/v1.1/business-relations`

A new major or minor contract version is introduced only when:

* Breaking changes are introduced (major version). These may include removing fields, renaming paths, or changing behavior in a non-backward-compatible way.
* New non-breaking capabilities justify a contract upgrade (minor version). these may include new endpoints, fields, or optional enhancements.

Examples:

* `/v1.0/`
* `/v1.1/`
* `/v2.0/` (breaking)

Once published, a contract version remains stable.

Clients should always specify the API version in their requests and monitor changelogs before upgrading to a new major version.

### 2. Release version (x.y.z)

Each deployment of the API platform is tagged using semantic versioning: MAJOR.MINOR.PATCH

Example:

* 1.1.0
* 1.1.1
* 1.1.2

Patch releases:

* Do NOT change the path version
* May include improvements, internal enhancements, additional optional fields
* Remain fully backward compatible

### Governance rule

If `/v1.1/` is active:

* All `1.1.x` releases operate under the same contract
* No backward-incompatible change is allowed


---

# Agent Instructions: 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:

```
GET https://apentis.gitbook.io/apentis-api/release-notes/versioning-policy.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.