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

API-Docs: query/updates #242

Open
Sir-Photch opened this issue Feb 25, 2023 · 2 comments
Open

API-Docs: query/updates #242

Sir-Photch opened this issue Feb 25, 2023 · 2 comments

Comments

@Sir-Photch
Copy link
Contributor

Sir-Photch commented Feb 25, 2023

Hi, I was just noticing that the swagger-api does not mention the query/updates endpoint. Mind adding that?

@hyperblast
Copy link
Owner

hyperblast commented Feb 25, 2023

Hi,

last time I checked Swagger/OpenAPI didn't support server sent events.

/api/query/updates is the same as /api/query, but returns text/event-stream.

An event is sent every time something is changed.

Each event is structured exactly like /api/query response.

player, playlists, playlistItems updates might be sent in a single or in multiple events.

If only player part is changed it won't send playlists and so on.

Periodically server sends empty event to keep connection alive.

@Sir-Photch
Copy link
Contributor Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants