Skip to content

PEP691: Switch to a List for Project, Address more Feedback #2653

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
dstufft merged 7 commits into from
Jun 17, 2022
Merged

PEP691: Switch to a List for Project, Address more Feedback #2653

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cb73180
Clarify that No Accept equals Accept: */*
dstufft Jun 17, 2022
bbc8583
Clarification + Move Index to an array
dstufft Jun 17, 2022
e940b0c
Add the underlying data models for the Simple API
dstufft Jun 17, 2022
ca081aa
whitespace
dstufft Jun 17, 2022
7c996e6
Add a FAQ about versioning
dstufft Jun 17, 2022
a81ea27
Better phrasing
dstufft Jun 17, 2022
b8e887d
Spelling
dstufft Jun 17, 2022
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
Prev Previous commit
Next Next commit
Clarification + Move Index to an array
  • Loading branch information
@dstufft
dstufft committed Jun 17, 2022
commit bbc85839661e1c42c284f300ce1f91b7b1ce86b0
44 changes: 35 additions & 9 deletions pep-0691.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are two major issues with an HTML-based API:
fully support HTML5.

- HTML5 is primarily designed as a markup language to present documents for human
consumption. Our use of it is driven largely for historical reasons and accidental
consumption. Our use of it is driven largely for historical and accidental
reasons, and it's unlikely anyone would design an API that relied on it if
they were starting from scratch.

Expand Down Expand Up @@ -178,24 +178,41 @@ Project List
~~~~~~~~~~~~

The root URL ``/`` for this PEP (which represents the base URL) will be a JSON encoded
dictionary which has a single key, ``projects``, which is itself a dictionary where each
key is a string of the normalized project name, and the value is a dictionary with a
single key, ``url``, which represents the URL that the project can be fetched from. As
an example:
dictionary which has a single key, ``projects``, which is an array where each entry
is a dictionary with a single key, ``name``, which represents string of the project
name. As an example:

.. code-block:: json

{
"meta": {
"api-version": "1.0"
},
"projects": {
"frob": {"url": "/frob/"},
"spamspamspam": {"url": "/spamspamspam/"}
}
"projects": [
{"name": "Frob"},
{"name": "spamspamspam"},
]
}


.. note::

The ``name`` field is the same as the one from :pep:`503`, which does not specify
whether it is the non-normalized display name or the normalized name. In practice
different implementations of these PEPs are choosing differently here, so relying
on it being either non-normalized or normalized is relying on an implementation
detail of the repository in question.


.. note::

While the ``projects`` key is an array, and thus is required to be in some kind
of an order, neither :pep:`503` nor this PEP requires any specific ordering nor
that the ordering is consistent from one request to the next. Mentally this is
best thought of as a set, but both JSON and HTML lack the functionality to have
sets.


Project Detail
~~~~~~~~~~~~~~

Expand Down Expand Up @@ -286,6 +303,15 @@ As an example:
}


.. note::

While the ``files`` key is an array, and thus is required to be in some kind
of an order, neither :pep:`503` nor this PEP requires any specific ordering nor
that the ordering is consistent from one request to the next. Mentally this is
best thought of as a set, but both JSON and HTML lack the functionality to have
sets.


Content-Types
-------------

Expand Down