django-jedminson

Opinionated JSON Schema form field for Django admin, powered by Jedison.

For configuration that lives in a JSONField, Jedminson gives you an admin form with familiar controls and collapsible fieldsets. Define the data with JSON Schema, choose a layout if you need one, and let Python validate what gets submitted.

Installation

Requires Python 3.10+ and Django 5.2+.

python -m pip install django-jedminson

Add jedminson to INSTALLED_APPS alongside your Django admin apps. Serve its static files through your usual setup, including collectstatic for deployment. JavaScript and CSS are included in the release archives; no frontend build is needed to use the package.

Quick start

Here's a configuration with a URL and an enabled flag. Start with a normal model JSONField in your app's models.py:

from django.db import models


class Integration(models.Model):
    name = models.CharField(max_length=100)
    config = models.JSONField(default=dict, blank=True)

    def __str__(self):
        return self.name

Give it a schema in forms.py:

from jedminson.forms import JSONSchemaField, JedminsonModelForm

from .models import Integration


class IntegrationForm(JedminsonModelForm):
    config = JSONSchemaField(schema={
        'type': 'object',
        'properties': {
            'url': {'type': 'string', 'title': 'URL', 'minLength': 1},
            'enabled': {'type': 'boolean', 'title': 'Enabled', 'default': True},
        },
        'required': ['url'],
    })

    class Meta:
        model = Integration
        fields = ['name', 'config']

Then register the form in admin.py:

from django.contrib import admin

from .forms import IntegrationForm
from .models import Integration


@admin.register(Integration)
class IntegrationAdmin(admin.ModelAdmin):
    form = IntegrationForm

Use JedminsonModelForm so the widget receives bound values and validation errors. Keep blank=True on the model field so empty JSON containers reach schema validation. Your schema decides whether they're valid; model constraints still apply.

Controlling the layout

display is optional. Leave it out and fields follow the schema's property order. To group the two fields above, add this argument to JSONSchemaField:

display=[{
    'type': 'fieldset',
    'title': 'Connection',
    'collapsible': 'open',
    'fields': [{'path': '/url'}, {'path': '/enabled'}],
}]

The schema describes the data and its validation. display controls where the fields go, without changing that schema.

Current scope

Version 0.1.1 is Beta and supports stock Django admin. It handles scalar fields, objects, nested arrays and conditional fields.

Not every valid JSON Schema can be rendered. Avoid unusual property names for now: Jedison has known path and HTML-ID collisions with names such as a/b, a.b and empty strings, which can affect editing, error placement and focus.