Skip to content

docs: explain buffered native Responses - #5590

Merged
markstuart-oai merged 3 commits into
feat/codex-harnessfrom
codex/buffered-native-responses-docs
Nov 8, 2026
Merged

markstuart-oai merged 3 commits into
feat/codex-harnessfrom
codex/buffered-native-responses-docs

Conversation

@markstuart-oai

@markstuart-oai markstuart-oai commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This is the documentation follow-up to #5589. The existing published-preview hold remains pending the reviewer's confirmation of the proposed sequence: merge after #5589 into the development branch. This branch does not deploy the hosted documentation.

The guide explains NativeProvider(response_mode="buffered"), delayed model output and tool-call start, supported models and authentication, and the provider's role when restoring a session. It documents the 64 MiB body limit and the limit of one million structural characters outside strings, with nonretryable failures.

The implementation is reviewed separately in #5589 at 678ec3a232da3cfed578a43939f8f03a838b1e14; its provider option and native transport changes are intentionally kept in that PR.

Test plan

  • Checked the documented behavior against the matching implementation and tests. Independent content review found no issues.
  • make build-docs and git diff --check passed on the current documentation.
  • CI passed on 450d7770: 13 checks succeeded and 16 were skipped. Hosted review is clean, with no unresolved review threads. The published-preview merge hold remains in force.

Issue number

None linked.

Checks

  • I've added new tests, if relevant (documentation-only change)
  • I've run the applicable checks in AGENTS.md, including .agents/skills/code-change-verification/scripts/run.sh when required
  • I've confirmed all required checks pass
  • I've completed the review required by AGENTS.md

@markstuart-oai
markstuart-oai requested review from a team, rm-openai and seratch as code owners November 7, 2026 19:26
@chatgpt-codex-connector

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

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

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

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-07T20:45:03.924798Z 450d777 Manual request
🔒 Security Review ✅ Completed 2026-11-07T20:45:13.697797Z 450d777 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.

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the configuration guide against implementation PR #5589 at 1aca01e with an independent reviewer. No actionable findings. Full-body output/tool timing, API-key HTTP requirements, explicit standard Responses model, unsupported combinations, failure semantics and current-provider restore selection match the implementation. Approval is for content; retain the stated merge gate until a published preview includes buffered support. Hosted CI: 11 passed, 10 skipped, 1 neutral, 1 running. Static review only; no candidate code or tests executed locally.

@markstuart-oai

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

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

Reviewed commit: 68916bd356

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.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

Reviewed commit: 68916bd356

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new size-limit sentence is not supported by implementation PR #5589 at 1369f2e. Independent static review confirmed the mismatch. Remove the claim or supply the matching implementation for review before publishing it. The existing published-preview merge gate still applies. Hosted CI is still pending; no candidate code or tests executed locally.

Comment thread docs/sdk/configuration.md Resolved

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation mismatch is resolved by implementation #5589 at a006551. Coordinator and independent static review verified the 64 MiB transport bound and non-retryable oversize handling. Approval is for content: retain the merge hold until a published preview includes the feature and this fix. Hosted CI: 13 passed, 16 skipped. No candidate code or tests executed locally.

@markstuart-oai

Copy link
Copy Markdown
Contributor Author

@codex review

@jbeckwith-oai jbeckwith-oai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-reviewed 450d777 with an independent static reviewer. The updated guide accurately describes the one-million outside-string structural-character limit and 64 MiB body limit implemented in #5589 at 678ec3a, including non-retryable rejection. No new blockers in this documentation change. Keep the existing merge hold until a published preview contains the implementation and both limits. Hosted CI remains pending (10 passed, 10 skipped, 1 neutral, 2 running at review). No local tests run.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 450d7770dc

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/sdk/configuration.md Resolved
@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

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

Reviewed commit: 450d7770dc

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.

@markstuart-oai

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Swish!

Reviewed commit: 450d7770dc

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@chatgpt-codex-connector

Copy link
Copy Markdown

🛡️ Codex Security Review · Automatically triggered

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

Reviewed commit: 450d7770dc

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.

Copy link
Copy Markdown
Contributor Author

@jbeckwith-oai The earlier description overstated the documentation policy as a mandatory published-release gate. AGENTS.md requires a separate docs PR so maintainers can coordinate timing. This PR targets feat/codex-harness; the docs deployment workflow deploys only pushes to main. The installation guide also explicitly labels these as development-branch guides containing APIs added after alpha.6.

Proposed sequence: merge #5589 after its final verification and CI pass, then merge this guide into the same development branch. That puts the matching implementation and both response limits on the branch without publishing a release or deploying the hosted docs.

Please confirm whether your content approval covers this sequence and removes the earlier published-preview condition. The existing hold remains until that is confirmed.

@markstuart-oai
markstuart-oai merged commit 9d36bb6 into feat/codex-harness Nov 8, 2026
29 checks passed
@markstuart-oai
markstuart-oai deleted the codex/buffered-native-responses-docs branch November 8, 2026 01:23
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.

2 participants