diff --git a/peps/api/index.rst b/peps/api/index.rst index f649c23800c..6750219b02e 100644 --- a/peps/api/index.rst +++ b/peps/api/index.rst @@ -7,6 +7,32 @@ There is a read-only API of published PEPs available at: The structure is like: +.. code-block:: json + + { + "": { + "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 {