Skip to content

Add ref_template param to mgspec.json.schema #983

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jcrist merged 2 commits into from
Apr 8, 2026
Merged

Add ref_template param to mgspec.json.schema #983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7be448
Add `ref_template` param to `mgspec.json.schema`
sobolevn Mar 1, 2026
41afd07
Merge branch 'main' into patch-2
jcrist Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions src/msgspec/_json_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@
import re
import textwrap
from collections.abc import Iterable
from typing import Any, Callable, Optional
from typing import Any, Callable, Final, Optional

from . import inspect as mi, to_builtins

__all__ = ("schema", "schema_components")

_REF_TEMPLATE: Final = "#/$defs/{name}"


def schema(
type: Any, *, schema_hook: Optional[Callable[[type], dict[str, Any]]] = None
type: Any,
*,
schema_hook: Optional[Callable[[type], dict[str, Any]]] = None,
ref_template: str = _REF_TEMPLATE,
) -> dict[str, Any]:
"""Generate a JSON Schema for a given type.

Expand All @@ -29,6 +34,13 @@ def schema(
An optional callback to use for generating JSON schemas of custom
types. Will be called with the custom type, and should return a dict
representation of the JSON schema for that type.
ref_template : str, optional
A template to use when generating ``"$ref"`` fields. This template is
formatted with the type name as ``template.format(name=name)``. This
can be useful if you intend to store the ``components`` mapping
somewhere other than a top-level ``"$defs"`` field. For example, you
might use ``ref_template="#/components/{name}"`` if generating an
OpenAPI schema.

Returns
-------
Expand All @@ -39,7 +51,11 @@ def schema(
--------
schema_components
"""
(out,), components = schema_components((type,), schema_hook=schema_hook)
(out,), components = schema_components(
(type,),
schema_hook=schema_hook,
ref_template=ref_template,
)
if components:
out["$defs"] = components
return out
Expand All @@ -49,7 +65,7 @@ def schema_components(
types: Iterable[Any],
*,
schema_hook: Optional[Callable[[type], dict[str, Any]]] = None,
ref_template: str = "#/$defs/{name}",
ref_template: str = _REF_TEMPLATE,
) -> tuple[tuple[dict[str, Any], ...], dict[str, Any]]:
"""Generate JSON Schemas for one or more types.

Expand Down
Loading