Skip to content

Serve the v1 API index as JSON only #3208

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
JacobCoffee merged 2 commits into from
Nov 6, 2026
Merged

Serve the v1 API index as JSON only #3208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2f1ff7
fix(api): serve the v1 API index as JSON only
Nov 4, 2026
be01055
test(api): cover the v1 API index with a browser Accept header
Nov 4, 2026
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
10 changes: 10 additions & 0 deletions pydotorg/tests/test_views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,13 @@ def test_security_txt(self):

response = self.client.get("/security.txt")
self.assertRedirects(response, "/.well-known/security.txt", status_code=301, fetch_redirect_response=False)

def test_api_v1_root_ignores_browser_accept_header(self):
url = reverse("api_v1_top_level", kwargs={"api_name": "v1"})
browser_accept = "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"

response = self.client.get(url, headers={"accept": browser_accept})

self.assertEqual(response.status_code, 200)
self.assertEqual(response["Content-Type"], "application/json")
self.assertIn("pages/page", response.json())
10 changes: 9 additions & 1 deletion pydotorg/urls_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
from django.urls import re_path
from rest_framework import routers
from tastypie.api import Api
from tastypie.serializers import Serializer

from apps.downloads.api import (
OSResource,
Expand All @@ -15,7 +16,14 @@
from apps.pages.api import PageResource, PageViewSet
from apps.sponsors.api import LogoPlacementeAPIList, SponsorshipAssetsAPIList

v1_api = Api(api_name="v1")

class JSONOnlySerializer(Serializer):
"""JSON-only serializer for the v1 API index."""

formats = ("json",)


v1_api = Api(api_name="v1", serializer_class=JSONOnlySerializer)
v1_api.register(PageResource())
v1_api.register(OSResource())
v1_api.register(ReleaseResource())
Expand Down
Loading