search

felixmosh / bull-board

🎯 Queue background jobs inspector
MIT License
2.36k stars 366 forks source link

REST endpoints documentation #806

Open andreasciamanna opened 2 months ago

andreasciamanna commented 2 months ago

Hi!

I'm using Bull-board on a NestJS (mono repo) project, in its dedicated sub-app for monitoring the queue.

It works just fine for my needs.

However, while debugging some problems with the queue, I realized that bull-board defines and uses several REST endpoints to interact with it.

Obviously, by inspecting the requests and looking at the routes definitions, I can infer most of the specs, but I wonder if there is actual documentation of these endpoints: I couldn't find it anywhere.

felixmosh commented 2 months ago

Hi, we don't have any documentation for that api, you can inspect the routes in the api package.

Feel free to make a PR for it.