Skip to content

Document version compatibility for API client #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
djperrefort merged 1 commit into from
Nov 12, 2025
Merged

Document version compatibility for API client #105

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ The client automates user authentication and data parsing, freeing developers to

The Python client is hosted on PyPI and can be installed in the standard fashion.

!!! note "Version Compatibility"

The API client version should match the major and minor version of the upstream API server.
For example, if the API version is `2.3.x`, the compatible client version is `2.3.y`.
Using a mismatched client version may still function, but compatibility is not guaranteed and may
result in inconsistent behavior.


```bash
pip install keystone-api-client
```
Expand Down
Loading