realtime beta api spec

[StephenHodgson]

Hi I was wondering when the reatime api spec will be added?

I see there are docs but wasn't able to find them in the current spec.

[benadamdev]

I don't think that's possible. This spec is primarily designed for HTTP-based RESTful APIs. Realtime API is a WebSocket API not a RESTful one.

[StephenHodgson]

@benadamdev there's no reason why it cannot be added. the only real difference is the protocol. Path and payload objects are still defined in json.

I thought OpenAPI had websocket spec proposal? ... oh it was never accepted 😕

Well in either case it'd be great to have a machine readable spec for the json objects and paths 🤷

[StephenHodgson]

fwiw there are ways to use fastapi to build out ws paths...

[StephenHodgson]

Found a realtime spec document, but it is unofficial

[benadamdev]

@StephenHodgson Thank you very much for this. Although this not a REST API, the schemas section is a real gem from a code generation perspective. Coming from Microsoft, this is pretty official to me. Thanks again.

[StephenHodgson]

Regardless if it is not a REST API, I think it is perfectly acceptable to add the schema object definitions to the OpenAPI spec here.

[StephenHodgson]

Added in #356