pydantic-core icon indicating copy to clipboard operation
pydantic-core copied to clipboard

Allow `description` key on all schemas

Open samuelcolvin opened this issue 3 years ago • 2 comments

We should allow an extra no-op description key on all schemas which can be anything and should be stored along-side the validator somehow, useful for reviewing schemas and understanding bugs.

We already do this in generate_self_schema.py.

samuelcolvin avatar Sep 12 '22 11:09 samuelcolvin

Probably a good first issue

PrettyWood avatar Sep 16 '22 09:09 PrettyWood

For anyone coming to this and wanting to work on it, best to ask here about the best approach (and/or propose an approach) before getting started as there are a few different ways to go with this.

samuelcolvin avatar Sep 16 '22 09:09 samuelcolvin