dependency-track/docs/_docs/usage
Hoobi 03bae1ed32
Add project filters to component identity search (#6085)
* Add project filters to component identity search

Adds onlyActive and onlyLatestVersion query parameters to
GET /v1/component/identity, allowing portfolio-wide component
searches to be scoped to active projects and/or projects flagged
as the latest version. Reduces noise from archived projects and
older project versions when triaging components across the
portfolio.

Closes #4570

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Document component search project filters

Adds a short note to the Impact Analysis page describing the
"Only active projects" and "Only latest project versions" toggles
on the Components search page, and the matching onlyActive and
onlyLatestVersion query parameters on /api/v1/component/identity.

Refs #4570

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Tighten javadoc and parameter descriptions

Trim wording in the new ComponentQueryManager overload, the new
@Parameter descriptions on /v1/component/identity, and the
Impact Analysis doc paragraph added in the previous commit.

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Rename query params to disambiguate on /component endpoint

Per PR review: onlyActive and onlyLatestVersion read as if they
filter on component attributes when the endpoint is scoped to
components. Rename to:

- excludeInactiveProjects, mirroring the existing convention
  used by /v1/project, /v1/vulnerability, and others.
- onlyLatestProjectVersion, mirroring the existing field on
  Policy and its use in PolicyEngine.

Refs #4570

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Update Impact Analysis doc to match toggle framing

Reflect the renamed query parameters and the toggle relabel
(Show inactive projects / Show all project versions, both on by
default) in the doc paragraph added by the previous commit.

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Update Impact Analysis doc for renamed latest-version toggle

Track the frontend label change from "Show all project versions"
to "Show non-latest project versions".

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

* Pluralize onlyLatestProjectVersions query parameter

Per PR review, the parameter takes effect across all matching
projects (one latest per name, multiple in aggregate), so the
plural form reads more accurately. Renames the corresponding
internal Java identifiers, test methods, test query strings, and
the Impact Analysis doc reference.

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>

---------

Signed-off-by: hoobio <7289249+hoobio@users.noreply.github.com>
2026-05-04 13:09:15 +02:00
..
cicd.md Fix miscellaneous typos 2025-01-12 16:24:26 -05:00
collection-projects.md Fix miscellaneous typos 2025-01-12 16:24:26 -05:00
community-usage-examples.md Clarify availability of EPSS scores 2023-01-24 19:19:01 +01:00
continuous-transparency.md v4.0 doc update 2020-10-09 00:47:42 -05:00
executive-order-14028.md Rename "Use Cases" docs to "Community Usage Examples" 2023-01-21 22:34:03 +01:00
impact-analysis.md Add project filters to component identity search (#6085) 2026-05-04 13:09:15 +02:00
policy-compliance.md Add age and version distance to operational policy criteria 2026-03-23 17:08:42 +01:00
procurement.md Doc updates 2020-12-26 23:27:00 -06:00