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

Include link to view finding in API response #3346

Open
2 tasks done
mykter opened this issue Dec 29, 2023 · 1 comment
Open
2 tasks done

Include link to view finding in API response #3346

mykter opened this issue Dec 29, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@mykter
Copy link

mykter commented Dec 29, 2023

Current Behavior

/v1/finding/project/{uuid} returns an object that doesn't include a URL to view the finding in the UI.

Proposed Behavior

Include a web-url field (or similar - I don't think there's precedent for this field name yet?) alongside the matrix that links to the frontend: http://{frontend}/projects/{project uuid}/findings/{component uuid}/{vuln uuid}.

It is already possible to build this URL from the matrix, but it's not obvious that this route exists - it isn't exposed in the UI in any way, so presenting it in the API response makes it much more usable.

This depends on frontend/#689 being merged for this URL to work.


The generic version of this enhancement is adding links to all of the relevant API responses: components, projects, vulnerabilities, policies, violations, etc. This specific one is the most impactful, as it's not easily discoverable via the frontend.

Checklist

@mykter mykter added the enhancement New feature or request label Dec 29, 2023
@valentijnscholten
Copy link
Contributor

Maybe call it displayURI or something like that. The url field in an API response might be expected to point to the finding/entity "inside the API" instead of in "some frontend".

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

2 participants