Field title with same name as model class leads to unexpected schema behavior about pydantic HOT 2 CLOSED

Hi,

Out of my own curiosity, I decided to do a little investigation ... It turns out that the event of the unexpected deletion in your example happens in the handle_ref_overrides method of the GenerateJsonSchema class (link to the exact line).

The documentation of the method partially explains a notion of deleting sibling keys (here key title with value "MyInnerModel" in inner_1 and MyInnerModel). I am not fluent in the doings of the Pydantic's schema generation so unfortunately I can't provide you with explanation nor fix.

Since I spend some time on this issue I will try to delve into this topic if I find some free time and no one else has addressed your question yet 🙂

But at the moment, my money is on this being an expected behavior. I believe that what the Field(title="...") does is some kind of renaming of the title of MyInnerModel type, which by default is a class' name. The title of the MyInnerModel type in the inner_1 is handled by the $ref to the MyInnerModel class, hence the missing "title" key in the schema["properties"]["inner_1"].

from pydantic.

Hi folks!

I believe @antoni-jamiolkowski is on the right track here - I think this is the expected behavior - the title is by default the class name, so during JSON schema generation, we remove redundant title information. I think if you want to retain the redundancy, custom JSON schema generation would be the best route to go for now!

from pydantic.