jsonfield-validation 0.3.0

Validator class for Django model JSON fields.

Django JSON Schema Field Validator

JSON Schema validation for Django JSONField.

Quickstart

Installation

pip install jsonfield-validation

Usage

from jsonfield_validation import JsonSchemaValidator


class MyModel(models.Model):
    items = models.JSONField(
        validators=[
            JsonSchemaValidator({"maxItems": 2})
        ]
    )

Like any Django model field validator, validation happens when clean_fields() is called on a model instance:

>>> instance = MyModel(items=[1, 2, 3])
>>> instance.clean_fields()

django.core.exceptions.ValidationError: {'items': ["[1, 2, 3] is too long"]}

Further documentation is gratiously hosted by Read the Docs

Credits

This package was created with Cookiecutter and the pymetrics/cookiecutter-python-library project template.

History

0.3.0 (2022-06-15)

• Add path to invalid value to error_list message,

0.2.0 (2022-06-15)

• Add check method.

0.1.0 (2022-06-14)

• First release on PyPI.