OpenAPITools / OpenAPITools/openapi-generator
[REQ] Generate TS fetch endpoints for EventStreams
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
As far as I see it, the generator generates a simple GET fetch, even if the specified response in the spec looks like
responses:
"200":
description: Connection established for streaming updates.
content:
text/event-stream:
schema: ...
Describe the solution you'd like
The Generator should generate a stream client endpoint that can be used like the spec in this MDN doc
https://developer.mozilla.org/en-US/docs/Web/API/Streams_API/Using_readable_streams
Describe alternatives you've considered
I can write own endpoints but that's kind of not the point of having everything generated
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked MDN Streams API example, then inspect how the TypeScript fetch generator handles responses with a text/event-stream content type. Done means the generator emits a stream client endpoint for the OpenAPI response instead of a simple GET result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, typescript
- Domain
- api, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100