Infra: only create peps.json at /api/peps.json

[hugovk]

Re: https://github.com/python/peps/issues/2584#issuecomment-1758957285

The API should only be available at https://peps.python.org/api/peps.json and not the root https://peps.python.org/peps.json.

We advertise https://peps.python.org/api/peps.json at https://peps.python.org/#api and https://peps.python.org/api/, and a GitHub code search only shows this one in use and not the incorrect one.

---

📚 Documentation preview 📚: https://pep-previews--4231.org.readthedocs.build/

[AA-Turner]

'Fixed a bug by removing the feature', you might say!

I think the converse is true here, peps.json isn't really an 'API', but just a document listing the metadata from the PEP headers in a slightly easier to use format than RFC (2)822 email headers. As such I think it has better symmetry with peps.rss, which is also at the root. It does no harm to keep both, and I think we should resolve the fact that one isn't documented.

A

[hugovk]

'Fixed a bug by removing the feature', you might say!

:)

Well, this bug/feature was added in a large-ish refactoring PR (https://github.com/python/peps/pull/3417) which made no mention of the addition in the description, and was merged 10 minutes later with no review.

I only realised this duplicate endpoint existed when https://github.com/python/peps/pull/4226 was opened yesterday, and would have objected to the addition at the time, as we had a long discussion at https://github.com/python/peps/issues/2584 about whether to move it to the root, and in the end decided not to.

I think the converse is true here, peps.json isn't really an 'API', but just a document listing the metadata from the PEP headers in a slightly easier to use format than RFC (2)822 email headers. As such I think it has better symmetry with peps.rss, which is also at the root.

I see it as a simple read-only JSON API, much like https://endoflife.date/docs/api, https://swapi.dev and https://open-meteo.com.

It does no harm to keep both, and I think we should resolve the fact that one isn't documented.

I think it can cause confusion to have two copies. Are they different? Will one go away? If we change one, will the other also change? If we start versioning it, do we need to add another duplicate to the root? Or if we expose JSON for each individual PEP, do they all go to the root?