api-blueprint icon indicating copy to clipboard operation
api-blueprint copied to clipboard

Support for realtime APIs

Open zdne opened this issue 9 years ago • 2 comments

This is an advanced feature request – Dedicated syntax to support real time APIs.

This should primarily address following concepts:

Note: This is NOT a feature request for WebSockets nor Webhooks.

zdne avatar Jun 17 '15 09:06 zdne

Great to see this, Z.

At the high level, I'd change "Server-Sent Events" to simply "Streaming", as SSE is just one type of streaming format in the wild and you'll want to support at least two (the other one being "stream of lines"). In fact, the example APIs cited both use the lines format and not SSE.

jkarneges avatar Jun 17 '15 18:06 jkarneges

Thanks for the explanation @jkarneges ! I have updated the original post.

zdne avatar Jun 18 '15 08:06 zdne