Skip to content

Add V2 API endpoints #1631

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
TG1999 merged 13 commits into from
Nov 11, 2024
Merged

Add V2 API endpoints #1631

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
05f1ba1
Add V2 API endpoints
TG1999 Oct 28, 2024
e389ce5
Add Filter set
TG1999 Nov 7, 2024
2d0a10b
Add tests for v2 API
TG1999 Nov 7, 2024
9165710
Fix tests
TG1999 Nov 7, 2024
849e605
Add v2 API file
TG1999 Nov 7, 2024
7b14634
Fix formatting
TG1999 Nov 7, 2024
c73f621
Fix formatting
TG1999 Nov 7, 2024
208658e
Fix tests import
TG1999 Nov 7, 2024
76c13a8
Add copyright headers
TG1999 Nov 7, 2024
a97b5bd
Address review comment
TG1999 Nov 11, 2024
4ca07a9
Address review comment
TG1999 Nov 11, 2024
a053338
Address review comment
TG1999 Nov 11, 2024
fbae937
Address review comment
TG1999 Nov 11, 2024
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
Prev Previous commit
Address review comment 
Signed-off-by: Tushar Goel <tushar.goel.dav@gmail.com>
  • Loading branch information
@TG1999
TG1999 committed Nov 11, 2024
commit fbae9377caa2afdd6c06be174ae7d760b5fff75c
4 changes: 2 additions & 2 deletions vulnerabilities/api_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ def list(self, request, *args, **kwargs):
serializer = self.get_serializer(page, many=True)
data = serializer.data
# Use 'self.get_paginated_response' to include pagination data
return self.get_paginated_response({"purls": data})
return self.get_paginated_response({"packages": data})

# If pagination is not applied
serializer = self.get_serializer(queryset, many=True)
data = serializer.data
return Response({"purls": data})
return Response({"packages": data})
20 changes: 10 additions & 10 deletions vulnerabilities/tests/test_api_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,8 @@ def test_list_packages(self):
url = reverse("package-v2-list")
response = self.client.get(url, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertIn("purls", response.data["results"])
self.assertEqual(len(response.data["results"]["purls"]), 2)
self.assertIn("packages", response.data["results"])
self.assertEqual(len(response.data["results"]["packages"]), 2)

def test_filter_packages_by_purl(self):
"""
Expand All @@ -208,8 +208,8 @@ def test_filter_packages_by_purl(self):
url = reverse("package-v2-list")
response = self.client.get(url, {"purl": "pkg:pypi/django@3.2"}, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]["purls"]), 1)
self.assertEqual(response.data["results"]["purls"][0]["purl"], "pkg:pypi/django@3.2")
self.assertEqual(len(response.data["results"]["packages"]), 1)
self.assertEqual(response.data["results"]["packages"][0]["purl"], "pkg:pypi/django@3.2")

def test_filter_packages_by_affected_vulnerability(self):
"""
Expand All @@ -218,8 +218,8 @@ def test_filter_packages_by_affected_vulnerability(self):
url = reverse("package-v2-list")
response = self.client.get(url, {"affected_by_vulnerability": "VCID-1234"}, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]["purls"]), 1)
self.assertEqual(response.data["results"]["purls"][0]["purl"], "pkg:pypi/django@3.2")
self.assertEqual(len(response.data["results"]["packages"]), 1)
self.assertEqual(response.data["results"]["packages"][0]["purl"], "pkg:pypi/django@3.2")

def test_filter_packages_by_fixing_vulnerability(self):
"""
Expand All @@ -228,8 +228,8 @@ def test_filter_packages_by_fixing_vulnerability(self):
url = reverse("package-v2-list")
response = self.client.get(url, {"fixing_vulnerability": "VCID-5678"}, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]["purls"]), 1)
self.assertEqual(response.data["results"]["purls"][0]["purl"], "pkg:npm/lodash@4.17.20")
self.assertEqual(len(response.data["results"]["packages"]), 1)
self.assertEqual(response.data["results"]["packages"][0]["purl"], "pkg:npm/lodash@4.17.20")

def test_package_serializer_fields(self):
"""
Expand Down Expand Up @@ -276,7 +276,7 @@ def test_invalid_vulnerability_filter(self):
url = reverse("package-v2-list")
response = self.client.get(url, {"affected_by_vulnerability": "VCID-9999"}, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]["purls"]), 0)
self.assertEqual(len(response.data["results"]["packages"]), 0)

def test_invalid_purl_filter(self):
"""
Expand All @@ -286,7 +286,7 @@ def test_invalid_purl_filter(self):
url = reverse("package-v2-list")
response = self.client.get(url, {"purl": "pkg:nonexistent/package@1.0.0"}, format="json")
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(len(response.data["results"]["purls"]), 0)
self.assertEqual(len(response.data["results"]["packages"]), 0)

def test_get_affected_by_vulnerabilities(self):
"""
Expand Down
Loading