Skip to content

Update documentation for PEP 691 #14644

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
gsnedders opened this issue Sep 27, 2023 · 1 comment
Closed

Update documentation for PEP 691 #14644

gsnedders opened this issue Sep 27, 2023 · 1 comment

Comments

@gsnedders
Copy link

Describe the bug
The documentation claims the simple API is legacy (c.f. https://warehouse.pypa.io/api-reference/legacy.html)

Expected behavior
The documentation matches the implementation, which no longer considers the simple API as legacy (c.f. #11676). Additionally, it should document the PEP 691 implementation, rather than pushing people to use the (non-standard?) legacy JSON API.

To Reproduce
Load the documentation.

My Platform
N/A

Additional context

@gsnedders gsnedders added bug 🐛 requires triaging maintainers need to do initial inspection of issue labels Sep 27, 2023
@di di added documentation and removed requires triaging maintainers need to do initial inspection of issue labels Oct 9, 2023
@woodruffw
Copy link
Member

#16541 should address this: we now consistently refer to the 503/691 APIs as the "Index APIs" or "simple APIs."

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

No branches or pull requests

4 participants
@gsnedders @di @woodruffw and others