flower icon indicating copy to clipboard operation
flower copied to clipboard

Lack of Websocket API Documentation

Open bijenkins opened this issue 9 years ago • 9 comments

I've searched the source and I see the ability to use Websockets, and even noticed the example in the readme, which shows a very basic client example. Is there any documentation surrounding the Websocket API? There is a entire page on just the restful api, but searching the RTD; websocket is not even mentioned.

bijenkins avatar Oct 21 '15 17:10 bijenkins

me too

acodercat avatar Jun 09 '20 02:06 acodercat

+1

soer7022 avatar Jul 06 '20 12:07 soer7022

I'm gonna try out an old project: WSCelery

soer7022 avatar Jul 13 '20 11:07 soer7022

+1

bobycloud avatar Sep 21 '20 11:09 bobycloud

Maybe the response comes a bit late, but for those still looking for the hidden flower's websockets here's something useful. Digging in the source code, i finally managed to found the wss endpoints:

  • /api/task/events/task-succeeded/
  • /api/task/events/task-sent/
  • api/task/events/task-received/
  • /api/task/events/task-started/
  • /api/task/events/task-failed/
  • /api/task/events/task-revoked/
  • /api/task/events/task-retried/
  • /api/task/events/task-custom/

akanoce avatar Nov 01 '21 17:11 akanoce

+1. why there is no documentation about WebSockets?

daveflr avatar Jan 21 '22 19:01 daveflr

I think the /api/task/events API was removed recently.

jreed1701 avatar Jul 10 '22 22:07 jreed1701

yup, webSockets API was completely deprecated in 1.1.0

daveflr avatar Jul 11 '22 22:07 daveflr

Might as well close this issue then since no more websockets? I'll just lock to flower 1.0 to keep it. Thanks!

jreed1701 avatar Jul 17 '22 23:07 jreed1701

Might as well close this issue then since no more websockets? I'll just lock to flower 1.0 to keep it. Thanks!

No, please don't close.

A long used functionality has been removed all of a sudden (even though the commit comment says "deprecate"). Deprecating something means: Mark it for removal in a LATER version while giving users a chance to migrate. This all didn't happen here, so the only viable solution is to add it back in.

Furthermore, the project has no changelog where users could have found information about the removal, and what to do/use instead.

dhs-rec avatar Nov 30 '22 07:11 dhs-rec

yup, webSockets API was completely deprecated in 1.1.0

Nope, it wasn't deprecated, it was silently REMOVED.

dhs-rec avatar Nov 30 '22 07:11 dhs-rec