Add comments to schema version constants

diff --git a/music_assistant/constants.py b/music_assistant/constants.py
index 2f501dde7162ba2e995b318bb1e51d4808eaa8d6..8806182992bdd2e2c0f988467746059762cd6428 100644 (file)
--- a/music_assistant/constants.py
+++ b/music_assistant/constants.py
@@ -26,8 +26,16 @@ PLAYLIST_MEDIA_TYPES: Final[tuple[MediaType, ...]] = (
     MediaType.AUDIOBOOK,
 )
 
-
+# API_SCHEMA_VERSION: bump this when adding new features to the API commands (and models)
+# or small non-breaking changes to existing commands
 API_SCHEMA_VERSION: Final[int] = 29
+
+# MIN_SCHEMA_VERSION is the minimum API schema version that the current server
+# version can work with. Only bump when there are breaking changes to existing
+# API commands or models, such as removing fields or changing field types.
+# Note that doing so will break compatibility with all clients in the field
+# (including Home Assistant) that have not yet been updated to the new API
+# schema version, so only bump this when absolutely necessary.
 MIN_SCHEMA_VERSION: Final[int] = 28