Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document WebSocket API with AsyncAPI #184

Open
caspiano opened this issue Sep 10, 2021 · 0 comments
Open

Document WebSocket API with AsyncAPI #184

caspiano opened this issue Sep 10, 2021 · 0 comments
Labels
type: documentation improvements or additions to documentation

Comments

@caspiano
Copy link
Contributor

Is your feature request related to a problem? Please describe.

The PlaceOS REST API will eventually have complete OpenAPI coverage.
See here PlaceOS/PlaceOS#46

The equivalent for stream-based interfaces is AsyncAPI.

Describe the solution you'd like

Define the AsyncAPI specification of the PlaceOS WebSocket API

Describe alternatives you've considered

A JSON-RPC interface for the WebSocket API #138
@caspiano caspiano transferred this issue from PlaceOS/PlaceOS Sep 16, 2021
@caspiano caspiano added the type: documentation improvements or additions to documentation label Nov 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: documentation improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@caspiano