docs(contracts): define api change rules - #16
Open
Hqzdev wants to merge 1 commit into
Open
Conversation
The API contract guide needed explicit compatibility and error-shape rules. Documenting the change checklist reduces accidental breaking changes across web, bot and service consumers. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Hqzdev
added
documentation
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
2 participants
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.
Что сделано
Обновлен docs/architecture/API_CONTRACTS.md: описаны contract sources, что считается contract change, compatibility policy, response checklist и error contract.
Зачем
API contracts нужны web, bot и сервисным consumer-ам. Явные правила изменения снижают риск случайного breaking change без coordinated deploy.
Что проверено
Риски и ограничения
Docs-only изменение. Contract tests и OpenAPI validation не запускались, потому что spec не менялся.