Skip to content

Commit

Permalink
docs: update for batch-analysis (#325)
Browse files Browse the repository at this point in the history
  • Loading branch information
xieshenzh authored Mar 27, 2024
1 parent 9efaf5b commit 6230bdf
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,19 @@ Content-Disposition: attachment; filename=report.html
```
### Batch Dependency Analysis `/api/v4/batch-analysis`
This API performs dependency analysis for multiple projects.
The expected input data format is a dictionary. The keys are the package urls of the projects, while the values are the SBOMs of the projects.
All the parameters for the Dependency Analysis API are applicable to the Batch Dependency Analysis API.
The expected response varies based on the media type of the request:
- When media type `application/json` is requested, the response will be a dictionary of JSON reports.
- When media type `text/html` is requested, the response will be an html report with vulnerability information for all the requested projects.
- When media type `multipart/mixed` is requested, the response will contain both the dictionary of JSON reports and the html report.
## Token validation
Clients are allowed to validate the vulnerability provider token with a specific endpoint. That will allow IDEs and the CLI to persist the different
Expand Down

0 comments on commit 6230bdf

Please sign in to comment.