feat: add root component and unscanned dependency

RHEcosystemAppEng · Feb 23, 2024 · 067c606 · 067c606
1 parent 29e45b3
commit 067c606
Showing 1 changed file with 81 additions and 2 deletions.
diff --git a/api/v4/openapi.yaml b/api/v4/openapi.yaml
@@ -5,7 +5,7 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 4.0.0
+  version: 4.1.0
 servers:
 - url: https://rhda.rhcloud.com/api/v4
   description: Production server
@@ -68,7 +68,70 @@ paths:
             text/plain:
               schema:
                 type: string
-                description: Error message  
+                description: Error message
+  /batch-analysis:
+    post:
+      operationId: batchAnalysis
+      summary: Takes an array of client-resolved dependency graphs to perform a full stack analysis from all the available Vulnerability sources
+      security:
+        - RhdaTokenAuth: [ ]
+        - SnykTokenAuth: [ ]
+        - OssIndexUserAuth: [ ]
+          OssIndexTokenAuth: [ ]
+      parameters:
+        - name: providers
+          in: query
+          description: List of vulnerability providers to get the report from
+          required: false
+          schema:
+            enum:
+              - snyk
+              - oss-index
+            type: string
+          example: snyk
+      requestBody:
+        required: true
+        description: An array of dependency graphs in SBOM format
+        content:
+          application/vnd.cyclonedx+json:
+            schema:
+              type: array
+              items:
+                type: object
+          application/vnd.spdx+json:
+            schema:
+              type: array
+              items:
+                type: object
+      responses:
+        '200':
+          description: Full dependency analysis from all the available providers
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/AnalysisReport'
+            text/html:
+              schema:
+                type: object
+            multipart/mixed:
+              schema:
+                type: object
+                properties:
+                  json_report:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/AnalysisReport'
+                  html_report:
+                    type: object
+        '422':
+          description: Invalid request
+          content:
+            text/plain:
+              schema:
+                type: string
+                description: Error message
   /token:
     get:
       operationId: validateToken
@@ -184,6 +247,12 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/DependencyReport'
+        unscanned:
+          type: array
+          items:
+            $ref: '#/components/schemas/UnscannedDependency'
+        root:
+          $ref: '#/components/schemas/DependencyReport'
     SourceSummary:
       type: object
       properties:
@@ -217,6 +286,9 @@ components:
         recommendations:
           type: integer
           default: 0
+        unscanned:
+          type: integer
+          default: 0
     PackageRef:
       type: string
       description: PackageURL used to identify a dependency artifact
@@ -327,4 +399,11 @@ components:
         reportConfidence:
           type: string
         cvss:
+          type: string
+    UnscannedDependency:
+      type: object
+      properties:
+        ref:
+          $ref: '#/components/schemas/PackageRef'
+        reason:
           type: string