cyclonedx.validation.json

Classes

JsonValidator	Validator for CycloneDX documents in JSON format.
JsonStrictValidator	Strict validator for CycloneDX documents in JSON format.

Module Contents

class cyclonedx.validation.json.JsonValidator(schema_version: cyclonedx.schema.SchemaVersion)

Bases: _BaseJsonValidator, cyclonedx.validation.BaseSchemabasedValidator, cyclonedx.validation.SchemabasedValidator

Validator for CycloneDX documents in JSON format.

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

Get the format.

property schema_version: cyclonedx.schema.SchemaVersion

Get the schema version.

validate_str(data: str) → ValidationError | None

Validate a string

Parameters:

data – the data string to validate

Returns:

validation error

Retval None:

if data is valid

Retval ValidationError:

if data is invalid

class cyclonedx.validation.json.JsonStrictValidator(schema_version: cyclonedx.schema.SchemaVersion)

Bases: _BaseJsonValidator, cyclonedx.validation.BaseSchemabasedValidator, cyclonedx.validation.SchemabasedValidator

Strict validator for CycloneDX documents in JSON format.

In contrast to JsonValidator, the document must not have additional or unknown JSON properties.

property output_format: Literal[cyclonedx.schema.OutputFormat.JSON]

Get the format.

property schema_version: cyclonedx.schema.SchemaVersion

Get the schema version.

validate_str(data: str) → ValidationError | None

Validate a string

Parameters:

data – the data string to validate

Returns:

validation error

Retval None:

if data is valid

Retval ValidationError:

if data is invalid