Skip to content

docs: where to find Asset types and aliases in the UI (asset model Phase 4) - #15645

Merged
Maffooch merged 3 commits into
DefectDojo:devfrom
devGregA:docs/asset-identity-ui
Aug 14, 2026
Merged

docs: where to find Asset types and aliases in the UI (asset model Phase 4)#15645
Maffooch merged 3 commits into
DefectDojo:devfrom
devGregA:docs/asset-identity-ui

Conversation

@devGregA

Copy link
Copy Markdown
Contributor

Documentation for the UI half of the asset identity work. The concepts landed in #15633 while both surfaces were still API-only, so the page said kinds were "available on the Asset itself" without saying where — and aliases had no UI to describe at all.

Asset Kinds — says which control sets the kind (the Kind field on the Asset add and edit forms), and where it then shows: as a badge with its icon beside the Asset's name, and as an icon in front of each node in the Asset Hierarchy view, with the label available from that view's field picker. Also corrects the API line: kind is on /api/v2/products/ as well as /api/v2/assets/.

Asset Identity: Aliases — a new subsection for the Asset Identity card on the Asset page. It covers what each row shows (identifier, type, namespace, and where it came from — a Connector's name or User), why the add form asks for the namespace before the type (only some pairings mean anything: a hostname belongs in dns, an image digest in oci), why Connector namespaces are not offered (they belong to that sync), and what withdrawing actually does — for a user-asserted alias, sources fall back to matching by name; for a Connector-asserted one, its next sync asserts it again, so a mapping change is the right fix. Notes that add and withdraw require edit permission on the Asset.

Also corrects the flag's scope: DD_V3_ASSET_ALIASES gates the Asset Identity card and the Kind field, not only alias creation.

Docs-only; no code changes. Same release line and batch as the Pro change that adds these surfaces.

…ase 4)

The identity concepts landed in DefectDojo#15633 while the surfaces were still API-only, so the
page said kinds were "available on the Asset itself" without saying where. Both halves
now have a UI, and this says which control does what:

* Kind is set on the Asset add/edit forms, and shows as a badge beside the Asset name
  and as an icon on Asset Hierarchy nodes (with the label available from the view's
  field picker).
* The Asset Identity card on the Asset page lists every identifier resolving to the
  Asset with its provenance, and adds or withdraws them. Namespace is picked before
  type because only some pairings mean anything, Connector namespaces are not offered
  because they belong to their sync, and withdrawing a Connector-asserted alias only
  lasts until its next run.

Also notes that `kind` is on `/api/v2/products/` as well as `/api/v2/assets/`, and that
DD_V3_ASSET_ALIASES gates the card and the Kind field, not just alias creation.
@devGregA devGregA added this to the 3.3.0 milestone Aug 12, 2026
@github-actions github-actions Bot added the docs label Aug 12, 2026
The asset classification registry is named AssetType, so the docs say Type: the
"Asset Kinds" section, the Kind field on the add/edit forms, the hierarchy view's
field picker, and the API surface (/api/v2/asset_types/, the asset_type field on
/api/v2/assets/ and /api/v2/products/).

This amends the UI walkthrough this PR already carried rather than shipping "Kind"
wording and renaming it a week later, and it also updates the section merged
earlier so the page is consistent end to end.

The corresponding Pro change renames the model, its table, both API routes and the
payload keys outright — no compatibility shims, because the feature is behind a
default-off flag and has not shipped yet.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@devGregA devGregA changed the title docs: where to find Asset kinds and aliases in the UI (asset model Phase 4) docs: where to find Asset types and aliases in the UI (asset model Phase 4) Aug 14, 2026
@Maffooch
Maffooch merged commit 56e6b8f into DefectDojo:dev Aug 14, 2026
48 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants