OpenAPITools / OpenAPITools/openapi-generator

[REQ] (Java,...) Support Server Sent Events

Open
#6,123 12 comments 14 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
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.

It is currently impossible to generate stubs and support server sent events in some languages (like Java JAX-RS spec) since there is missing code for SSE (text/event-stream).

Describe the solution you'd like

Introduce isEventStream property in Operation class (and set to true if produces has text/event-stream value) and add missing information to templates (@Context SseEventSink for Java) etc...

Describe alternatives you've considered

/

Additional context

/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Operation class and the Java JAX-RS templates, then trace how the produces value is handled for generated server stubs. Confirm how text/event-stream should be represented and identify the template changes needed for SseEventSink support; done means SSE information is available in the generated output for the affected languages.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.