cyclonedx.validation.model
==========================

.. py:module:: cyclonedx.validation.model


Classes
-------

.. autoapisummary::

   cyclonedx.validation.model.ModelValidationError
   cyclonedx.validation.model.ModelValidator


Module Contents
---------------

.. py:class:: ModelValidationError

   Bases: :py:obj:`cyclonedx.validation.ValidationError`


   Validation failed with this specific error.

   Use :attr:`~data` to access the content.


.. py:class:: ModelValidator

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


   .. py:method:: 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`.

      :param bom: The `Bom` to validate.
      :return: An iterable of `ModelValidationError` if any issues are found.