Skip to content

chore(api): clarify documented API error responses - #3965

Merged
markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-161
Sep 26, 2026
Merged

markstuart-oai merged 1 commit into
mainfrom
castiron/promotions/pr-161

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

Clarifies documented error responses for Python users without changing existing client behavior.

Changes

  • Document applicable errors across organization, inference, media and resource APIs.
  • Preserve existing public methods, exception types and runtime behavior.

Castiron-Internal-PR: openai/openai-python-internal#161
Castiron-Source-SHA: d7da583237a5ded5d7aeb2a38b6855a1e359bfd6
Castiron-Public-Base-SHA: 5d4003c
@markstuart-oai
markstuart-oai marked this pull request as ready for review September 25, 2026 20:56
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 20:56
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

47 mixed files remain; 0 existing customizations changed.

Compared 5d4003c12d5d → dcec5b136841. Generated baselines verified.

47 existing customizations unchanged
  • api.md
  • scripts/castiron/README.md
  • scripts/castiron/custom_code_report.py
  • scripts/castiron/test_custom_code_report.py
  • src/openai/init.py
  • src/openai/_client.py
  • src/openai/resources/audio/transcriptions.py
  • src/openai/resources/audio/translations.py
  • src/openai/resources/beta/agents/sessions/sessions.py
  • src/openai/resources/beta/beta.py
  • src/openai/resources/beta/responses/responses.py
  • src/openai/resources/beta/threads/runs/runs.py
  • src/openai/resources/beta/threads/threads.py
  • src/openai/resources/chat/completions/completions.py
  • src/openai/resources/embeddings.py
  • src/openai/resources/files.py
  • src/openai/resources/live/forks.py
  • src/openai/resources/live/live.py
  • src/openai/resources/live/sideband.py
  • src/openai/resources/realtime/api.md
  • src/openai/resources/realtime/realtime.py
  • src/openai/resources/responses/responses.py
  • src/openai/resources/uploads/uploads.py
  • src/openai/resources/vector_stores/file_batches.py
  • src/openai/resources/vector_stores/files.py
  • src/openai/resources/videos.py
  • src/openai/resources/webhooks/init.py
  • src/openai/resources/webhooks/webhooks.py
  • src/openai/types/beta/agent_session_message.py
  • src/openai/types/chat/init.py
  • src/openai/types/chat/chat_completion_message_tool_call.py
  • src/openai/types/fine_tuning/fine_tuning_job_integration.py
  • src/openai/types/realtime/conversation_item_input_audio_transcription_delta_event.py
  • src/openai/types/realtime/realtime_error_event.py
  • src/openai/types/responses/init.py
  • src/openai/types/responses/response.py
  • src/openai/types/responses/response_function_web_search.py
  • src/openai/types/responses/response_function_web_search_param.py
  • src/openai/types/responses/responses_client_event.py
  • src/openai/types/responses/responses_client_event_param.py

7 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 36188751248 --repo openai/openai-python \
  --name castiron-custom-code-36188751248-1 --dir /tmp/castiron-custom-code-36188751248-1
git apply --stat /tmp/castiron-custom-code-36188751248-1/custom-code.patch
cat /tmp/castiron-custom-code-36188751248-1/custom-code.patch

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

git fetch --no-tags origin 5d4003c12d5df5a5faed35971cac3bcb711fdf7d dcec5b136841a9735f574c3854258b0fa91176c1
python3 scripts/castiron/custom_code_report.py report \
  --base 5d4003c12d5df5a5faed35971cac3bcb711fdf7d \
  --head dcec5b136841a9735f574c3854258b0fa91176c1 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-dcec5b136841
cat /tmp/castiron-custom-code-dcec5b136841/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

openai-sdks Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 7.862s for Python SDK PR #3965.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 168ms
tests/chat-completions-create.test.ts ✅ Passed 126ms
tests/chat-completions-stream.test.ts ✅ Passed 108ms
tests/files-content-binary.test.ts ✅ Passed 181ms
tests/files-create-multipart.test.ts ✅ Passed 148ms
tests/files-list-pagination.test.ts ✅ Passed 97ms
tests/initialize-config.test.ts ✅ Passed 99ms
tests/instance-isolation.test.ts ✅ Passed 81ms
tests/models-list.test.ts ✅ Passed 85ms
tests/responses-background-lifecycle.test.ts ✅ Passed 121ms
tests/responses-body-method-errors.test.ts ✅ Passed 223ms
tests/responses-cancel-timeout.test.ts ✅ Passed 159ms
tests/responses-cancel.test.ts ✅ Passed 126ms
tests/responses-compact-retries.test.ts ✅ Passed 215ms
tests/responses-compact.test.ts ✅ Passed 187ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 63ms
tests/responses-create-advanced.test.ts ✅ Passed 170ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.042s
tests/responses-create-errors.test.ts ✅ Passed 112ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 74ms
tests/responses-create-retries.test.ts ✅ Passed 381ms
tests/responses-create-stream-failures.test.ts ✅ Passed 77ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 175ms
tests/responses-create-stream-wire.test.ts ✅ Passed 2.356s
tests/responses-create-stream.test.ts ✅ Passed 232ms
tests/responses-create-terminal-states.test.ts ✅ Passed 154ms
tests/responses-create-timeout.test.ts ✅ Passed 175ms
tests/responses-create.test.ts ✅ Passed 136ms
tests/responses-delete.test.ts ✅ Passed 119ms
tests/responses-input-items-errors.test.ts ✅ Passed 305ms
tests/responses-input-items-list.test.ts ✅ Passed 207ms
tests/responses-input-items-options.test.ts ✅ Passed 218ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 183ms
tests/responses-input-tokens-count.test.ts ✅ Passed 118ms
tests/responses-malformed-inputs.test.ts ✅ Passed 1.578s
tests/responses-not-found-errors.test.ts ✅ Passed 163ms
tests/responses-parse.test.ts ✅ Passed 145ms
tests/responses-retrieve-retries.test.ts ✅ Passed 124ms
tests/responses-retrieve.test.ts ✅ Passed 145ms
tests/responses-stored-method-errors.test.ts ✅ Passed 430ms
tests/retry-behavior.test.ts ✅ Passed 3.084s
tests/sdk-error-shape.test.ts ✅ Passed 257ms

View OkTest run #36188722944

SDK merge (968b5443a040) · head (dcec5b136841) · base (5d4003c12d5d) · OkTest (f9111d4e2fcd)

@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 26, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for reviewing. The approved head is unchanged and still contains only the error-reference update and generation metadata; existing client APIs, exception types and runtime behavior are preserved.

Merged via the queue into main with commit 384fee3 Sep 26, 2026
28 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-161 branch September 26, 2026 02:42
@openai-sdks openai-sdks Bot mentioned this pull request Sep 25, 2026
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