Skip to content

Commit 15bd7d5

Browse files
authored
PEP 792: clarify index API changes (#4457)
1 parent 145091a commit 15bd7d5

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

peps/pep-0792.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,14 +178,19 @@ Status markers in the index APIs
178178

179179
This PEP defines version 1.4 of the index APIs.
180180

181+
All changes to the HTML and JSON simple indices below occur at the
182+
per-project level, i.e. within each project's index response, rather than
183+
the root index response. No root index response changes are proposed by this
184+
PEP.
185+
181186
HTML index
182187
~~~~~~~~~~
183188

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

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

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

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

0 commit comments

Comments
 (0)