From 63f78e22291fb51b12312605fd4914b0d38bd4d3 Mon Sep 17 00:00:00 2001 From: William Woodruff Date: Tue, 10 Jun 2025 16:11:01 -0400 Subject: [PATCH] PEP 792: clarify index API changes Signed-off-by: William Woodruff --- peps/pep-0792.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/peps/pep-0792.rst b/peps/pep-0792.rst index 89dd2814ad0..04f7b737254 100644 --- a/peps/pep-0792.rst +++ b/peps/pep-0792.rst @@ -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 `: -* 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``. @@ -216,8 +221,8 @@ JSON index The following changes are made to the :ref:`JSON simple index `: -* 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``.