Skip to content

simple-repository-api: bump, explain api-version #1803

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.

Sign up for GitHub

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 1 commit into from
Feb 6, 2025
Merged

simple-repository-api: bump, explain api-version #1803

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions source/specifications/simple-repository-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ In addition to the above, the following constraints are placed on the API:
the file's provenance can be found at that URL. This URL **MUST** represent
a `secure origin <https://www.chromium.org/Home/chromium-security/prefer-secure-origins-for-powerful-new-features/>`_.

.. note::

The ``data-provenance`` attribute was added with API version 1.3.

.. note::

The format of the linked provenance is defined in :ref:`index-hosted-attestations`.
Expand Down Expand Up @@ -213,7 +217,7 @@ specification <version-specifiers>`.

This would end up looking like::

<meta name="pypi:repository-version" content="1.0">
<meta name="pypi:repository-version" content="1.3">

When interpreting the repository version:

Expand Down Expand Up @@ -405,7 +409,7 @@ As an example:

{
"meta": {
"api-version": "1.0"
"api-version": "1.3"
},
"projects": [
{"name": "Frob"},
Expand Down Expand Up @@ -509,13 +513,17 @@ Each individual file dictionary has the following keys:
associated provenance, with the same rules as ``data-provenance`` in the
:ref:`base HTML API specification <simple-repository-api-base>`.

.. note::

The ``provenance`` field was added with API version 1.3.

As an example:

.. code-block:: json

{
"meta": {
"api-version": "1.0"
"api-version": "1.3"
},
"name": "holygrail",
"files": [
Expand Down