forked from trustification/trustify
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add some examples, retrieving SBOMs and their information
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,39 @@ | ||
Find SBOMs: | ||
|
||
```bash | ||
http GET localhost:8080/api/v1/sbom limit==5 offset==0 | ||
``` | ||
|
||
Retrieve SBOM: | ||
|
||
```bash | ||
http GET localhost:8080/sboms/1 | ||
``` | ||
|
||
Get SBOM packages: | ||
|
||
```bash | ||
http GET localhost:8080/api/v1/sbom/1/packages limit==5 offset==0 | ||
``` | ||
|
||
Get SBOM top-level packages: | ||
|
||
```bash | ||
http GET localhost:8080/api/v1/sbom/1/packages limit==5 offset==0 root==true | ||
``` | ||
|
||
Get related packages: | ||
|
||
```bash | ||
http GET localhost:8080/api/v1/sbom/1/related limit==5 offset==0 reference==<purl> | ||
``` | ||
|
||
You can add `which==<left|right>` to declare which side of the reference you want to search for. | ||
|
||
It also is possible to limit the search to a specific relationship type by providing `relationship==<relationship>`. | ||
|
||
For example: | ||
|
||
```bash | ||
http GET localhost:8080/api/v1/sbom/1/related limit==5 offset==0 reference==pkg://maven/com.redhat.quarkus.platform/[email protected]?repository_url=https://maven.repository.redhat.com/ga/&type=pom which==right | ||
``` |