Merge pull request #773 from TG1999/changelog/api

Add changelog

CHANGELOG.rst

@@ -19,7 +19,21 @@ Version v30.0.0
 
 - Add support for nix as a Linux deployment target.
 
-- Lookup vulnerabilities from CPE
+- Lookup vulnerabilities from CPE through API
+
+- Breaking Changes at API level
+  - /api/vulnerabilities 
+    - Replace `resolved_packages` by `fixed_packages` 
+    - Replace `unresolved_packages` by `affected_packages`
+    - Replace `url` by `reference_url` in the reference list
+  - /api/packages
+    - Replace `unresolved_vulnerabilities` by `affected_by_vulnerabilities`
+    - Replace  `resolved_vulnerabilities` by `fixing_vulnerabilities`
+    - Replace `url` by `reference_url` in the reference list
+
+- Add alias to the /api/vulnerabilities
+
+- Lookup vulnerabilities from aliases
 
 
 

vulnerablecode/static/api_doc/api_schema.yaml

@@ -262,12 +262,12 @@ components:
           type: string
           format: uri
           readOnly: true
-        unresolved_vulnerabilities:
+        affected_by_vulnerabilities:
           type: array
           items:
             $ref: '#/components/schemas/MinimalVulnerability'
           readOnly: true
-        resolved_vulnerabilities:
+        fixing_vulnerabilities:
           type: array
           items:
             $ref: '#/components/schemas/MinimalVulnerability'
@@ -306,10 +306,10 @@ components:
       - name
       - namespace
       - purl
-      - resolved_vulnerabilities
+      - fixing_vulnerabilities
       - subpath
       - type
-      - unresolved_vulnerabilities
+      - affected_by_vulnerabilities
       - url
       - version
     PaginatedPackageList:
@@ -374,12 +374,12 @@ components:
           type: string
           format: uri
           readOnly: true
-        resolved_packages:
+        fixed_packages:
           type: array
           items:
             $ref: '#/components/schemas/MinimalPackage'
           readOnly: true
-        unresolved_packages:
+        affected_packages:
           type: array
           items:
             $ref: '#/components/schemas/MinimalPackage'
@@ -407,8 +407,8 @@ components:
           description: Summary of the vulnerability
       required:
       - references
-      - resolved_packages
-      - unresolved_packages
+      - fixed_packages
+      - affected_packages
       - url
       - vulnerability_id
     VulnerabilityReference:
@@ -418,7 +418,7 @@ components:
           type: string
           description: Reference ID, eg:DSA-4465-1
           maxLength: 50
-        url:
+        reference_url:
           type: string
           format: uri
           description: URL of Vulnerability data