From: Raxel Gutierrez <raxel@google.com>
Date: Fri, 20 Aug 2021 04:50:23 +0000 (+0000)
Subject: api: change <pk> parameter to <cover_id> for cover comments endpoint
X-Git-Tag: v3.1.0~73
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=38959bac4abb362ad577ca1da33cbca57fcd17a4;p=thirdparty%2Fpatchwork.git

api: change <pk> parameter to <cover_id> for cover comments endpoint

Rename cover lookup parameter `pk` to `cover_id` for the cover comments
list endpoints to disambiguate from the lookup parameter `comment_id` in
upcoming patches which introduces the cover comments detail endpoint.
This doesn't affect the user-facing API.

Signed-off-by: Raxel Gutierrez <raxel@google.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
[dja: fixup to apply on top of fecf7c86c2c5 and 0ed2feb26c84]
Signed-off-by: Daniel Axtens <dja@axtens.net>
---

diff --git a/patchwork/api/comment.py b/patchwork/api/comment.py
index e9c52b99..479a85fe 100644
--- a/patchwork/api/comment.py
+++ b/patchwork/api/comment.py
@@ -83,13 +83,13 @@ class CoverCommentList(ListAPIView):
     search_fields = ('subject',)
     ordering_fields = ('id', 'subject', 'date', 'submitter')
     ordering = 'id'
-    lookup_url_kwarg = 'pk'
+    lookup_url_kwarg = 'cover_id'
 
     def get_queryset(self):
-        get_object_or_404(Cover, pk=self.kwargs['pk'])
+        get_object_or_404(Cover, pk=self.kwargs['cover_id'])
 
         return CoverComment.objects.filter(
-            cover=self.kwargs['pk']
+            cover=self.kwargs['cover_id']
         ).select_related('submitter')
 
 
diff --git a/patchwork/api/cover.py b/patchwork/api/cover.py
index b4a3a8f7..c4355f6b 100644
--- a/patchwork/api/cover.py
+++ b/patchwork/api/cover.py
@@ -37,7 +37,7 @@ class CoverListSerializer(BaseHyperlinkedModelSerializer):
 
     def get_comments(self, cover):
         return self.context.get('request').build_absolute_uri(
-            reverse('api-cover-comment-list', kwargs={'pk': cover.id}))
+            reverse('api-cover-comment-list', kwargs={'cover_id': cover.id}))
 
     def to_representation(self, instance):
         # NOTE(stephenfin): This is here to ensure our API looks the same even
diff --git a/patchwork/tests/api/test_comment.py b/patchwork/tests/api/test_comment.py
index 22638d2f..0bf74fa0 100644
--- a/patchwork/tests/api/test_comment.py
+++ b/patchwork/tests/api/test_comment.py
@@ -28,7 +28,7 @@ class TestCoverComments(utils.APITestCase):
         kwargs = {}
         if version:
             kwargs['version'] = version
-        kwargs['pk'] = cover.id
+        kwargs['cover_id'] = cover.id
 
         return reverse('api-cover-comment-list', kwargs=kwargs)
 
@@ -80,7 +80,7 @@ class TestCoverComments(utils.APITestCase):
     def test_list_non_existent_cover(self):
         """Ensure we get a 404 for a non-existent cover letter."""
         resp = self.client.get(
-            reverse('api-cover-comment-list', kwargs={'pk': '99999'}))
+            reverse('api-cover-comment-list', kwargs={'cover_id': '99999'}))
         self.assertEqual(status.HTTP_404_NOT_FOUND, resp.status_code)
 
     def test_list_invalid_cover(self):
diff --git a/patchwork/urls.py b/patchwork/urls.py
index 34b07e2a..075ab14b 100644
--- a/patchwork/urls.py
+++ b/patchwork/urls.py
@@ -337,7 +337,7 @@ if settings.ENABLE_REST_API:
             name='api-patch-comment-list',
         ),
         path(
-            'covers/<int:pk>/comments/',
+            'covers/<int:cover_id>/comments/',
             api_comment_views.CoverCommentList.as_view(),
             name='api-cover-comment-list',
         ),