docs(design): retire legacy {accepted} envelope wording from §3.4 (#40)#92
Open
viktor-shcherb wants to merge 1 commit intomainfrom
Open
docs(design): retire legacy {accepted} envelope wording from §3.4 (#40)#92viktor-shcherb wants to merge 1 commit intomainfrom
viktor-shcherb wants to merge 1 commit intomainfrom
Conversation
DESIGN.md §3.4 still described `submit_result` as returning
`{ accepted: true } | { accepted: false, errors: [...] }`. PR #38
landed the canonical `{ ok, errors?, data? }` envelope as the single
shape for every agent endpoint (docs/contracts.md §4 + §4.4); the
`grep:no-accepted-key` gate enforces the absence of the legacy form
in source / test files. The two docs disagreed.
Update §3.4 to point at docs/contracts.md §4 / §4.4 as authoritative
and call out the legacy shape as retired. Drop the "will be reconciled"
note in contracts.md §4.4 — that's what this PR does.
Closes #40.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
Closes #40. `DESIGN.md` §3.4 still described `submit_result` as
returning `{ accepted: true } | { accepted: false, errors: [...] }`.
PR #38 landed the canonical `{ ok, errors?, data? }` envelope as the
single shape for every agent endpoint (`docs/contracts.md` §4 + §4.4);
the `grep:no-accepted-key` gate enforces the absence of the legacy
form in source / test files. The two docs disagreed.
This PR updates §3.4 to point at `docs/contracts.md` §4 / §4.4 as
authoritative + drops the "will be reconciled when DESIGN.md is next
revised" note in contracts.md §4.4 — that's exactly what this PR does.
Test plan
the `grep:no-accepted-key` script + the negative-assertion text
in contracts.md §4.4)
🤖 Generated with Claude Code