Skip to content

Commit

Permalink
Clarify the API version meaning
Browse files Browse the repository at this point in the history
Changelog: None

Signed-off-by: Alan Martinovic <alan.martinovic@northern.tech>
  • Loading branch information
TheMeaningfulEngineer committed Jul 23, 2021
1 parent bf3d3e9 commit dc9b16b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions 02.Overview/14.Compatibility/docs.md
Expand Up @@ -135,6 +135,11 @@ The [Mender Artifact format](../03.Artifact/docs.md) is managed by the [Mender A

The compatibility between the Mender server and client is managed by the Device API versions exposed by the server and used by the client. If the Mender server supports the API version of the Mender client, they are compatible. However, please ensure that the client and server support the [Artifact format](#mender-clientserver-and-artifact-format) version you are using. Device API docs are available in the [API chapter](../../200.Server-side-API/?target=_blank#device-apis).

The higher version API is a superset of the previous one. For endpoints which haven't changed in the new version the previous version ones are assumed.

*Example* The device supports the V2 API. It expects the [single V2 endpoint](https://docs.mender.io/api/#device-api-deployments-v2) to be available. For all other endpoints it will use the V1.


<!--AUTOVERSION: "Mender server % and %"/ignore "Mender server % and later"/ignore "Mender client % and %"/ignore "Mender client % and later"/ignore-->
| | API v1 | API v2 |
|-------------------------------|--------|--------|
Expand Down

0 comments on commit dc9b16b

Please sign in to comment.