{{ message }}
Repository navigation
[Bug]: SSEStream response examples are not emitted on OpenAPI 3.2.0 #11090
Description
Describe the bug
I have an operation that returns SSEStream<T> and I attached a response example with @@opExample.
When I emit with @typespec/openapi3 targeting OpenAPI 3.2.0, the example is missing from the output: the text/event-stream response has itemSchema but no examples.
There's no error or warning, so the example just silently disappears.
The example itself is valid. If I switch the emitter to OpenAPI 3.0.0, the same example shows up fine (under examples, next to schema: { type: string }, with the expected streams-not-supported warning). So it only gets dropped on the 3.2.0 stream output.
Versions:
@typespec/compiler: 1.13.0@typespec/http: 1.13.0@typespec/openapi3: 1.13.0@typespec/sse: 0.83.0@typespec/events: 0.83.0@typespec/streams: 0.83.0
Reproduction
Checklist
- Follow our Code of Conduct
- Check that there isn't already an issue that request the same bug to avoid creating a duplicate.
- Check that this is a concrete bug. For Q&A open a GitHub Discussion.
- The provided reproduction is a minimal reproducible example of the bug.
Activity
github-actions commentedon Jun 26, 2026
🎯 Issue Triage
When using
@@opExample`` on an operation returningSSEStream<T>, the example is silently dropped in the OpenAPI 3.2.0 output of the `openapi3` emitter, while it emits correctly under OpenAPI 3.0.0.Category: Bug
Area:
emitter:openapi3🔗 [Playground Reproduction]((typespec.io/redacted)
🔍 Analysis
typespec/openapi3emitter — specifically the SSE/streaming response rendering path for OpenAPI 3.2.0.schema: { type: string }for event stream content, where examples are attached. In 3.2.0 mode it outputs anitemSchemastructure for native stream support, but the example-emission code path likely doesn't handle this case and silently discards the example.examplesfortext/event-streamresponses was not updated to handle the OpenAPI 3.2.0-specific streaming schema representation (itemSchema), so examples are lost silently.📝 Suggested next steps
openapi3emitter code handlingtext/event-streammedia types for 3.2.0 and compare it with the 3.0.0 path to find where examples are dropped.@@opExample`` values are included alongside theitemSchemain 3.2.0 output.@@opExample`` onSSEStreamoperations for both 3.0.0 and 3.2.0 targets.