Skip to content

Commit 5dd9452

Browse files
authored
PEP-0691 Gramatical changes + meta key description under Project List (#2677)
* Grammer fixes and TODO's * Added missing meta key to Project List description
1 parent c4ec86f commit 5dd9452

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

pep-0691.rst

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ did not propose any large changes to the API.
5151

5252
In the intervening years, we've regularly talked about an "API V2" that would
5353
re-envision the entire API of PyPI. However, due to limited time constraints,
54-
that effort has not gained much, if, any traction beyond people thinking that
54+
that effort has not gained much, if any, traction beyond people thinking that
5555
it would be nice to do.
5656

5757
This PEP attempts to take a different route. It doesn't fundamentally change
@@ -99,7 +99,7 @@ Goals
9999
Specification
100100
=============
101101

102-
To enable parsing responses with only the standard library, this PEP specifies that
102+
To enable response parsing with only the standard library, this PEP specifies that
103103
all responses (besides the files themselves, and the HTML responses from
104104
:pep:`503`) should be serialized using `JSON <https://www.json.org/>`_.
105105

@@ -122,7 +122,7 @@ Similar to :pep:`629`, the major version number **MUST** be incremented if any
122122
changes to the new format would result in no longer being able to expect existing
123123
clients to meaningfully understand the format.
124124

125-
Likewise, incrementing the minor version **MUST** be incremented if features are
125+
Likewise, the minor version **MUST** be incremented if features are
126126
added or removed from the format, but existing clients would be expected to continue
127127
to meaningfully understand the format.
128128

@@ -172,7 +172,7 @@ PEP:
172172

173173
* All JSON responses will have a ``meta.api-version`` key, which will be a string that
174174
contains the :pep:`629` ``Major.Minor`` version number, with the same fail/warn
175-
semantics as in :pep:`629`.
175+
semantics as defined in :pep:`629`.
176176

177177
* All requirements of :pep:`503` that are not HTML specific still apply.
178178

@@ -181,9 +181,11 @@ Project List
181181
~~~~~~~~~~~~
182182

183183
The root URL ``/`` for this PEP (which represents the base URL) will be a JSON encoded
184-
dictionary which has a single key, ``projects``, which is an array where each entry
185-
is a dictionary with a single key, ``name``, which represents string of the project
186-
name. As an example:
184+
dictionary which has a two keys:
185+
- ``projects``: An array where each entry is a dictionary with a single key, ``name``, which represents string of the project name.
186+
- ``meta``: The general response metadata as `described earlier <json-serialization_>`__.
187+
188+
As an example:
187189

188190
.. code-block:: json
189191
@@ -355,8 +357,8 @@ Version + Format Selection
355357
--------------------------
356358

357359
Now that there is multiple possible serializations, we need a mechanism to allow
358-
clients to indicate what serialization formats that they're able to understand. In
359-
addition, it would be a benefit if any possible new major version to the API can
360+
clients to indicate what serialization formats they're able to understand. In
361+
addition, it would be beneficial if any possible new major version to the API can
360362
be added without disrupting existing clients expecting the previous API version.
361363

362364
To enable this, this PEP standardizes on the use of HTTP's
@@ -512,7 +514,8 @@ Servers that implement the Simple API may choose to support an URL parameter nam
512514
``format`` to allow the clients to request a specific version of the URL.
513515

514516
The value of the ``format`` parameter should be **one** of the valid content types.
515-
Passing multiple content types, wild cards, quality values, etc is **not** supported.
517+
Passing multiple content types, wild cards, quality values, etc... is **not**
518+
supported.
516519

517520
Supporting this parameter is optional, and clients **SHOULD NOT** rely on it for
518521
interacting with the API. This negotiation mechanism is intended to allow for easier
@@ -587,7 +590,7 @@ modified to include the API version and serialization format using something lik
587590
``simple/PROJECT/vnd.pypi.simple.v1.json``.
588591

589592
In this case, since ``text/html`` is an alias to ``application/vnd.pypi.simple.v1+html``
590-
when interacting through TUF, likely it will make the most sense to normalize to the
593+
when interacting through TUF, it likely will make the most sense to normalize to the
591594
more explicit name.
592595

593596
Likewise the ``latest`` metaversion should not be included in the targets, only

0 commit comments

Comments
 (0)