cyclonedx.validation.model

Classes

ModelValidationError

Validation failed with this specific error.

ModelValidator

Perform data-model level validations to make sure we have some known data integrity.

Module Contents

class cyclonedx.validation.model.ModelValidationError

Bases: cyclonedx.validation.ValidationError

Validation failed with this specific error.

Use data to access the content.

class cyclonedx.validation.model.ModelValidator

Perform data-model level validations to make sure we have some known data integrity.

validate(bom: cyclonedx.model.bom.Bom) collections.abc.Iterable[ModelValidationError]

Perform data-model level validations to make sure we have some known data integrity prior to attempting output of a Bom.

Parameters:

bom – The Bom to validate.

Returns:

An iterable of ModelValidationError if any issues are found.