Skip to content

docs(api): list only the status strings a commit-write failure envelope carries - #671

Merged
ThomasK33 merged 1 commit into
mainfrom
fix-envelope-status-list
Nov 4, 2026
Merged

ThomasK33 merged 1 commit into
mainfrom
fix-envelope-status-list

Conversation

@ThomasK33

Copy link
Copy Markdown
Member

Why

Follow-up to #668 (issue #665). The clean-context advisor on #668 found that docs/explanation/streaming-commit-protocols.md §3 still said a failure envelope's result.status is one of 11 strings. Since #663 and #669, commit-pack, diff-commit and restore-commit send the envelope only on 400, 409, 412 and 413. So the only possible strings are invalid, conflict, failed, precondition_failed and payload_too_large.

What changes

One sentence in §3 now names those five strings with their HTTP statuses. The SDK mapping table below it does not change, because SDKs still map any status.

Docs only. No code or wire change.

Checks

python3 scripts/check-doc-links.py (0 broken) and the script unit tests pass.

Refs #665


Generated with xum • Model: anthropic:claude-opus-5-5 • Thinking: high

…pe carries

Change-Id: I479a8a953128c1e437bdc18d31a65c6323707854
Signed-off-by: Thomas Kosiewski <tk@coder.com>
@ThomasK33

Copy link
Copy Markdown
Member Author

@codex review

@ThomasK33

Copy link
Copy Markdown
Member Author

@codex security review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-04T18:21:04.304438Z b239e33 Manual request
🔒 Security Review ✅ Completed 2026-11-04T18:21:42.867149Z b239e33 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 👍

Reviewed commit: b239e3381a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review

Security review completed. No security issues were found in this pull request.

Reviewed commit: b239e3381a

View security finding report

Only the user who started this review can view the report in Codex.

ℹ️ About Codex security reviews in GitHub

This is an experimental Codex feature. Security reviews are triggered when:

  • You comment "@codex security review"
  • A regular code review gets triggered (for example, "@codex review" or when a PR is opened), and you’re opted in so security review runs alongside code review

Once complete, Codex will leave suggestions, or a comment if no findings are found.

@ThomasK33
ThomasK33 added this pull request to the merge queue Nov 4, 2026
Merged via the queue into main with commit 9cbfa69 Nov 4, 2026
9 checks passed
@ThomasK33
ThomasK33 deleted the fix-envelope-status-list branch November 4, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant