Repository navigation
Conversation
Add comprehensive documentation for python.org Downloads REST API (v1 Tastypie and v2 DRF). Covers endpoints for OS, Release, and ReleaseFile models, including query parameters, filtering, serialization fields, authentication, pagination, batch deletion, and URL validation rules.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds official Sphinx documentation for the python.org Downloads REST API, resolving #2750.
The documentation covers:
/api/v1/downloads/) and Django REST Framework (/api/v2/downloads/) endpoints./api/v{1,2}/downloads/os/): query parameters, serializers, JSON examples./api/v{1,2}/downloads/release/): version enum mapping, pre-release/published filtering, JSON examples./api/v{1,2}/downloads/release_file/): download URLs, GPG/Sigstore signatures, SBOM metadata, checksums, batch deletion endpoints.https://www.python.org/prefix and sidecar file extension naming requirements.downloads_api.rstfrom the root documentation index (docs/source/index.rst).Verification
uv run --only-group docs sphinx-build -M html docs/source docs/_build -E -a -j auto --keep-going -W(succeeded with zero warnings or errors).apps.downloadstest suite with 123 tests (uv run python ./manage.py test apps.downloads). All 123 tests passed.uv run ruff check .,uv run ruff format --check ., anduv run pyproject-fmt --check pyproject.toml(all clean).Closes
Closes #2750