generated from just-the-docs/just-the-docs-template
-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add /v0/package/{purl}/dependencies and /v0/artifact/{digest}/vulns
Signed-off-by: Ritesh <[email protected]>
- Loading branch information
1 parent
a61a7a7
commit 80d0fd9
Showing
1 changed file
with
29 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -106,19 +106,43 @@ Response: | |
} | ||
``` | ||
|
||
### 6. Components | ||
### 6. GET /v0/package/{purl}/dependencies | ||
Retrieve the dependencies associated with a specific Package URL (purl). If a partial purl is provided, all associated purls and dependencies are included. | ||
|
||
#### PaginationSpec Parameter | ||
Request Example: | ||
```bash | ||
GET /api/v1/package/{purl}/dependencies | ||
``` | ||
|
||
Response: | ||
```json | ||
{ | ||
"dependencies": ["pkg:foo/[email protected]", "pkg:foo/[email protected]"] | ||
} | ||
``` | ||
|
||
### 7. GET /v0/artifact/{digest}/vulns | ||
Retrieve vulnerabilities related to a specific artifact digest. | ||
|
||
Controls pagination of the results. | ||
Request Example: | ||
```bash | ||
GET /api/v1/artifact/{digest}/vulns | ||
``` | ||
|
||
Response: | ||
```json | ||
{ | ||
"PageSize": 10, | ||
"Cursor": "abc123" | ||
"vulnerabilities": [ | ||
{ | ||
"id": "CVE-2023-12345", | ||
"description": "Sample vulnerability description.", | ||
"severity": "High" | ||
} | ||
] | ||
} | ||
``` | ||
|
||
|
||
#### Vulnerability Schema | ||
|
||
```json | ||
|