8000 Meta: Document the PEPs API by hugovk · Pull Request #3864 · python/peps · GitHub
[go: up one dir, main page]
Skip to content

Meta: Document the PEPs API #3864

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
merged 9 commits into from
Jul 17, 2024
Merged

Meta: Document the PEPs API #3864

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8e5eba6
Document the PEPs API
hugovk Jul 14, 2024
74d5214
Format conf.py with Black
hugovk Jul 14, 2024
2b110f3
fixup! Document the PEPs API
hugovk Jul 14, 2024
9376788
fixup! Document the PEPs API
hugovk Jul 14, 2024
8a4e1cc
Revert "fixup! Document the PEPs API"
hugovk Jul 14, 2024
7cf4fa5
Use PEPs 8, 484 and 622 as representative examples
hugovk Jul 15, 2024
94daba8
Add a pseudo-schema
hugovk Jul 16, 2024
d3d3075
Add missing bracket, fix typo
hugovk Jul 16, 2024
d393bbc
Mark pseudo-JSON as JavaScript so it can be parsed by Sphinx
hugovk Jul 16, 2024
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
Add a pseudo-schema 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
  • Loading branch information
@hugovk @AA-Turner
hugovk and AA-Turner authored Jul 16, 2024
commit 94daba8d084549611eaa8880197482cdafdac089
26 changes: 26 additions & 0 deletions peps/api/index.rst
View file
Open in desktop
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
Loading
0