Enable Event Streaming for RESTful API

[huan]

It seems that the Swagger/OpenAPI does not have a clear way to achieve that.

To be investigated.

Server-Sent Events (SSE)

• https://github.com/OAI/OpenAPI-Specification/issues/396
• https://github.com/whatwg/html/issues/2177

Links

• Server-sent events: a simple way to stream events from a server
• Firebase - Streaming from the REST API
• Server-Sent Events

  curl -i -k -H "Accept: text/event-stream" http://playground.thisisvini.com/bohemian-rhapsody-event-stream
  

• SO - How to use server-sent-events in express.js
• SO - Is using HTML5 Server-sent-events (SSE) ReSTful?
• YT: Two-minute video on how to create a streaming API
• YT: The end of polling: why and how to transform a REST API into a Data Streaming API? by Audrey Neveu
• A better API for making Event Source requests, with all the features of fetch()

OpenAPI Callbacks

• OpenAPI 3.0 Callbacks
• OpenAPI Callbacks and Webhooks
• https://github.com/OAI/OpenAPI-Specification/pull/2103
• SO: How to define events in OpenAPI / Swagger spec?
• Mocking Callbacks with OpenAPI and Prism