Skip to content

Commit

Permalink
feat: add root component and unscanned dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
xieshenzh committed Feb 22, 2024
1 parent 29e45b3 commit 9d9a07c
Showing 1 changed file with 75 additions and 1 deletion.
76 changes: 75 additions & 1 deletion api/v4/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -164,6 +227,10 @@ components:
type: object
additionalProperties:
$ref: '#/components/schemas/Source'
unscanned:
type: array
items:
$ref: '#/components/schemas/UnscannedDependency'
ProviderStatus:
type: object
properties:
Expand Down Expand Up @@ -327,4 +394,11 @@ components:
reportConfidence:
type: string
cvss:
type: string
UnscannedDependency:
type: object
properties:
ref:
$ref: '#/components/schemas/PackageRef'
reason:
type: string

0 comments on commit 9d9a07c

Please sign in to comment.