Skip to content

Commit

Permalink
Add a pseudo-schema
Browse files Browse the repository at this point in the history
Co-authored-by: Adam Turner <[email protected]>
  • Loading branch information
hugovk and AA-Turner authored Jul 16, 2024
1 parent 7cf4fa5 commit 94daba8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions peps/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ There is a read-only API of published PEPs available at:

The structure is like:

.. code-block:: json
{
"<PEP number>": {
"number": integer,
"title": string,
"authors": string,
"discussions_to": string | null,
"status": "Accepted" | "Active" | "Deferred" | "Draft" | "Final" | "Provisional" | "Rejected" | "Superseded" | "Withdrawn",
"type": "Informational" | "Process" | "Standards Track",
"topic": "governance" | "packaging" | "release" | "typing" | "",
"created": string,
"python_version": string | null,
"post_history": string,
"resolution": string | null,
"requires": string | null,
"replaces": string | null,
"superseded_by": string | null,
"url": string
},
Date values are formatted as DD-MMM-YYYY,
and multiple dates are combied in a comma-separated list.
For example:
.. code-block:: json
{
Expand Down

0 comments on commit 94daba8

Please sign in to comment.