PEP 740: add provenance to simple API #16801
Conversation
The latest PEP 740 language doesn't include this, so we don't need it. Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Broken out from pypi#16624. Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
woodruffw
force-pushed
the
ww/pep740-simple-api
branch
from
b7ee6a4
to
7993e2d
Compare
Signed-off-by: William Woodruff <[email protected]>
There was a problem hiding this comment.
I've read through once or twice, and added some comments inline.
I'm still unfamiliar with some of these, and would want to spend a bit more time on checking the performance of the changes to the /simple/ endpoints, since those get relatively highly trafficked.
| @@ -22,7 +22,7 @@ | |||
| from warehouse.packaging.interfaces import ISimpleStorage | |||
| from warehouse.packaging.models import File, LifecycleStatus, Project, Release | |||
|
|
|||
| API_VERSION = "1.2" | |||
| API_VERSION = "1.3" | |||
There was a problem hiding this comment.
I don't know enough yet about incrementing this value and what that does.
There was a problem hiding this comment.
This comes from the PEP itself:
The api-version SHALL specify version 1.3 or later.
(Via https://peps.python.org/pep-0740/#json-based-simple-api)
In this context, all incrementing it does is signal to a client that the index is now serving PEP 740 objects. Clients are expected to handle this gracefully, since api-version is intended to be a semantic version.
(I can find a cite for that last claim if you'd like, although I'd have to go digging. But for context, this was just bumped a few weeks ago from 1.1 to 1.2 with no client breakage due to PEP 708.)
Co-authored-by: Mike Fiedler <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: Mike Fiedler <[email protected]>
This adds the final part of surfacing PEP 740: it connects the persisted provenance to the simple HTML and JSON APIs, and bumps the API version in the process.
This is currently branched off of #16778, so I'm leaving this as a draft until that's merged.Supersedes #16624.