Skip to content

docs(api): describe response stream event unions - #3613

Closed
jbeckwith-oai wants to merge 1 commit into
mainfrom
codex/castiron-openapi-bc61c529
Closed

docs(api): describe response stream event unions#3613
jbeckwith-oai wants to merge 1 commit into
mainfrom
codex/castiron-openapi-bc61c529

Conversation

@jbeckwith-oai

Copy link
Copy Markdown
Contributor

Summary

  • Document ResponseStreamEvent and BetaResponseStreamEvent as events emitted while a response is streamed.
  • Refresh the generated transformed OpenAPI reference and Castiron generation metadata.
  • Source: https://github.com/openai/openai/pull/1277036
  • OpenAPI commit: bc61c5299f7f6fdd6061ccad0ac7e4ec0f659098

Validation

  • Castiron local dry run; public promotion matches the generated candidate patch exactly.
  • git diff --check and transformed-reference MD5 verified.

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

openai-sdks Bot commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

OkTest Summary

237/237 SDK tests passed in 10.659s for Python SDK PR #3613.

Test results — 42 files
Test Result Time
tests/chat-completions-complex-body.test.ts ✅ Passed 167ms
tests/chat-completions-create.test.ts ✅ Passed 200ms
tests/chat-completions-stream.test.ts ✅ Passed 119ms
tests/files-content-binary.test.ts ✅ Passed 215ms
tests/files-create-multipart.test.ts ✅ Passed 240ms
tests/files-list-pagination.test.ts ✅ Passed 168ms
tests/initialize-config.test.ts ✅ Passed 198ms
tests/instance-isolation.test.ts ✅ Passed 162ms
tests/models-list.test.ts ✅ Passed 144ms
tests/responses-background-lifecycle.test.ts ✅ Passed 240ms
tests/responses-body-method-errors.test.ts ✅ Passed 292ms
tests/responses-cancel-timeout.test.ts ✅ Passed 206ms
tests/responses-cancel.test.ts ✅ Passed 226ms
tests/responses-compact-retries.test.ts ✅ Passed 306ms
tests/responses-compact.test.ts ✅ Passed 215ms
tests/responses-create-advanced-stream.test.ts ✅ Passed 317ms
tests/responses-create-advanced.test.ts ✅ Passed 200ms
tests/responses-create-disconnect.test.ts ✅ Passed 1.187s
tests/responses-create-errors.test.ts ✅ Passed 177ms
tests/responses-create-malformed-api-responses.test.ts ✅ Passed 227ms
tests/responses-create-retries.test.ts ✅ Passed 239ms
tests/responses-create-stream-failures.test.ts ✅ Passed 128ms
tests/responses-create-stream-timeout.test.ts ✅ Passed 234ms
tests/responses-create-stream-wire.test.ts ✅ Passed 3.5s
tests/responses-create-stream.test.ts ✅ Passed 65ms
tests/responses-create-terminal-states.test.ts ✅ Passed 241ms
tests/responses-create-timeout.test.ts ✅ Passed 189ms
tests/responses-create.test.ts ✅ Passed 317ms
tests/responses-delete.test.ts ✅ Passed 175ms
tests/responses-input-items-errors.test.ts ✅ Passed 374ms
tests/responses-input-items-list.test.ts ✅ Passed 303ms
tests/responses-input-items-options.test.ts ✅ Passed 291ms
tests/responses-input-tokens-count-timeout.test.ts ✅ Passed 245ms
tests/responses-input-tokens-count.test.ts ✅ Passed 221ms
tests/responses-malformed-inputs.test.ts ✅ Passed 2.684s
tests/responses-not-found-errors.test.ts ✅ Passed 253ms
tests/responses-parse.test.ts ✅ Passed 384ms
tests/responses-retrieve-retries.test.ts ✅ Passed 249ms
tests/responses-retrieve.test.ts ✅ Passed 218ms
tests/responses-stored-method-errors.test.ts ✅ Passed 601ms
tests/retry-behavior.test.ts ✅ Passed 3.053s
tests/sdk-error-shape.test.ts ✅ Passed 278ms

View OkTest run #31752110921

SDK merge (30a0b443f6c6) · head (4f6c2e45a8b7) · base (d9029e3ada3c) · OkTest (a845fa206fa4)

@ting-hong-shieh ting-hong-shieh 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.

Reviewed base d9029e3a and head 4f6c2e45 against the public generated artifacts:

  • Both transformed OpenAPI snapshots parse as YAML.
  • ResponseStreamEvent and BetaResponseStreamEvent gain the stated description, while each anyOf list remains identical at 53 members.
  • The transformed-reference MD5 matches .castiron.stats.yml on both base (9a60ddf3…) and head (5af6fa4f…).
  • The stable and beta Responses resources use these aliases as their sync and async stream element types, and git diff --check passes.

The linked source PR returned 404 to this GitHub installation, so this validation is limited to the public generated artifacts. No credentials or external runtime service were used. I did not find a blocking issue.

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