Skip to content

Support generating EventSource clients for text/event-stream endpoints #1819

Description

@axel7083

OpenAPI explicitly supports text/event-stream as a response media type (See https://spec.openapis.org/oas/latest.html#media-types). Currently swagger-typescript-api generates these endpoints as a standard request(), where T is the schema of a single event payload. However, this is semantically incorrect because an SSE endpoint produces a sequence of events rather than a single response object.

Would you be interested in adding optional support for generating SSE-aware clients (for example returning EventSource, AsyncIterable, or via a configurable template) when the response media type is text/event-stream?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions