Skip to content

Automatically generated endpoint documentation #731

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

Closed
phrohdoh opened this issue May 19, 2017 · 4 comments
Closed

Automatically generated endpoint documentation #731

phrohdoh opened this issue May 19, 2017 · 4 comments
Labels
A-backend ⚙️ C-documentation 📜 Category: Documentation of crates.io itself E-help-wanted

Comments

@phrohdoh
Copy link
Contributor

I did some digging but could not find docs for crates.io endpoints for tool authors.

Swagger is pretty popular these days (not sure how long that will be true, though).

If this exists already and I missed it please link to it here and feel free to close this ticket.

@carols10cents
Copy link
Member

It does not exist and this is a good idea!

@carols10cents carols10cents added A-API C-documentation 📜 Category: Documentation of crates.io itself E-help-wanted C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works labels May 19, 2017
@Turbo87 Turbo87 removed the C-enhancement ✨ Category: Adding new behavior or a change to the way an existing feature works label Mar 11, 2021
@shellscape
Copy link

Checking in on this long-dormant issue. I did some poking around, and while there is some documentation on the book, some of the information on return values don't match the API any longer, and it's not very complete. Any chance of this effort getting a revival?

@carols10cents
Copy link
Member

It'd be great if you revive effort on this!

@Turbo87
Copy link
Member

Turbo87 commented Jun 19, 2022

closing this in favor of #741

@Turbo87 Turbo87 closed this as not planned Won't fix, can't repro, duplicate, stale Jun 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-backend ⚙️ C-documentation 📜 Category: Documentation of crates.io itself E-help-wanted
Projects
None yet
Development

No branches or pull requests

5 participants
@shellscape @Turbo87 @carols10cents @phrohdoh and others