Skip to content

chore(api): declare SSE response contracts for streaming endpoints #4089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jbeckwith-oai wants to merge 1 commit into from
Closed

chore(api): declare SSE response contracts for streaming endpoints #4089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
schema_version: 1
generation_id: 4655b3fd-100f-41ed-a911-2a1a9d32ea2b
openapi_spec_hash: 2013b5fe3879ad548bef3c02a8400e28
openapi_transformed_spec_hash: ebaa4dc38d766dcc79436fa46d7578b5
config_hash: e2240ed667dcf3afd130abd71b47b9fc
codegen_sha: 096a813d99130ad2016e14f79774c24773508eee
generation_id: eeb2c5de-b2c2-4746-840e-eb9b10f63960
openapi_spec_hash: 82e364ae01db88c439152a14590a2798
openapi_transformed_spec_hash: 3ef2eff77c3be343f9948c2a9c9fbd58
config_hash: cf24319292c48508c19b7bc1d0c53823
codegen_sha: 85a8f37b1d9365aeb867bd95981452a7fbc04fb3
codegen_hash: a162fbfb7bc65621f28757a1057460101763c6d38f99aff46d045581f34361d8
public_codegen_sha: 89aff405340b117ab2b7c2e790c2baea90439069
public_codegen_sha: 18083220e7f070c5987854de9132fe435fe3c25e
18 changes: 18 additions & 0 deletions api_reference/openapi.transformed.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3573,6 +3573,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/CreateCompletionResponse'
text/event-stream:
schema:
$ref: '#/components/schemas/CreateCompletionResponse'
Comment on lines +3576 to +3578

@chatgpt-codex-connector chatgpt-codex-connector Bot Oct 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Allow null finish reasons in streamed completion chunks

When stream: true, intermediate completion chunks contain "finish_reason": null, as the endpoint's own streaming example demonstrates at lines 3728-3734. CreateCompletionResponse instead requires finish_reason to be one of three non-null strings at lines 42119-42134, so assigning that schema to text/event-stream makes valid chunks fail OpenAPI validation and misleads clients generated from this contract. Use a streaming schema that permits null, or make the shared choice field nullable.

Useful? React with 👍 / 👎.

'400':
description: Invalid completion request or incompatible request parameters.
content:
Expand Down Expand Up @@ -21290,6 +21293,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Response'
text/event-stream:
schema:
$ref: '#/components/schemas/ResponseStreamEvent'
'404':
description: The response was not found.
content:
Expand Down Expand Up @@ -21783,6 +21789,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RunObject'
text/event-stream:
schema:
$ref: '#/components/schemas/AssistantStreamEvent'
'429':
$ref: '#/components/responses/TooManyRequests'
x-oaiMeta:
Expand Down Expand Up @@ -23067,6 +23076,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RunObject'
text/event-stream:
schema:
$ref: '#/components/schemas/AssistantStreamEvent'
'429':
$ref: '#/components/responses/TooManyRequests'
x-oaiMeta:
Expand Down Expand Up @@ -24007,6 +24019,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RunObject'
text/event-stream:
schema:
$ref: '#/components/schemas/AssistantStreamEvent'
'429':
$ref: '#/components/responses/TooManyRequests'
x-oaiMeta:
Expand Down Expand Up @@ -35889,6 +35904,9 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/BetaResponse'
text/event-stream:
schema:
$ref: '#/components/schemas/BetaResponseStreamEvent'
'404':
description: The response was not found.
content:
Expand Down
Loading