chore(api): document stored chat completion errors

[markstuart-oai]

Summary

Clarifies stored chat completion error responses without changing Ruby methods or exceptions.

Changes

• Document applicable validation, lookup, rate-limit and service errors.
• Preserve existing success responses and error handling.

[github-actions]

Castiron custom code

✅ No new custom-code files detected.

70 mixed files remain; 0 existing customizations changed.

Compared 0185fa1c637f → 1cabcb096995. 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 36170790002 --repo openai/openai-ruby \
  --name castiron-custom-code-36170790002-1 --dir /tmp/castiron-custom-code-36170790002-1
git apply --stat /tmp/castiron-custom-code-36170790002-1/custom-code.patch
cat /tmp/castiron-custom-code-36170790002-1/custom-code.patch

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

git fetch --no-tags origin 0185fa1c637f1dbc9d3b3fa85c4c46a199702188 1cabcb09699547181598d8653446f4c0f454a409
python3 scripts/castiron/custom_code_report.py report \
  --base 0185fa1c637f1dbc9d3b3fa85c4c46a199702188 \
  --head 1cabcb09699547181598d8653446f4c0f454a409 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-1cabcb096995
cat /tmp/castiron-custom-code-1cabcb096995/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

[openai-sdks]

OkTest Summary

✅ 236/236 SDK tests passed in 8.271s for Ruby SDK PR #763.

Test results — 42 files

Test	Result	Time
tests/chat-completions-complex-body.test.ts	✅ Passed	141ms
tests/chat-completions-create.test.ts	✅ Passed	222ms
tests/chat-completions-stream.test.ts	✅ Passed	124ms
tests/files-content-binary.test.ts	✅ Passed	118ms
tests/files-create-multipart.test.ts	✅ Passed	136ms
tests/files-list-pagination.test.ts	✅ Passed	139ms
tests/initialize-config.test.ts	✅ Passed	110ms
tests/instance-isolation.test.ts	✅ Passed	107ms
tests/models-list.test.ts	✅ Passed	162ms
tests/responses-background-lifecycle.test.ts	✅ Passed	183ms
tests/responses-body-method-errors.test.ts	✅ Passed	317ms
tests/responses-cancel-timeout.test.ts	✅ Passed	221ms
tests/responses-cancel.test.ts	✅ Passed	206ms
tests/responses-compact-retries.test.ts	✅ Passed	146ms
tests/responses-compact.test.ts	✅ Passed	212ms
tests/responses-create-advanced-stream.test.ts	✅ Passed	142ms
tests/responses-create-advanced.test.ts	✅ Passed	138ms
tests/responses-create-disconnect.test.ts	✅ Passed	127ms
tests/responses-create-errors.test.ts	✅ Passed	246ms
tests/responses-create-malformed-api-responses.test.ts	✅ Passed	116ms
tests/responses-create-retries.test.ts	✅ Passed	157ms
tests/responses-create-stream-failures.test.ts	✅ Passed	120ms
tests/responses-create-stream-timeout.test.ts	✅ Passed	201ms
tests/responses-create-stream-wire.test.ts	✅ Passed	1.846s
tests/responses-create-stream.test.ts	✅ Passed	164ms
tests/responses-create-terminal-states.test.ts	✅ Passed	213ms
tests/responses-create-timeout.test.ts	✅ Passed	217ms
tests/responses-create.test.ts	✅ Passed	145ms
tests/responses-delete.test.ts	✅ Passed	112ms
tests/responses-input-items-errors.test.ts	✅ Passed	159ms
tests/responses-input-items-list.test.ts	✅ Passed	169ms
tests/responses-input-items-options.test.ts	✅ Passed	105ms
tests/responses-input-tokens-count-timeout.test.ts	✅ Passed	251ms
tests/responses-input-tokens-count.test.ts	✅ Passed	153ms
tests/responses-malformed-inputs.test.ts	✅ Passed	2.101s
tests/responses-not-found-errors.test.ts	✅ Passed	259ms
tests/responses-parse.test.ts	✅ Passed	150ms
tests/responses-retrieve-retries.test.ts	✅ Passed	190ms
tests/responses-retrieve.test.ts	✅ Passed	200ms
tests/responses-stored-method-errors.test.ts	✅ Passed	691ms
tests/retry-behavior.test.ts	✅ Passed	3.393s
tests/sdk-error-shape.test.ts	✅ Passed	402ms

View OkTest run #36170756772

_{SDK merge (2d65d1583ee6) · head (1cabcb096995) · base (0185fa1c637f) · OkTest (bfef66d461d0)}

[markstuart-oai]

Thanks for reviewing. The approved head is unchanged, with only the API reference and generation metadata modified. Ruby client APIs, exceptions and runtime remain byte-identical to main; current CI and all 236 downstream compatibility cases pass.