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

REST endpoints documentation #806

Open
andreasciamanna opened this issue Aug 30, 2024 · 1 comment
Open

REST endpoints documentation #806

andreasciamanna opened this issue Aug 30, 2024 · 1 comment

Comments

@andreasciamanna
Copy link

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
Copy link
Owner

felixmosh commented Aug 30, 2024

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.

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