Skip to content

Document APIs #2992

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

Merged
merged 5 commits into from
Feb 20, 2018
Merged

Document APIs #2992

merged 5 commits into from
Feb 20, 2018

Conversation

di
Copy link
Member

@di di commented Feb 20, 2018

Fixes #2930, fixes #2913, closes #1721.

Copy link
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, thanks, looks great!

.. http:get:: /pypi/<project_name>/json

Returns metadata (info) about an individual project at the latest version,
a list of all releases for that project, and project urls. Releases include
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: "project URLs".

}
}

:statuscode 200: no error
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A user who's new to using this API might want guidance on the version number chunk of this. I infer that, in this response, within releases, each key is a version number, which is a string. Could we explicitly say that?

@brainwane brainwane mentioned this pull request Feb 20, 2018
@di di merged commit 5a90b59 into master Feb 20, 2018
@di di deleted the document-apis branch February 20, 2018 16:07
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

Successfully merging this pull request may close these issues.

Explain/expand list of current API endpoints/feeds Additional API documentation
2 participants