Skip to content

chore(api): document files and uploads error responses - #3960

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

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

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

Documents applicable request, missing-file, upload-state and storage errors for Files and Uploads. Python exceptions are unchanged.

Changes

  • Describe Files lookup and validation failures.
  • Clarify expired-upload recovery and applicable request-rate limits.

Castiron-Internal-PR: openai/openai-python-internal#155
Castiron-Source-SHA: 9de9165abbc9e7c42859d814928269cb1c8da511
Castiron-Public-Base-SHA: 63099e7
@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 63099e739d25 → be5fa8a1a147. 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 36099467042 --repo openai/openai-python \
  --name castiron-custom-code-36099467042-1 --dir /tmp/castiron-custom-code-36099467042-1
git apply --stat /tmp/castiron-custom-code-36099467042-1/custom-code.patch
cat /tmp/castiron-custom-code-36099467042-1/custom-code.patch

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

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

@markstuart-oai
markstuart-oai marked this pull request as ready for review September 25, 2026 05:39
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 05:39
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

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-25T05:41:31.230155Z be5fa8a Draft marked ready
🔒 Security Review ✅ Completed 2026-09-25T05:40:59.603245Z be5fa8a Draft marked ready
ℹ️ 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

openai-sdks Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

OkTest Summary

✅ 236/236 SDK tests passed in 13.611s for Python SDK PR #3960.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 284ms
tests/chat-completions-create.test.ts ✅ Passed 376ms
tests/chat-completions-stream.test.ts ✅ Passed 531ms
tests/files-content-binary.test.ts ✅ Passed 331ms
tests/files-create-multipart.test.ts ✅ Passed 346ms
tests/files-list-pagination.test.ts ✅ Passed 257ms
tests/initialize-config.test.ts ✅ Passed 234ms
tests/instance-isolation.test.ts ✅ Passed 242ms
tests/models-list.test.ts ✅ Passed 431ms
tests/responses-background-lifecycle.test.ts ✅ Passed 214ms
tests/responses-body-method-errors.test.ts ✅ Passed 486ms
tests/responses-cancel-timeout.test.ts ✅ Passed 204ms
tests/responses-cancel.test.ts ✅ Passed 295ms
tests/responses-compact-retries.test.ts ✅ Passed 522ms
tests/responses-compact.test.ts ✅ Passed 286ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 142ms
tests/responses-create-advanced.test.ts ✅ Passed 386ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.408s
tests/responses-create-errors.test.ts ✅ Passed 235ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 358ms
tests/responses-create-retries.test.ts ✅ Passed 342ms
tests/responses-create-stream-failures.test.ts ✅ Passed 894ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 311ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.453s
tests/responses-create-stream.test.ts ✅ Passed 80ms
tests/responses-create-terminal-states.test.ts ✅ Passed 304ms
tests/responses-create-timeout.test.ts ✅ Passed 197ms
tests/responses-create.test.ts ✅ Passed 738ms
tests/responses-delete.test.ts ✅ Passed 291ms
tests/responses-input-items-errors.test.ts ✅ Passed 827ms
tests/responses-input-items-list.test.ts ✅ Passed 471ms
tests/responses-input-items-options.test.ts ✅ Passed 437ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 285ms
tests/responses-input-tokens-count.test.ts ✅ Passed 403ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.399s
tests/responses-not-found-errors.test.ts ✅ Passed 356ms
tests/responses-parse.test.ts ✅ Passed 399ms
tests/responses-retrieve-retries.test.ts ✅ Passed 432ms
tests/responses-retrieve.test.ts ✅ Passed 370ms
tests/responses-stored-method-errors.test.ts ✅ Passed 811ms
tests/retry-behavior.test.ts ✅ Passed 3.387s
tests/sdk-error-shape.test.ts ✅ Passed 345ms

View OkTest run #36099447803

SDK merge (bdbe7e456c8f) · head (be5fa8a1a147) · base (63099e739d25) · OkTest (bc2ef6ca05ab)

@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: be5fa8a1a1

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

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread api_reference/openapi.transformed.yml
@markstuart-oai
markstuart-oai added this pull request to the merge queue Sep 25, 2026
Merged via the queue into main with commit a9d727f Sep 25, 2026
36 of 37 checks passed
@markstuart-oai
markstuart-oai deleted the castiron/promotions/pr-155 branch September 25, 2026 06:17
@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