Skip to content
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

Jump to bottom

Allow description key on all schemas #238

Closed
samuelcolvin opened this issue Sep 12, 2022 · 2 comments · Fixed by #292
Closed

Allow description key on all schemas #238

samuelcolvin opened this issue Sep 12, 2022 · 2 comments · Fixed by #292

Comments

@samuelcolvin
Copy link
Member

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.
@PrettyWood
Copy link
Collaborator

Probably a good first issue

@samuelcolvin samuelcolvin added the good first issue Good for newcomers label Sep 16, 2022
@samuelcolvin
Copy link
Member Author

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 samuelcolvin removed the good first issue Good for newcomers label Sep 29, 2022
samuelcolvin added a commit that referenced this issue Oct 14, 2022
@samuelcolvin
add extra to schema, fix #238
8e908e2
@samuelcolvin samuelcolvin mentioned this issue Oct 14, 2022
Merged
samuelcolvin added a commit that referenced this issue Oct 16, 2022
@samuelcolvin
add extra to schema, fix #238
6dafe41
samuelcolvin added a commit that referenced this issue Oct 16, 2022
@samuelcolvin
Schema extra (#292)
ad12e47 
* add extra to schema, fix #238

* remove validator_instance, switch arg order on function_after

* switch all schema typeddicts to total=False
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Schema extra pydantic/pydantic-core
2 participants
@samuelcolvin @PrettyWood