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

Explain/expand list of current API endpoints/feeds #2930

Closed
brainwane opened this issue Feb 12, 2018 · 2 comments · Fixed by #2992
Closed

Explain/expand list of current API endpoints/feeds #2930

brainwane opened this issue Feb 12, 2018 · 2 comments · Fixed by #2992
Assignees
Labels
APIs/feeds documentation help needed We'd love volunteers to advise on or help fix/implement this.

Comments

@brainwane
Copy link
Contributor

https://warehouse.readthedocs.io/api-reference/ (built from docs/api-reference/) should:

  • explain, with a little bit more detail, why we call the Simple Project API part of the "legacy API"
  • point to pypi.org, not pypi.python.org, in code examples
  • mention our RSS feed(s)
  • mention any other endpoints we currently offer, such as the JSON feed (Create json.rst #1721 will do part of this)
@brainwane brainwane added documentation help needed We'd love volunteers to advise on or help fix/implement this. APIs/feeds labels Feb 12, 2018
@brainwane
Copy link
Contributor Author

I decided that we ought to do this by End User MVP; accurately listing the projects endpoint, the releases endpoint, and other endpoints and feeds we currently serve strikes me as MVP for our end users.

@brainwane
Copy link
Contributor Author

@di I just realized that the new documentation does not actually mention anywhere the upload endpoint https://upload.pypi.org/legacy/ and I think we should add at least a sentence about it and a pointer to the packaging.python.org tutorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
APIs/feeds documentation help needed We'd love volunteers to advise on or help fix/implement this.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants