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

[feature] Add ability to fetch info related to a purl and similar identifiers in the REST api as well as aggregations on subsets of the identifiers #1734

Open
mlieberman85 opened this issue Feb 28, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mlieberman85
Copy link
Collaborator

mlieberman85 commented Feb 28, 2024

GUAC with graphql is currently great at handling complicated use cases like when you want to compare multiple artifacts or run complex queries. However, it's a bit of overkill when someone wants to just fetch information on a specific identifier or wants to get aggregates or lists.

I want the REST API to be able to have routes that look like

https:://guac_rest/v1/purl/pkg:{type}/{namespace}/{name}{@optional version}?{optional params}

so you end up with stuff like:

https://guac_rest/v1/purl/pkg:golang/github.com/mlieberman85/skoot-cache-3@v0.0.1

and that should return data related to that package. I can then see also having stuff after like:

https://guac_rest/v1/purl/pkg:golang/github.com/mlieberman85/skoot-cache-3@v0.0.1/vulns

to just return list of vulnerabilities or something like that. Also having subsets would also be nice for both aggregates and lists e.g.

https://guac_rest/v1/purl/pkg:golang/github.com/mlieberman85

would return me a list of purls like:

[
"pkg:golang/github.com/mlieberman85/skoot-cache-3@v0.0.1",
"pkg:goland/github.com/mlieberman85/skoot-test-1@v0.0.2",
...
]

Purl is just one example of an endpoint, i.e. purl, but I can see also a bunch of others as well like sbom, vuln, etc. This is inspired by some of the work the OMNIbor folks have been doing.

@mlieberman85 mlieberman85 added the enhancement New feature or request label Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant