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.

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

Document ESS endpoints #1

Closed
leonhard-s opened this issue Mar 5, 2023 · 2 comments
Closed

Document ESS endpoints #1

leonhard-s opened this issue Mar 5, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request web socket Related to the ESS endpoint

Comments

@leonhard-s
Copy link
Owner

OpenAPI is still primarily targeting REST APIs, and support for WebSocket or other streaming protocols seems an open issue that may never get first-class treatment.

A workaround for us would be to instead model these via a REST endpoint at push.planetside2.com/streaming, and faking the actual responses through POST/GET messages, with a big blinking "this is just a dummy" light flashing on top.

Alternatively, we could create and maintain a separate AsyncAPI spec that is able to model WebSocket subscriptions and messages correctly.

@leonhard-s leonhard-s added documentation Improvements or additions to documentation enhancement New feature or request web socket Related to the ESS endpoint and removed documentation Improvements or additions to documentation labels Mar 5, 2023
@leonhard-s
Copy link
Owner Author

This project is very close to what I envisioned: https://jhett12321.github.io/EventTrackerDocs/
Judging from the (now expired) domain, I believe this to be the (now archived) repository related to these docs: https://github.com/jhett12321/Planetside-2-Extended-Websocket-API

@leonhard-s leonhard-s self-assigned this Jan 27, 2024
@leonhard-s
Copy link
Owner Author

leonhard-s commented Feb 4, 2024

A self-contained version of the WebSocket endpoint now lives in its own repository, including an HTML deployment via GitHub pages: https://github.com/leonhard-s/ps2-ess-api

Closing this issue as done; combining the two repositories is on the road map (

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request web socket Related to the ESS endpoint
Projects
None yet
Development

No branches or pull requests

1 participant