Rename schedule job endpoint to pipeline endpoint

Signed-off-by: Keshav Priyadarshi <git@keshav.space>

Author: keshav-space

vulnerabilities/api_v2.py

@@ -803,7 +803,7 @@ def get_log(self, run):
 
 class PipelineScheduleAPISerializer(serializers.HyperlinkedModelSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="schedule-detail",
+        view_name="pipelines-detail",
         lookup_field="pipeline_id",
     )
     latest_run = serializers.SerializerMethodField()
@@ -891,6 +891,11 @@ def get_permissions(self):
             return [IsAdminWithSessionAuth()]
         return super().get_permissions()
 
+    def get_view_name(self):
+        if self.detail:
+            return "Pipeline Instance"
+        return "Pipeline Jobs"
+
 
 class AdvisoriesPackageV2ViewSet(viewsets.ReadOnlyModelViewSet):
     queryset = PackageV2.objects.all().prefetch_related(

vulnerabilities/tests/test_api_v2.py

@@ -699,19 +699,19 @@ def setUp(self):
         self.admin_token_auth = f"Token {self.admin_token_only_user.auth_token.key}"
 
     def test_schedule_list_anon_user_permitted(self):
-        response = self.client.get("/api/v2/schedule/")
+        response = self.client.get("/api/v2/pipelines/")
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
     def test_schedule_retrieve_anon_user_permitted(self):
-        response = self.client.get("/api/v2/schedule/test_pipeline/")
+        response = self.client.get("/api/v2/pipelines/test_pipeline/")
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
     @patch("vulnerabilities.models.PipelineSchedule.create_new_job")
     def test_create_schedule_anon_user_not_permitted(self, mock_create_new_job):
         mock_create_new_job.return_value = "work-id2"
 
         data = {"pipeline_id": "test_pipeline2"}
-        response = self.client.post("/api/v2/schedule/", data, format="json")
+        response = self.client.post("/api/v2/pipelines/", data, format="json")
 
         self.assertNotEqual(response.status_code, status.HTTP_201_CREATED)
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
@@ -725,7 +725,7 @@ def test_create_schedule_with_staff_token_not_permitted(self, mock_create_new_jo
         mock_create_new_job.return_value = "work-id3"
 
         data = {"pipeline_id": "test_pipeline3"}
-        response = self.client.post("/api/v2/schedule/", data, format="json")
+        response = self.client.post("/api/v2/pipelines/", data, format="json")
 
         self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
         self.assertNotEqual(response.status_code, status.HTTP_201_CREATED)
@@ -737,7 +737,7 @@ def test_create_schedule_with_staff_session_permitted(self, mock_create_new_job)
         self.client.login(username="admin_with_session", password="adminpassword")
 
         data = {"pipeline_id": "test_pipeline3"}
-        response = self.client.post("/api/v2/schedule/", data, format="json")
+        response = self.client.post("/api/v2/pipelines/", data, format="json")
 
         self.assertNotEqual(response.status_code, status.HTTP_403_FORBIDDEN)
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
@@ -748,7 +748,7 @@ def test_schedule_update_anon_user_not_permitted(self, mock_create_new_job):
         mock_create_new_job.return_value = "work-id5"
 
         data = {"run_interval": 2}
-        response = self.client.patch("/api/v2/schedule/test_pipeline/", data, format="json")
+        response = self.client.patch("/api/v2/pipelines/test_pipeline/", data, format="json")
         self.schedule1.refresh_from_db()
 
         self.assertNotEqual(response.status_code, status.HTTP_200_OK)
@@ -763,7 +763,7 @@ def test_schedule_update_with_staff_token_not_permitted(self, mock_create_new_jo
         mock_create_new_job.return_value = "work-id6"
 
         data = {"run_interval": 2}
-        response = self.client.patch("/api/v2/schedule/test_pipeline/", data, format="json")
+        response = self.client.patch("/api/v2/pipelines/test_pipeline/", data, format="json")
         self.schedule1.refresh_from_db()
 
         self.assertNotEqual(response.status_code, status.HTTP_200_OK)
@@ -776,7 +776,7 @@ def test_schedule_update_with_staff_session_permitted(self, mock_create_new_job)
         self.client.login(username="admin_with_session", password="adminpassword")
 
         data = {"run_interval": 2}
-        response = self.client.patch("/api/v2/schedule/test_pipeline/", data, format="json")
+        response = self.client.patch("/api/v2/pipelines/test_pipeline/", data, format="json")
         self.schedule1.refresh_from_db()
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)

vulnerablecode/urls.py

@@ -66,7 +66,7 @@ def __init__(self, *args, **kwargs):
 )
 api_v2_router.register("vulnerabilities", VulnerabilityV2ViewSet, basename="vulnerability-v2")
 api_v2_router.register("codefixes", CodeFixViewSet, basename="codefix")
-api_v2_router.register("schedule", PipelineScheduleV2ViewSet, basename="schedule")
+api_v2_router.register("pipelines", PipelineScheduleV2ViewSet, basename="pipelines")
 
 
 urlpatterns = [