Skip to content

feat(api): add WebSocket stream IDs - #3612

Merged
jbeckwith-oai merged 1 commit into
mainfrom
codex/castiron-openapi-1e5b3b1f
Aug 13, 2026
Merged

feat(api): add WebSocket stream IDs#3612
jbeckwith-oai merged 1 commit into
mainfrom
codex/castiron-openapi-1e5b3b1f

Conversation

@jbeckwith-oai

Copy link
Copy Markdown
Contributor

Summary

Adds optional WebSocket-only stream_id routing metadata to Responses client events and all server response events. Events sharing a stream ID are processed FIFO and response events echo that identifier.

Source: https://github.com/openai/openai/pull/1282468
OpenAPI commit: 1e5b3b1f1d21b51c5a37d6122c2b3b2d70ef5a1a

Validation

  • Castiron public-baseline generation and formatter completed
  • Python source compilation passed
  • Strict generated-diff quality review passed
  • No private inputs, workflow files, or internal-repository changes are included

@jbeckwith-oai
jbeckwith-oai requested a review from a team as a code owner August 13, 2026 19:13
@openai-sdks

openai-sdks Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 11.512s for Python SDK PR #3612.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 191ms
tests/chat-completions-create.test.ts ✅ Passed 225ms
tests/chat-completions-stream.test.ts ✅ Passed 129ms
tests/files-content-binary.test.ts ✅ Passed 260ms
tests/files-create-multipart.test.ts ✅ Passed 238ms
tests/files-list-pagination.test.ts ✅ Passed 183ms
tests/initialize-config.test.ts ✅ Passed 167ms
tests/instance-isolation.test.ts ✅ Passed 238ms
tests/models-list.test.ts ✅ Passed 226ms
tests/responses-background-lifecycle.test.ts ✅ Passed 238ms
tests/responses-body-method-errors.test.ts ✅ Passed 328ms
tests/responses-cancel-timeout.test.ts ✅ Passed 194ms
tests/responses-cancel.test.ts ✅ Passed 255ms
tests/responses-compact-retries.test.ts ✅ Passed 340ms
tests/responses-compact.test.ts ✅ Passed 308ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 127ms
tests/responses-create-advanced.test.ts ✅ Passed 230ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.096s
tests/responses-create-errors.test.ts ✅ Passed 225ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 289ms
tests/responses-create-retries.test.ts ✅ Passed 357ms
tests/responses-create-stream-failures.test.ts ✅ Passed 127ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 222ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.934s
tests/responses-create-stream.test.ts ✅ Passed 90ms
tests/responses-create-terminal-states.test.ts ✅ Passed 279ms
tests/responses-create-timeout.test.ts ✅ Passed 233ms
tests/responses-create.test.ts ✅ Passed 189ms
tests/responses-delete.test.ts ✅ Passed 243ms
tests/responses-input-items-errors.test.ts ✅ Passed 389ms
tests/responses-input-items-list.test.ts ✅ Passed 331ms
tests/responses-input-items-options.test.ts ✅ Passed 416ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 254ms
tests/responses-input-tokens-count.test.ts ✅ Passed 295ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.956s
tests/responses-not-found-errors.test.ts ✅ Passed 254ms
tests/responses-parse.test.ts ✅ Passed 426ms
tests/responses-retrieve-retries.test.ts ✅ Passed 320ms
tests/responses-retrieve.test.ts ✅ Passed 249ms
tests/responses-stored-method-errors.test.ts ✅ Passed 567ms
tests/retry-behavior.test.ts ✅ Passed 3.2s
tests/sdk-error-shape.test.ts ✅ Passed 291ms

View OkTest run #31734762287

SDK merge (23767b170731) · head (f5d687b53216) · base (721cb1cd1cac) · OkTest (a845fa206fa4)

@HAYDEN-OAI HAYDEN-OAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed the complete generated SDK and OpenAPI diff, including stable and beta synchronous/asynchronous WebSocket request serialization, all server-event variants, discriminated parsing, beta injection events, existing error-dispatch compatibility, and the coordinated upstream schema change. The optional stream_id remains WebSocket-only, preserves existing SSE event inheritance and HTTP request contracts, and is consistently available for multiplexed event routing. No substantive correctness, security, backwards-compatibility, streaming, or reliability issues found.

@jbeckwith-oai
jbeckwith-oai added this pull request to the merge queue Aug 13, 2026
Merged via the queue into main with commit d9029e3 Aug 13, 2026
20 checks passed
@jbeckwith-oai
jbeckwith-oai deleted the codex/castiron-openapi-1e5b3b1f branch August 13, 2026 21:31
@openai-sdks openai-sdks Bot mentioned this pull request Aug 13, 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