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

Add API documentation #10

Open
jelly opened this issue Apr 24, 2020 · 2 comments
Open

Add API documentation #10

jelly opened this issue Apr 24, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@jelly
Copy link
Contributor

jelly commented Apr 24, 2020

To easily create integrations with rebuilderd it would be nice if the API endpoints would be documented and available somewhere.

@jelly
Copy link
Contributor Author

jelly commented Apr 24, 2020

I'd love to help out here, do you want them documented and do you have a preferred way to document them?

@kpcyrd
Copy link
Owner

kpcyrd commented Apr 26, 2020

The routes are defined here: https://github.com/kpcyrd/rebuilderd/blob/master/daemon/src/api.rs

#[get("/api/v0/workers")]
#[post("/api/v0/job/sync")]
#[get("/api/v0/pkgs/list")]
#[post("/api/v0/queue/list")]
#[post("/api/v0/queue/push")]
#[post("/api/v0/queue/pop")]
#[post("/api/v0/queue/drop")]
#[post("/api/v0/build/ping")]
#[post("/api/v0/build/report")]

The struct to requests/responses are defined at the bottom of this file: https://github.com/kpcyrd/rebuilderd/blob/master/common/src/api.rs

I don't have preferences about the format to document this, any ideas?

@kpcyrd kpcyrd added the enhancement New feature or request label Dec 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants