Skip to content

Add a PEP 833 callout to the simple API spec #2066

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

Open
woodruffw wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a PEP 833 callout to the simple API spec #2066

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6bc3430
Add a PEP 833 callout to the simple API spec
woodruffw Jun 2, 2026
9a9aca9
Fix EOF
woodruffw Jun 2, 2026
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
10 changes: 10 additions & 0 deletions source/specifications/simple-repository-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,15 @@ HTML Serialization

.. _simple-repository-html-project-list:

.. important::

The HTML representation is considered "frozen" and is not expected
to be updated. Producers and consumers of the simple API
should prefer the :ref:`JSON representation <json-serialization>`.

See :pep:`833` for additional information about the HTML representation's
status.

The following constraints apply to all HTML serialized responses described in
this spec:

Expand Down Expand Up @@ -989,3 +998,4 @@ History
* November 2024: provenance metadata in the HTML and JSON formats, in :pep:`740`
* July 2025: project status markers in the HTML and JSON formats, in :pep:`792`
* July 2025: layout changes (dedicated page for file yanking, introduce concepts before API details)
* June 2026: :pep:`833` formally "freezes" the HTML representation of the simple API