Skip to content
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.

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

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

Closed
dralley opened this issue Jun 30, 2024 · 6 comments · Fixed by #16388
Closed

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

dralley opened this issue Jun 30, 2024 · 6 comments · Fixed by #16388
Labels
bug 🐛 good first issue This issue is ideal for first-time contributors!

Comments

@dralley
Copy link

dralley commented Jun 30, 2024

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
Copy link
Author

dralley commented Jun 30, 2024

@konstin re: #13606

@di di added good first issue This issue is ideal for first-time contributors! and removed requires triaging maintainers need to do initial inspection of issue labels Jul 3, 2024
@di
Copy link
Member

di commented Jul 3, 2024

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

@dralley
Copy link
Author

dralley commented Jul 3, 2024

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
Copy link
Member

di commented Jul 5, 2024

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
Copy link
Author

dralley commented Jul 5, 2024

Thanks!

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

@samjove
Copy link
Contributor

samjove commented Aug 2, 2024

Working on this

samjove pushed a commit to samjove/warehouse that referenced this issue Aug 2, 2024
samjove pushed a commit to samjove/warehouse that referenced this issue Aug 8, 2024
samjove pushed a commit to samjove/warehouse that referenced this issue Aug 8, 2024
samjove pushed a commit to samjove/warehouse that referenced this issue Aug 8, 2024
samjove pushed a commit to samjove/warehouse that referenced this issue Aug 9, 2024
@di di closed this as completed in #16388 Aug 12, 2024
di added a commit that referenced this issue Aug 12, 2024
…fields (#16190) (#16388)

Co-authored-by: vermo7en <samir.sanj.verma@gmail.com>
Co-authored-by: Dustin Ingram <di@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 good first issue This issue is ideal for first-time contributors!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants