Skip to content

Commit 69f6dcc

Browse files
authored
Merge pull request #2066 from woodruffw-forks/ww/833
Add a PEP 833 callout to the simple API spec
2 parents c31a69a + 9a9aca9 commit 69f6dcc

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎source/specifications/simple-repository-api.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,15 @@ HTML Serialization
122122

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

125+
.. important::
126+
127+
The HTML representation is considered "frozen" and is not expected
128+
to be updated. Producers and consumers of the simple API
129+
should prefer the :ref:`JSON representation <json-serialization>`.
130+
131+
See :pep:`833` for additional information about the HTML representation's
132+
status.
133+
125134
The following constraints apply to all HTML serialized responses described in
126135
this spec:
127136

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

0 commit comments

Comments
 (0)