Backtestspydanticrun-20261005-183002#11922
Some Field attributes lost in JSON schema when using RootModel
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Both patches fix the core issue the same way: they copy `examples` (made JSON-able) and `deprecated` from the RootModel's `root` FieldInfo into the model-level schema. They also both keep `model_config['title']` ahead of the field title. The deciding difference is title handling. Patch A falls back to `cls.__pydantic_fields__['root'].title` whenever no title has been set, but `FieldInfo.title` can be filled in by a `field_title_generator`, either from config or on the Field. With such a generator, Patch A would rename the model schema to the generated field title (e.g. 'ROOT') instead of the class name, which is a regression for users who set `field_title_generator`. Patch B guards against this by only using an explicitly set title (`_attributes_set.get('title')`), and it adds a test for exactly this case covering both config-level and field-level generators. Patch B also places the explicit root title ahead of `model_title_generator`, which fits the issue's complaint that the field title is overwritten. Patch B also handles `deprecated=''` (an empty message), consolidates the RootModel detection into a single `root_field` variable reused for description, examples, deprecated and `json_schema_extra`, and avoids repeated `issubclass` checks. Its tests are broader and would fail before the change: a deprecation message, serialization mode, a generic `RootModel[Annotated[...]]`, a nested RootModel in `$defs`, config precedence, and the title-generator case. Patch A's tests cover the basic cases but miss the title-generator interaction its own change breaks. B is more correct and better tested.
The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.
Solve
7m 41s
Wall-clock time in the container
Full test suite
No new failures
12,245 passed · 503 skipped · 12,748 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
99vs 53 merged
Changed lines, ours vs merged
The issue
View on GitHubInitial Checks
- I confirm that I'm using Pydantic V2
Description
When declaring a RootModel and adding a Field annotation to the root property that includes examples, those examples are not part of the generated JSON schema. This also applies to the deprecated attribute. The title attribute is also not applied or it is overwritten by the class name of the root model class.
Most other attributes, such as pattern or description are exposed as expected. Furthermore, placing examples in json_schema_extra also works as expected.
Example Code
from typing import Annotated
from pydantic import RootModel, Field
class Foo(RootModel):
root: Annotated[str, Field(examples=["foo", "bar"], deprecated=True)]
print(Foo.model_json_schema()) # does not include examples or deprecated.
Python, Pydantic & OS Version
pydantic version: 2.11.4
pydantic-core version: 2.33.2
pydantic-core build: profile=release pgo=false
python version: 3.13.3 (main, May 22 2025, 01:38:47) [Clang 20.1.4 ]
platform: macOS-15.5-arm64-arm-64bit-Mach-O
related packages: pydantic-settings-2.9.1 mypy-1.15.0 typing_extensions-4.13.2 fastapi-0.115.12
commit: unknownThe two patches
pydantic/json_schema.pyindex 10d2f972..553033b3 100644@@ -1639,10 +1639,16 @@ class GenerateJsonSchema: """ from ._internal._dataclasses import is_stdlib_dataclass from .main import BaseModel- from .root_model import RootModel++ root_field = (+ cls.__pydantic_fields__['root'] if issubclass(cls, BaseModel) and cls.__pydantic_root_model__ else None+ ) if (config_title := config.get('title')) is not None: json_schema.setdefault('title', config_title)+ elif root_field is not None and root_field._attributes_set.get('title') is not None:+ # Only use an explicitly set title, not one created by a `field_title_generator`:+ json_schema.setdefault('title', root_field.title) elif model_title_generator := config.get('model_title_generator'): title = model_title_generator(cls) if not isinstance(title, str):@@ -1667,8 +1673,14 @@ class GenerateJsonSchema: if docstring: json_schema.setdefault('description', inspect.cleandoc(docstring))- elif issubclass(cls, RootModel) and (root_description := cls.__pydantic_fields__['root'].description):- json_schema.setdefault('description', root_description)+ elif root_field is not None and root_field.description:+ json_schema.setdefault('description', root_field.description)++ if root_field is not None:+ if root_field.examples is not None:+ json_schema.setdefault('examples', to_jsonable_python(root_field.examples))+ if bool(root_field.deprecated) or root_field.deprecated == '':+ json_schema['deprecated'] = True extra = config.get('extra') if 'additionalProperties' not in json_schema: # This check is particularly important for `typed_dict_schema()`@@ -1678,8 +1690,8 @@ class GenerateJsonSchema: json_schema['additionalProperties'] = False json_schema_extra = config.get('json_schema_extra')- if issubclass(cls, BaseModel) and cls.__pydantic_root_model__:- root_json_schema_extra = cls.model_fields['root'].json_schema_extra+ if root_field is not None:+ root_json_schema_extra = root_field.json_schema_extra if json_schema_extra and root_json_schema_extra: raise ValueError( '"model_config[\'json_schema_extra\']" and "Field.json_schema_extra" on "RootModel.root"'tests/test_root_model.pyindex 687ee17c..efe1bed6 100644@@ -708,6 +708,83 @@ def test_model_with_field_description() -> None: assert AModel.model_json_schema() == {'title': 'AModel', 'type': 'integer', 'description': 'abc'} +def test_model_with_field_examples_deprecated_and_title() -> None:+ class AModel(RootModel):+ root: Annotated[str, Field(examples=['foo', 'bar'], deprecated=True, title='Root Title')]++ assert AModel.model_json_schema() == {+ 'title': 'Root Title',+ 'type': 'string',+ 'examples': ['foo', 'bar'],+ 'deprecated': True,+ }+++def test_model_with_field_deprecated_message() -> None:+ class AModel(RootModel):+ root: int = Field(deprecated='Use something else')++ assert AModel.model_json_schema() == {'title': 'AModel', 'type': 'integer', 'deprecated': True}+++def test_model_with_field_examples_in_serialization_mode() -> None:+ class AModel(RootModel[int]):+ root: int = Field(examples=[1, 2])++ assert AModel.model_json_schema(mode='serialization') == {+ 'title': 'AModel',+ 'type': 'integer',+ 'examples': [1, 2],+ }+++def test_model_config_title_takes_precedence_over_field_title() -> None:+ class AModel(RootModel):+ model_config = ConfigDict(title='Config Title')++ root: int = Field(title='Field Title')++ assert AModel.model_json_schema() == {'title': 'Config Title', 'type': 'integer'}+++def test_field_title_generator_does_not_override_root_model_title() -> None:+ class AModel(RootModel):+ model_config = ConfigDict(field_title_generator=lambda name, field_info: name.upper())++ root: int++ class BModel(RootModel):+ root: int = Field(field_title_generator=lambda name, field_info: name.upper())++ assert AModel.model_json_schema() == {'title': 'AModel', 'type': 'integer'}+ assert BModel.model_json_schema() == {'title': 'BModel', 'type': 'integer'}+++def test_root_model_generic_annotated_field_title() -> None:+ assert RootModel[Annotated[int, Field(title='Root Title')]].model_json_schema() == {+ 'title': 'Root Title',+ 'type': 'integer',+ }+++def test_nested_root_model_field_attributes() -> None:+ class Inner(RootModel):+ root: Annotated[str, Field(examples=['foo'], deprecated=True, title='Inner Title')]++ class Outer(BaseModel):+ inner: Inner++ assert Outer.model_json_schema() == {+ '$defs': {+ 'Inner': {'title': 'Inner Title', 'type': 'string', 'examples': ['foo'], 'deprecated': True},+ },+ 'properties': {'inner': {'$ref': '#/$defs/Inner'}},+ 'required': ['inner'],+ 'title': 'Outer',+ 'type': 'object',+ }++ def test_model_with_both_docstring_and_field_description() -> None: """Check if the docstring is used as the description when both are present."""
pydantic/json_schema.pyindex 10d2f972e..1f76e861d 100644@@ -1649,7 +1649,10 @@ class GenerateJsonSchema: raise TypeError(f'model_title_generator {model_title_generator} must return str, not {title.__class__}') json_schema.setdefault('title', title) if 'title' not in json_schema:- json_schema['title'] = cls.__name__+ if issubclass(cls, RootModel) and (root_title := cls.__pydantic_fields__['root'].title):+ json_schema['title'] = root_title+ else:+ json_schema['title'] = cls.__name__ # BaseModel and dataclasses; don't use cls.__doc__ as it will contain the verbose class signature by default if cls is BaseModel:@@ -1670,6 +1673,13 @@ class GenerateJsonSchema: elif issubclass(cls, RootModel) and (root_description := cls.__pydantic_fields__['root'].description): json_schema.setdefault('description', root_description) + if issubclass(cls, RootModel):+ root_field = cls.__pydantic_fields__['root']+ if root_field.examples is not None:+ json_schema.setdefault('examples', to_jsonable_python(root_field.examples))+ if root_field.deprecated:+ json_schema['deprecated'] = True+ extra = config.get('extra') if 'additionalProperties' not in json_schema: # This check is particularly important for `typed_dict_schema()` if extra == 'allow':tests/test_root_model.pyindex 687ee17c8..60e36c338 100644@@ -721,3 +721,44 @@ def test_model_with_both_docstring_and_field_description() -> None: 'type': 'integer', 'description': 'More detailed description', }+++def test_model_json_schema_field_examples() -> None:+ class AModel(RootModel):+ root: str = Field(examples=['foo', 'bar'])++ assert AModel.model_json_schema() == {'title': 'AModel', 'type': 'string', 'examples': ['foo', 'bar']}+++def test_model_json_schema_field_deprecated() -> None:+ class AModel(RootModel):+ root: str = Field(deprecated=True)++ assert AModel.model_json_schema() == {'title': 'AModel', 'type': 'string', 'deprecated': True}+++def test_model_json_schema_field_title() -> None:+ class AModel(RootModel):+ root: str = Field(title='My Title')++ assert AModel.model_json_schema() == {'title': 'My Title', 'type': 'string'}+++def test_model_json_schema_field_title_overridden_by_config() -> None:+ class AModel(RootModel):+ model_config = ConfigDict(title='Config Title')+ root: str = Field(title='Field Title')++ assert AModel.model_json_schema() == {'title': 'Config Title', 'type': 'string'}+++def test_model_json_schema_field_examples_and_deprecated_together() -> None:+ class AModel(RootModel):+ root: Annotated[str, Field(examples=['foo'], deprecated=True)]++ assert AModel.model_json_schema() == {+ 'title': 'AModel',+ 'type': 'string',+ 'examples': ['foo'],+ 'deprecated': True,+ }