docs: clarify SDK compatibility with API schema versions#8
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
HTTP API 已经从
0.1演进到0.2.0，但引擎版本不一定同步变化。为了避免用户误以为 SDK 兼容性只跟随引擎版本，本次补充 README 中的版本说明。
本次修改
明确区分以下版本概念：
/v1）X-Kele-Api-Version）明确 SDK 的兼容性判断应优先参考 API schema 版本
保持现有 SDK 行为不变，仅更新文档说明
检查 README 示例与当前
0.2.0API 返回结构一致检查说明与当前客户端兼容逻辑一致