Skip to content

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

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

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

Conversation

@markstuart-oai

Copy link
Copy Markdown
Contributor

Summary

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

Changes

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

@markstuart-oai
markstuart-oai marked this pull request as ready for review September 25, 2026 21:25
@markstuart-oai
markstuart-oai requested a review from a team as a code owner September 25, 2026 21:25
@github-actions

github-actions Bot commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Castiron custom code

✅ No new custom-code files detected.

93 mixed files remain; 0 existing customizations changed.

Compared c1973427bddb → be63d43c0b72. Generated baselines verified.

93 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/BetaResponse.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/Response.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/audio/TranslationServiceAsyncImpl.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

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

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

git fetch --no-tags origin c1973427bddbab4d6bf8e1f91e9fe372415eadd1 be63d43c0b7266ff1104936d8ed67f8a21b9ec61
python3 scripts/castiron/custom_code_report.py report \
  --base c1973427bddbab4d6bf8e1f91e9fe372415eadd1 \
  --head be63d43c0b7266ff1104936d8ed67f8a21b9ec61 --fetch --require-head-hash --public \
  --out /tmp/castiron-custom-code-be63d43c0b72
cat /tmp/castiron-custom-code-be63d43c0b72/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 16.128s for Java SDK PR #1089.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 250ms
tests/chat-completions-create.test.ts ✅ Passed 659ms
tests/chat-completions-stream.test.ts ✅ Passed 585ms
tests/files-content-binary.test.ts ✅ Passed 208ms
tests/files-create-multipart.test.ts ✅ Passed 305ms
tests/files-list-pagination.test.ts ✅ Passed 274ms
tests/initialize-config.test.ts ✅ Passed 142ms
tests/instance-isolation.test.ts ✅ Passed 156ms
tests/models-list.test.ts ✅ Passed 280ms
tests/responses-background-lifecycle.test.ts ✅ Passed 167ms
tests/responses-body-method-errors.test.ts ✅ Passed 449ms
tests/responses-cancel-timeout.test.ts ✅ Passed 183ms
tests/responses-cancel.test.ts ✅ Passed 189ms
tests/responses-compact-retries.test.ts ✅ Passed 300ms
tests/responses-compact.test.ts ✅ Passed 269ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 361ms
tests/responses-create-advanced.test.ts ✅ Passed 1.223s
tests/responses-create-disconnect.test.ts ✅ Passed 963ms
tests/responses-create-errors.test.ts ✅ Passed 342ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 232ms
tests/responses-create-retries.test.ts ✅ Passed 256ms
tests/responses-create-stream-failures.test.ts ✅ Passed 1.559s
tests/responses-create-stream-timeout.test.ts ✅ Passed 271ms
tests/responses-create-stream-wire.test.ts ✅ Passed 6.191s
tests/responses-create-stream.test.ts ✅ Passed 295ms
tests/responses-create-terminal-states.test.ts ✅ Passed 345ms
tests/responses-create-timeout.test.ts ✅ Passed 183ms
tests/responses-create.test.ts ✅ Passed 244ms
tests/responses-delete.test.ts ✅ Passed 256ms
tests/responses-input-items-errors.test.ts ✅ Passed 253ms
tests/responses-input-items-list.test.ts ✅ Passed 289ms
tests/responses-input-items-options.test.ts ✅ Passed 369ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 177ms
tests/responses-input-tokens-count.test.ts ✅ Passed 286ms
tests/responses-malformed-inputs.test.ts ✅ Passed 4.984s
tests/responses-not-found-errors.test.ts ✅ Passed 426ms
tests/responses-parse.test.ts ✅ Passed 642ms
tests/responses-retrieve-retries.test.ts ✅ Passed 428ms
tests/responses-retrieve.test.ts ✅ Passed 236ms
tests/responses-stored-method-errors.test.ts ✅ Passed 1.002s
tests/retry-behavior.test.ts ✅ Passed 3.463s
tests/sdk-error-shape.test.ts ✅ Passed 461ms

View OkTest run #36213094128

SDK merge (248ae9fefd40) · head (be63d43c0b72) · base (c1973427bddb) · OkTest (f9111d4e2fcd)

Castiron-Internal-PR: openai/openai-java-internal#159
Castiron-Source-SHA: 2760387efa691afe6ddefb191a49a47f3a77425d
Castiron-Public-Base-SHA: c197342
@markstuart-oai
markstuart-oai force-pushed the castiron/promotions/pr-159 branch from 94f5dac to be63d43 Compare September 26, 2026 02:53
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 26, 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-26T02:55:39.809508Z be63d43 New commits
🔒 Security Review ✅ Completed 2026-09-26T02:56:06.968814Z be63d43 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.

Copy link
Copy Markdown
Contributor Author

Refreshed against current main (c1973427bddb). The new head (be63d43c0b72) is conflict-free and changes only the API reference and generation metadata. All client source, public APIs, exception types, runtime behavior, dependencies, workflows and compatibility tests are byte-identical to main, including the recently published access-program builder defaults. The reference retains exactly the 643 reviewed error-response changes and no other semantic changes. Fresh CI is running.

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

Copy link
Copy Markdown
Contributor Author

Thanks @dpiet-oai and @saioai for reviewing. All repository checks are now successful or intentionally skipped, and the downstream compatibility run also passed all 236/236 SDK tests: https://github.com/openai/ok-test/actions/runs/36213094128. The reviewed head remains be63d43c0b72; only the API reference and generation metadata differ from main, with client source and error handling unchanged.

Merged via the queue into main with commit e929b50 Sep 26, 2026
14 checks passed
@openai-sdks openai-sdks Bot mentioned this pull request Sep 26, 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.

3 participants