Add SSE response schemas for streaming endpoints#550
Draft
Conversation
Co-authored-by: abraham <3341+abraham@users.noreply.github.com>
Co-authored-by: abraham <3341+abraham@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add schema for streaming response data shapes
Add SSE response schemas for streaming endpoints
Nov 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Streaming endpoints were returning empty
text/event-streamcontent without proper schemas. This adds typed SSE event schemas following the Speakeasy SSE pattern.Changes
New
StreamingSchemaGenerator- Creates event type schemas with discriminated unions:update,delete,notification,filters_changed,conversation,announcement,announcement.reaction,announcement.delete,status.update,notifications_mergedStreamingUserEvent,StreamingDirectEvent) with only relevant event typesStatus,Notification, etc.) withoneOffor string/object flexibilityUpdated
MethodConverter- Streaming endpoints now reference appropriate event schemas instead of empty contentExample
Before:
"text/event-stream": {}After:
Where
StreamingUserEventis:{ "oneOf": [ { "$ref": "#/components/schemas/UpdateEvent" }, { "$ref": "#/components/schemas/DeleteEvent" }, { "$ref": "#/components/schemas/NotificationEvent" }, ... ] }Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
otel.cloud.redocly.com/opt/hostedtoolcache/node/24.11.1/x64/bin/node node /home/REDACTED/work/mastodon-openapi/mastodon-openapi/node_modules/.bin/redocly lint --format=github-actions dist/schema.json(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.