Skip to content

Commit

Permalink
add /v0/package/{purl}/dependencies and /v0/artifact/{digest}/vulns
Browse files Browse the repository at this point in the history
Signed-off-by: Ritesh <[email protected]>
  • Loading branch information
Ritesh-Udgata committed Oct 31, 2024
1 parent a61a7a7 commit 80d0fd9
Showing 1 changed file with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions guac-restAPI-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 80d0fd9

Please sign in to comment.