Repository navigation
chore(api): document throttling and model overload responses — SDK-235 - #158
Conversation
Castiron-Internal-PR: openai/openai-cli-internal#62 Castiron-Source-SHA: af96ac4f9d371fda0775c8acea9493215d8785a6 Castiron-Public-Base-SHA: bf513cb
Castiron custom code✅ No new custom-code files detected. 5 mixed files remain; 0 existing customizations changed. Compared 5 existing customizations unchanged
A changed generated baseline means this report cannot reliably identify which handwritten lines changed. Inspect the custom-code diffDownload the exact patch produced by this run (requires repository access): gh run download 33954005851 --repo openai/openai-cli \
--name castiron-custom-code-33954005851-1 --dir /tmp/castiron-custom-code-33954005851-1
git apply --stat /tmp/castiron-custom-code-33954005851-1/custom-code.patch
cat /tmp/castiron-custom-code-33954005851-1/custom-code.patchOr reproduce it from an SDK checkout containing the vendored reporter: git fetch --no-tags origin bf513cb5a3b4cedd0ddb1444ae5c4ae9e937c4cd a79f39b94e6962bab6486556a132392f63c69794
python3 scripts/castiron/custom_code_report.py report \
--base bf513cb5a3b4cedd0ddb1444ae5c4ae9e937c4cd \
--head a79f39b94e6962bab6486556a132392f63c69794 --fetch --require-head-hash --public \
--out /tmp/castiron-custom-code-a79f39b94e69
cat /tmp/castiron-custom-code-a79f39b94e69/custom-code.patchThis is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR. |
There was a problem hiding this comment.
🟢 Approval recommended
The spec changes consistently reference existing shared response components and appear to align with the PR’s documentation goal without introducing code-impacting changes.
Pull request overview
Updates the OpenAPI reference used by the CLI/docs to explicitly describe throttling (429 slow_down) and model overload (503 server_is_overloaded) behaviors for Moderations and legacy Videos endpoints via shared response components.
Changes:
- Switch Moderations and Videos endpoints’
429response to#/components/responses/InferenceRateLimited. - Add explicit
503responses referencing#/components/responses/InferenceServiceUnavailable. - Refresh Castiron generation metadata to match the updated spec artifact.
File summaries
| File | Description |
|---|---|
| api_reference/openapi.transformed.yml | Updates specific endpoints to reference the documented inference throttling and overload response components (429/503). |
| .castiron.stats.yml | Updates generation IDs/hashes to reflect the regenerated OpenAPI artifacts. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
markstuart-oai
changed the title
jbeckwith-oai
left a comment
jbeckwith-oai
left a comment
There was a problem hiding this comment.
Reviewed exact head a79f39b against the SDK-235 scope. The change is limited to Castiron generation metadata and the transformed API reference: exactly the five intended Moderations/Videos POST operations now use InferenceRateLimited for 429 and InferenceServiceUnavailable for 503. No runtime or retry behavior changes. The CLI public/internal pair is aligned with counterpart head af96ac4f9d371fda0775c8acea9493215d8785a6; CI has no failures and no unresolved in-scope review threads.
Summary
Document client throttling and model overload responses for moderation and video commands.
Changes