馃摑 Document the SwitcherIO API with OpenAPI
Summary
Add a readable documentation of the whole SwitcherIO API.
How would you like the feature to work ?
The OpenAPI (or AsyncAPI) provide a way to document WebSocket calls and Gitlab provides also a way to display this documentation.
Why is this feature important to you ?
We need to have a public document easy to read that guides any API implementation/communication.
Some useful links:
OpenAPI for socketIO / WebSocket
- https://github.com/swagger-api/swagger-socket/issues/47
- https://www.openapis.org/blog/2016/11/14/tdc-protocol-and-payload-explaining-the-3-0-spec-part-4
- https://github.com/OAI/OpenAPI-Specification/issues/396
- https://github.com/swagger-api/swagger.io/issues/63
Interactive API with gitlab
Impact of non completion
No one will understand how it works.