Skip to content

Conversation

@woodruffw
Copy link
Member

@woodruffw woodruffw commented Feb 4, 2025

See discussion in https://discuss.python.org/t/does-the-simple-repository-api-version-1-3-exist/79361 -- this updates the living index API spec to correctly reflect the latest API version (1.3), as well as add some callouts for the fields that make a response look like a 1.3 response (namely, provenance).

CC @di @brettcannon


📚 Documentation preview 📚: https://python-packaging-user-guide--1803.org.readthedocs.build/en/1803/

@woodruffw
Copy link
Member Author

NB: I didn't change it with this PR, but another possible improvement to this document is removing the "Additional Fields for the Simple API for Package Indexes" section and folding its contents into the relevant HTML/JSON sections, as needed. That should further reduce confusion, as that's the only section that mentions version 1.1 of the API.

(Another possible improvement is adding a "Version History" section, or maybe repurposing the "History" section to make the API version changes more explicit.)

@brettcannon
Copy link
Member

another possible improvement to this document is removing the "Additional Fields for the Simple API for Package Indexes" section and folding its contents into the relevant HTML/JSON sections, as needed.

Yeah, probably being more explicit about what each version added would be good.

Another possible improvement is adding a "Version History" section

👍

@woodruffw
Copy link
Member Author

Cool, I'll do that in a follow-up to keep things small here 🙂

@di
Copy link
Member

di commented Feb 4, 2025

(Approved but I am not actually an editor here, we will need one of @pypa/packaging-user-guide-editors to approve as well)

@di di requested a review from a team February 4, 2025 20:34
@woodruffw
Copy link
Member Author

Gentle ping for merge now that this has been approved by @pypa/packaging-user-guide-editors!

@willingc willingc added this pull request to the merge queue Feb 6, 2025
Merged via the queue into pypa:main with commit 83103b2 Feb 6, 2025
8 checks passed
@woodruffw woodruffw deleted the ww/bump-versions branch February 6, 2025 18:21
@woodruffw
Copy link
Member Author

Cool, I'll do that in a follow-up to keep things small here 🙂

Opened #1808 as the follow-up! There's even more I could do but I'm trying to keep each PR somewhat small for easy review.

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.

5 participants