chore(api): document API error response contracts

[markstuart-oai]

Summary

Clarifies documented HTTP failures without changing Ruby exception handling.

Changes

• Document verified error bodies, failure statuses and applicable retry headers.
• Keep existing Ruby client types and methods unchanged.

[github-actions]

Castiron custom code

✅ No new custom-code files detected.

70 mixed files remain; 0 existing customizations changed.

Compared 33435479c2d9 → 4a37ead54dbd. Generated baselines verified.

70 existing customizations unchanged

• lib/openai.rb
• lib/openai/client.rb
• lib/openai/models/audio/transcription_create_response.rb
• lib/openai/models/beta/agents/vault_status_filter.rb
• lib/openai/models/chat/chat_completion_message.rb
• lib/openai/models/chat/chat_completion_message_function_tool_call.rb
• lib/openai/models/chat/completion_create_params.rb
• lib/openai/models/image_edit_completed_event.rb
• lib/openai/models/image_edit_partial_image_event.rb
• lib/openai/models/image_gen_completed_event.rb
• lib/openai/models/image_gen_partial_image_event.rb
• lib/openai/models/images_response.rb
• lib/openai/models/response_format_json_schema.rb
• lib/openai/models/responses/function_tool.rb
• lib/openai/models/responses/response.rb
• lib/openai/models/responses/response_create_params.rb
• lib/openai/models/responses/response_format_text_config.rb
• lib/openai/models/responses/response_format_text_json_schema_config.rb
• lib/openai/models/responses/response_function_tool_call.rb
• lib/openai/models/responses/response_function_web_search.rb
• lib/openai/models/responses/response_output_text.rb
• lib/openai/models/responses/tool.rb
• lib/openai/models/webhooks/webhook_endpoint_with_secret.rb
• lib/openai/resources/beta/agents/sessions.rb
• lib/openai/resources/beta/threads.rb
• lib/openai/resources/chat/completions.rb
• lib/openai/resources/containers/files.rb
• lib/openai/resources/files.rb
• lib/openai/resources/responses.rb
• lib/openai/resources/vector_stores/file_batches.rb
• lib/openai/resources/vector_stores/files.rb
• lib/openai/resources/webhooks.rb
• rbi/openai/client.rbi
• rbi/openai/models/beta/agents/vault_status_filter.rbi
• rbi/openai/models/chat/chat_completion_message.rbi
• rbi/openai/models/chat/chat_completion_message_function_tool_call.rbi
• rbi/openai/models/chat/completion_create_params.rbi
• rbi/openai/models/image_edit_completed_event.rbi
• rbi/openai/models/image_edit_partial_image_event.rbi
• rbi/openai/models/image_gen_completed_event.rbi

30 more in the full report.

A changed generated baseline means this report cannot reliably identify which handwritten lines changed.

Inspect the custom-code diff

Download the exact patch produced by this run (requires repository access):

gh run download 35529724136 --repo openai/openai-ruby \
  --name castiron-custom-code-35529724136-1 --dir /tmp/castiron-custom-code-35529724136-1
git apply --stat /tmp/castiron-custom-code-35529724136-1/custom-code.patch
cat /tmp/castiron-custom-code-35529724136-1/custom-code.patch

Or reproduce it from an SDK checkout containing the vendored reporter:

git fetch --no-tags origin 33435479c2d98603b93c810183d314bc55cd1ee7 4a37ead54dbd6c811b7a776336e9a821f36db277
python3 scripts/castiron/custom_code_report.py report \
  --base 33435479c2d98603b93c810183d314bc55cd1ee7 \
  --head 4a37ead54dbd6c811b7a776336e9a821f36db277 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-4a37ead54dbd
cat /tmp/castiron-custom-code-4a37ead54dbd/custom-code.patch

This is the current full custom patch for mixed files, not an attribution of only the handwritten lines changed by this PR.

Full report and patch

[chatgpt-codex-connector]

Codex Review Summary

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

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-09-20T18:41:02.558628Z	4a37ead	New commits
🔒 Security Review	✅ Completed 2026-09-20T18:41:15.791289Z	4a37ead	New commits

ℹ️ 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.

[openai-sdks]

OkTest Summary

✅ 236/236 SDK tests passed in 9.362s for Ruby SDK PR #728.

Test results — 42 files

Test	Result	Time
tests/chat-completions-complex-body.test.ts	✅ Passed	164ms
tests/chat-completions-create.test.ts	✅ Passed	245ms
tests/chat-completions-stream.test.ts	✅ Passed	142ms
tests/files-content-binary.test.ts	✅ Passed	141ms
tests/files-create-multipart.test.ts	✅ Passed	139ms
tests/files-list-pagination.test.ts	✅ Passed	189ms
tests/initialize-config.test.ts	✅ Passed	97ms
tests/instance-isolation.test.ts	✅ Passed	193ms
tests/models-list.test.ts	✅ Passed	184ms
tests/responses-background-lifecycle.test.ts	✅ Passed	116ms
tests/responses-body-method-errors.test.ts	✅ Passed	390ms
tests/responses-cancel-timeout.test.ts	✅ Passed	203ms
tests/responses-cancel.test.ts	✅ Passed	232ms
tests/responses-compact-retries.test.ts	✅ Passed	293ms
tests/responses-compact.test.ts	✅ Passed	243ms
tests/responses-create-advanced-stream.test.ts	✅ Passed	158ms
tests/responses-create-advanced.test.ts	✅ Passed	198ms
tests/responses-create-disconnect.test.ts	✅ Passed	150ms
tests/responses-create-errors.test.ts	✅ Passed	293ms
tests/responses-create-malformed-api-responses.test.ts	✅ Passed	172ms
tests/responses-create-retries.test.ts	✅ Passed	203ms
tests/responses-create-stream-failures.test.ts	✅ Passed	135ms
tests/responses-create-stream-timeout.test.ts	✅ Passed	232ms
tests/responses-create-stream-wire.test.ts	✅ Passed	2.148s
tests/responses-create-stream.test.ts	✅ Passed	169ms
tests/responses-create-terminal-states.test.ts	✅ Passed	281ms
tests/responses-create-timeout.test.ts	✅ Passed	229ms
tests/responses-create.test.ts	✅ Passed	175ms
tests/responses-delete.test.ts	✅ Passed	243ms
tests/responses-input-items-errors.test.ts	✅ Passed	190ms
tests/responses-input-items-list.test.ts	✅ Passed	199ms
tests/responses-input-items-options.test.ts	✅ Passed	140ms
tests/responses-input-tokens-count-timeout.test.ts	✅ Passed	257ms
tests/responses-input-tokens-count.test.ts	✅ Passed	271ms
tests/responses-malformed-inputs.test.ts	✅ Passed	2.366s
tests/responses-not-found-errors.test.ts	✅ Passed	345ms
tests/responses-parse.test.ts	✅ Passed	220ms
tests/responses-retrieve-retries.test.ts	✅ Passed	205ms
tests/responses-retrieve.test.ts	✅ Passed	218ms
tests/responses-stored-method-errors.test.ts	✅ Passed	729ms
tests/retry-behavior.test.ts	✅ Passed	3.487s
tests/sdk-error-shape.test.ts	✅ Passed	382ms

View OkTest run #35529706384

_{SDK merge (e59591ea767c) · head (4a37ead54dbd) · base (33435479c2d9) · OkTest (a0be4375e02d)}