cyclonedx.validation.json
=========================

.. py:module:: cyclonedx.validation.json


Classes
-------

.. autoapisummary::

   cyclonedx.validation.json.JsonValidationError
   cyclonedx.validation.json.JsonValidator
   cyclonedx.validation.json.JsonStrictValidator


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

.. py:class:: JsonValidationError

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


.. py:class:: JsonValidator(schema_version: cyclonedx.schema.SchemaVersion)

   Bases: :py:obj:`_BaseJsonValidator`, :py:obj:`cyclonedx.validation.BaseSchemabasedValidator`, :py:obj:`cyclonedx.validation.SchemabasedValidator`


   Validator for CycloneDX documents in JSON format.


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



   .. py:method:: validate_str(data: str, *, all_errors: Literal[False] = ...) -> Optional[JsonValidationError]
                  validate_str(data: str, *, all_errors: Literal[True]) -> Optional[collections.abc.Iterable[JsonValidationError]]


.. py:class:: JsonStrictValidator(schema_version: cyclonedx.schema.SchemaVersion)

   Bases: :py:obj:`_BaseJsonValidator`, :py:obj:`cyclonedx.validation.BaseSchemabasedValidator`, :py:obj:`cyclonedx.validation.SchemabasedValidator`


   Strict validator for CycloneDX documents in JSON format.

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


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



   .. py:method:: validate_str(data: str, *, all_errors: Literal[False] = ...) -> Optional[JsonValidationError]
                  validate_str(data: str, *, all_errors: Literal[True]) -> Optional[collections.abc.Iterable[JsonValidationError]]