From 096f570a6f27632e7c6a3627454a2b4d68672727 Mon Sep 17 00:00:00 2001 From: Daniel Perrefort Date: Wed, 12 Nov 2025 11:40:36 -0500 Subject: [PATCH] Document version compatibility for API client Added note about version compatibility for the API client. --- docs/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/index.md b/docs/index.md index b8b34ec..f0a3987 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 ```