Skip to content

Enhance CycloneDX documentation and configuration options description to stress the priority on JSON format #56750

Description

@rsvoboda

Description

Enhance CycloneDX documentation and configuration options description to stress the priority on JSON format

Examples:
With

quarkus.cyclonedx.embedded.enabled=true
quarkus.cyclonedx.format=xml

Embeded is JSON SBOM

With

quarkus.cyclonedx.pretty-print=false
quarkus.cyclonedx.format=all

XML is pretty-printed

SBOM endpoint seems to be JSON only, this should be stressed in the docs and endpoint config section.

Docs should have a general note that JSON format is the primary focus of the extension as the underlying library focuses on that format.

Implementation ideas

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions