API docs: http status codes

librariesio / libraries.io

:books: The Open Source Discovery Service

https://libraries.io

GNU Affero General Public License v3.0

1.11k stars 203 forks source link

API docs: http status codes #1245

Open hackebrot opened 7 years ago

hackebrot commented 7 years ago

Hey! 👋

Thank you for making libraries.io 😄

It would be great to state expected http status codes for API endpoints (see GitHub API docs). This would be very useful for people, who develop API client libraries and would like to either deserialize models or return an error.

Related to #198

andrew commented 7 years ago

Agreed, the API documentation needs a big overhaul, this would be a great addition, plus explaining some of the potential error codes and what they mean