DependencyTrack / DependencyTrack/dependency-track

Include link to view finding in API response

Open
#3,346 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
4.2k
Forks
811
Avg merge
8h 39m
Merged PRs (30d)
237

Description

### 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](https://github.com/DependencyTrack/frontend/pull/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

- [X] I have read and understand the [contributing guidelines](https://github.com/DependencyTrack/dependency-track/blob/master/CONTRIBUTING.md#filing-issues)
- [X] I have checked the [existing issues](https://github.com/DependencyTrack/dependency-track/issues) for whether this enhancement was already requested

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.