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.

Sign up for GitHub

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

Jump to bottom

Finish API documentation. #63

Open

4 tasks

kfogel opened this issue Jun 20, 2016 · 0 comments

Member

kfogel commented Jun 20, 2016 •

edited

Loading

Various parts of the API documentation need completing:

The section "Top-level resources" had a note saying "TODO: All endpoints are now top-level. This section may need more changes to reflect that." Specifically, there's no documentation yet for the endpoints for Organizations and Projects.
Many of the endpoint summaries have an empty "Example:" field.
Many of the endpoint summaries have an empty "Parameters:" field.
We should give an example of a real error.

kfogel added a commit that referenced this issue


          Move TODO note from API.md to issue #63

cb0ab56

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment