Skip to content

docs(sbom): document the Asset-page export and the version it produces - #15671

Merged
Maffooch merged 1 commit into
DefectDojo:bugfixfrom
Jino-T:docs/sbom-export-versions
Aug 14, 2026
Merged

docs(sbom): document the Asset-page export and the version it produces#15671
Maffooch merged 1 commit into
DefectDojo:bugfixfrom
Jino-T:docs/sbom-export-versions

Conversation

@Jino-T

@Jino-T Jino-T commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

[sc-14491]

Description

The Exporting SBOMs and VEX page documented only the token-auth API endpoints. The Asset page's own Export panel — SBOM, VEX, and SBOM with vulnerabilities (VDR) — had no documentation at all, so the three choices, and what document each one produces, were discoverable only by exporting one and reading the result.

This adds a section covering that panel:

  • A table of the three export types and what each document contains.
  • A note that each choice now names the format and specification version it produces, and that those labels are read from the server as the panel renders rather than written into the page — so they follow the exporters rather than going stale when the specification is bumped.
  • A statement that the Asset page and the API endpoints emit the same specification version, so a document exported from either path is interchangeable with the other.

Docs-only; no code changes in this repo.

Pairs with a DefectDojo Pro change on the same release line that adds the version to those labels and unifies the specification version across the two export paths.

The Exporting SBOMs and VEX page covered only the token-auth API endpoints.
The Asset page's own Export panel — SBOM, VEX and SBOM with vulnerabilities
(VDR) — was undocumented, so the three choices and what each one produces
were discoverable only by using them.

Adds a section describing the three export types and notes that each choice
now names the format and specification version it produces. Also states that
the Asset page and the API emit the same specification version, so a document
from either path is interchangeable with the other.
@github-actions github-actions Bot added the docs label Aug 14, 2026
@Jino-T Jino-T added this to the 3.2.200 milestone Aug 14, 2026
@Maffooch
Maffooch added this pull request to the merge queue Aug 14, 2026
Merged via the queue into DefectDojo:bugfix with commit bc12521 Aug 14, 2026
47 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.

4 participants