Skip to content

chore(api): document batch error responses - #1082

Open
markstuart-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-153
Open

markstuart-oai wants to merge 1 commit into
mainfrom
castiron/promotions/pr-153

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

Documents Batch API error responses while preserving Java exception types and method signatures.

Changes

  • Clarify invalid requests, missing batches, and cancellation conflicts.
  • Describe applicable rate-limit and service-error responses.

Castiron-Internal-PR: openai/openai-java-internal#153
Castiron-Source-SHA: bb67d4e6fbc6b9228a6cec6d316019ffb9b300bd
Castiron-Public-Base-SHA: 69a4e21
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

87 mixed files remain; 0 existing customizations changed.

Compared 69a4e21ba368 → 0a07bd7c91ee. Generated baselines verified.

87 existing customizations unchanged
  • openai-java-core/src/main/kotlin/com/openai/models/audio/AudioResponseFormat.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuth.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuthCreateParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/agents/vaults/credentials/CredentialAuthRotateParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponseStreamEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/beta/responses/BetaResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionMessageFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/chat/completions/ChatCompletionToolMessageParam.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/Embedding.kt
  • openai-java-core/src/main/kotlin/com/openai/models/embeddings/EmbeddingCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseCreateParams.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionToolCall.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionWebSearch.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseInputItem.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseStreamEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseTextConfig.kt
  • openai-java-core/src/main/kotlin/com/openai/models/responses/ResponsesServerEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/videos/Video.kt
  • openai-java-core/src/main/kotlin/com/openai/models/webhooks/UnwrapWebhookEvent.kt
  • openai-java-core/src/main/kotlin/com/openai/models/webhooks/WebhookEndpointWithSecret.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/BetaServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/ImageServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/ResponseServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/ResponseServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/SkillServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/VideoServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/WebhookServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/WebhookServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/audio/TranscriptionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/beta/agents/SessionServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/beta/agents/SessionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/chat/ChatCompletionServiceAsync.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/finetuning/checkpoints/PermissionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/async/skills/VersionServiceAsyncImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/BetaServiceImpl.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/ResponseService.kt
  • openai-java-core/src/main/kotlin/com/openai/services/blocking/ResponseServiceImpl.kt

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

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

git fetch --no-tags origin 69a4e21ba3686e83b084901febeffb42b818460b 0a07bd7c91ee9b43e0824ef96a07e4b86304cce5
python3 scripts/castiron/custom_code_report.py report \
  --base 69a4e21ba3686e83b084901febeffb42b818460b \
  --head 0a07bd7c91ee9b43e0824ef96a07e4b86304cce5 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-0a07bd7c91ee
cat /tmp/castiron-custom-code-0a07bd7c91ee/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 07:01
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 07:01
@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-25T07:03:11.004412Z 0a07bd7 Draft marked ready
🔒 Security Review ✅ Completed 2026-09-25T07:04:27.914104Z 0a07bd7 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 17.446s for Java SDK PR #1082.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 194ms
tests/chat-completions-create.test.ts ✅ Passed 912ms
tests/chat-completions-stream.test.ts ✅ Passed 864ms
tests/files-content-binary.test.ts ✅ Passed 363ms
tests/files-create-multipart.test.ts ✅ Passed 524ms
tests/files-list-pagination.test.ts ✅ Passed 282ms
tests/initialize-config.test.ts ✅ Passed 207ms
tests/instance-isolation.test.ts ✅ Passed 201ms
tests/models-list.test.ts ✅ Passed 362ms
tests/responses-background-lifecycle.test.ts ✅ Passed 829ms
tests/responses-body-method-errors.test.ts ✅ Passed 441ms
tests/responses-cancel-timeout.test.ts ✅ Passed 257ms
tests/responses-cancel.test.ts ✅ Passed 343ms
tests/responses-compact-retries.test.ts ✅ Passed 417ms
tests/responses-compact.test.ts ✅ Passed 447ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 452ms
tests/responses-create-advanced.test.ts ✅ Passed 1.434s
tests/responses-create-disconnect.test.ts ✅ Passed 986ms
tests/responses-create-errors.test.ts ✅ Passed 321ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 277ms
tests/responses-create-retries.test.ts ✅ Passed 322ms
tests/responses-create-stream-failures.test.ts ✅ Passed 302ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 266ms
tests/responses-create-stream-wire.test.ts ✅ Passed 6.448s
tests/responses-create-stream.test.ts ✅ Passed 586ms
tests/responses-create-terminal-states.test.ts ✅ Passed 313ms
tests/responses-create-timeout.test.ts ✅ Passed 227ms
tests/responses-create.test.ts ✅ Passed 316ms
tests/responses-delete.test.ts ✅ Passed 246ms
tests/responses-input-items-errors.test.ts ✅ Passed 259ms
tests/responses-input-items-list.test.ts ✅ Passed 324ms
tests/responses-input-items-options.test.ts ✅ Passed 567ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 280ms
tests/responses-input-tokens-count.test.ts ✅ Passed 366ms
tests/responses-malformed-inputs.test.ts ✅ Passed 5.057s
tests/responses-not-found-errors.test.ts ✅ Passed 367ms
tests/responses-parse.test.ts ✅ Passed 903ms
tests/responses-retrieve-retries.test.ts ✅ Passed 291ms
tests/responses-retrieve.test.ts ✅ Passed 319ms
tests/responses-stored-method-errors.test.ts ✅ Passed 1.017s
tests/retry-behavior.test.ts ✅ Passed 3.545s
tests/sdk-error-shape.test.ts ✅ Passed 428ms

View OkTest run #36105574719

SDK merge (09bbb64692f1) · head (0a07bd7c91ee) · base (69a4e21ba368) · OkTest (bc2ef6ca05ab)

This branch has not been deployed

No deployments
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.

1 participant