docs: add endpoint contract (GitHub dispatch + Weblate)#4
Open
leostar0412 wants to merge 2 commits intocppalliance:masterfrom
Open
docs: add endpoint contract (GitHub dispatch + Weblate)#4leostar0412 wants to merge 2 commits intocppalliance:masterfrom
leostar0412 wants to merge 2 commits intocppalliance:masterfrom
Conversation
- Add docs/endpoint-contract.md with inventory, contracts, server cross-check - Link from README under Integration contracts Co-authored-by: Cursor <cursoragent@cursor.com>
- Clarify Weblate server implementation details and verification process. - Specify requirements for the `WEBLATE_URL` configuration. - Update descriptions for server contract and response formats for better clarity. - Include additional context on the POST handler and its components.
📝 WalkthroughWalkthroughThis pull request adds documentation describing the HTTP integration contracts between this repository's GitHub dispatch workflows and the external Weblate Django app, including endpoint specifications, request/response schemas, authentication rules, and current gaps. ChangesIntegration Contract Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
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.
Closes #9
Summary
Adds a first-pass integration contract for operators: HTTP surfaces between this repo and GitHub / Weblate, with pointers to authoritative code in
cppalliance/weblate.Changes
docs/endpoint-contract.md: endpoint inventory, GitHubrepository_dispatchnotes (add-submodules,start-translation,sync-translation), WeblatePOST …/boost-endpoint/add-or-update/caller vs server behavior, optionalGET …/boost-endpoint/,WEBLATE_URL/URL_PREFIXguidance, risks, backlog, source index.README.md: Integration contracts subsection linking to the doc.Summary by CodeRabbit