Skip to content

disdantic.schema

Dynamic schema generation and OpenAPI translation utilities.

This module provides programmatic tools to generate unified JSON Schema representations for dynamic registries. It supports resolving all registered models, force-rebuilding schemas to ensure correctness, and translating references to conform with OpenAPI specifications.

Veteran maintainers can utilize this module's schemas for external dynamic routing, while new contributors can use it to inspect the collective schema of their registered classes.

get_registry_schema(registry_class, *, format='json')

Generates the schema for the specified registry base class.

Example

.. code-block:: python

from disdantic.schema import get_registry_schema
from myapp.registry import MyRegistry

# Generate OpenAPI schema for the registry
schema = get_registry_schema(MyRegistry, format="openapi")

:param registry_class: The registry base class subclassing PydanticClassRegistryMixin. :param format: The output format, either 'json' or 'openapi'. :raises TypeError: If the registry_class is not a subclass of PydanticClassRegistryMixin. :returns: A dictionary representing the generated schema.

Source code in src/disdantic/schema.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def get_registry_schema(
    registry_class: type[PydanticClassRegistryMixin],
    *,
    format: SchemaFormat = "json",  # noqa: A002
) -> dict[str, Any]:
    """Generates the schema for the specified registry base class.

    Example:
        .. code-block:: python

            from disdantic.schema import get_registry_schema
            from myapp.registry import MyRegistry

            # Generate OpenAPI schema for the registry
            schema = get_registry_schema(MyRegistry, format="openapi")

    :param registry_class: The registry base class subclassing
        PydanticClassRegistryMixin.
    :param format: The output format, either 'json' or 'openapi'.
    :raises TypeError: If the registry_class is not a subclass of
        PydanticClassRegistryMixin.
    :returns: A dictionary representing the generated schema.
    """
    if not isinstance(registry_class, type) or not issubclass(
        registry_class, PydanticClassRegistryMixin
    ):
        got_type = (
            registry_class if isinstance(registry_class, type) else type(registry_class)
        )
        raise TypeError(
            "Expected a subclass of PydanticClassRegistryMixin, "
            f"got {got_type.__name__}"
        )

    # Rebuild class and registered models
    registry_class.model_rebuild(force=True)

    if format == "openapi":
        schema = registry_class.model_json_schema(
            ref_template="#/components/schemas/{model}"
        )
        if "$defs" in schema:
            schema["components"] = {"schemas": schema.pop("$defs")}
    else:
        schema = registry_class.model_json_schema()

    return schema