pypi / warehouse

The Python Package Index
https://pypi.org
Apache License 2.0
3.58k stars 964 forks source link

JSON API Reference is missing information on metadata 2.2 and 2.3 fields #16190

Closed dralley closed 1 month ago

dralley commented 3 months ago

Describe the bug

This JSON API reference: https://github.com/pypi/warehouse/blob/main/docs/dev/api-reference/json.rst

Is missing documentation on the "dynamic" and "provides_extra" fields, added in versions 2.2 and 2.3 of the core metadata specification (https://packaging.python.org/en/latest/specifications/core-metadata/).

The example output shown in the reference is missing them entirely, yet they can currently be seen if you query the JSON API.

Expected behavior API reference should include these fields

dralley commented 3 months ago

@konstin re: https://github.com/pypi/warehouse/pull/13606

di commented 3 months ago

Thanks! I've added the "Good First Issue" label to this issue.

dralley commented 3 months ago

Perchance could you comment here w/ what those fields look like when populated (or point to a package where they are not null, I had trouble finding one)

di commented 3 months ago

Here's a random example with provides_extra: https://pypi.org/pypi/mvmlib/0.5.10/json

Here's one with dynamic: https://pypi.org/pypi/jupyterlab-amphi/0.2.1/json

I would recommend reading https://peps.python.org/pep-0643/ and https://peps.python.org/pep-0685/ for more details.

dralley commented 3 months ago

Thanks!

I had previously seen the PEPs, but they do not specify how PyPI presents those fields.

samjove commented 2 months ago

Working on this