cyclonedx.validation.json

Classes

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

Module Contents

class cyclonedx.validation.json.JsonValidationError

Bases: cyclonedx.validation.ValidationError

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]

validate_str(data: str, *, all_errors: Literal[False] = ...) → JsonValidationError | None

validate_str(data: str, *, all_errors: Literal[True]) → collections.abc.Iterable[JsonValidationError] | None

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]

validate_str(data: str, *, all_errors: Literal[False] = ...) → JsonValidationError | None

validate_str(data: str, *, all_errors: Literal[True]) → collections.abc.Iterable[JsonValidationError] | None