Skip to content
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.

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

feat: add root component and unscanned dependency #13

Merged
merged 1 commit into from
Feb 27, 2024
Merged
Changes from all commits
Commits
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
81 changes: 79 additions & 2 deletions api/v4/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down 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: object
additionalProperties:
$ref: '#/components/schemas/AnalysisReport'
text/html:
schema:
type: object
multipart/mixed:
schema:
type: object
properties:
json_report:
type: object
additionalProperties:
$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 @@ -184,6 +247,10 @@ components:
type: array
items:
$ref: '#/components/schemas/DependencyReport'
unscanned:
type: array
items:
$ref: '#/components/schemas/UnscannedDependency'
SourceSummary:
type: object
properties:
Expand Down Expand Up @@ -217,6 +284,9 @@ components:
recommendations:
type: integer
default: 0
unscanned:
type: integer
default: 0
PackageRef:
type: string
description: PackageURL used to identify a dependency artifact
Expand Down Expand Up @@ -327,4 +397,11 @@ components:
reportConfidence:
type: string
cvss:
type: string
UnscannedDependency:
type: object
properties:
ref:
$ref: '#/components/schemas/PackageRef'
reason:
type: string
Loading