Skip to content

PEP 792: clarify index API changes #4457

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
hugovk merged 1 commit into from
Jun 13, 2025
Merged

PEP 792: clarify index API changes #4457

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
13 changes: 9 additions & 4 deletions peps/pep-0792.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,14 +178,19 @@ Status markers in the index APIs

This PEP defines version 1.4 of the index APIs.

All changes to the HTML and JSON simple indices below occur at the
per-project level, i.e. within each project's index response, rather than
the root index response. No root index response changes are proposed by this
PEP.

HTML index
~~~~~~~~~~

The following changes are made to the
:ref:`simple repository API <packaging:simple-repository-api-base>`:

* The index **SHALL** define the ``pypi:repository-version`` as ``1.4``.
* The index **SHOULD** add an appropriate ``pypi:project-status`` meta tag, with
* The per-project index **SHALL** define the ``pypi:repository-version`` as ``1.4``.
* The per-project index **SHOULD** add an appropriate ``pypi:project-status`` meta tag, with
a ``content`` of the project's status marker. The index **MAY** choose to omit
the ``pypi:project-status`` meta tag if the project is marked as ``active``.

Expand Down Expand Up @@ -216,8 +221,8 @@ JSON index
The following changes are made to the
:ref:`JSON simple index <packaging:simple-repository-api-json>`:

* The index **SHALL** define the ``meta.api-version`` as ``1.4``.
* The index **SHOULD** include a ``project-status`` key in the JSON response,
* The per-project index **SHALL** define the ``meta.api-version`` as ``1.4``.
* The per-project index **SHOULD** include a ``project-status`` key in the JSON response,
with a value of the project's status marker. The index **MAY** choose to omit
the ``project-status`` key if the project is marked as ``active``.

Expand Down