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

Add description to Pydantic model fields using Field type #22

Open
kkaris opened this issue Nov 10, 2021 · 0 comments
Open

Add description to Pydantic model fields using Field type #22

kkaris opened this issue Nov 10, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@kkaris
Copy link
Contributor

kkaris commented Nov 10, 2021

By using Pydantic's Field type, it's possible to add a description of the field which can be nice in case the field name is not enough. It's already done for the BaseModels in indra_network_search.data_model.rest_models.

See also: https://pydantic-docs.helpmanual.io/usage/schema/#typingannotated-fields
@kkaris kkaris added the enhancement New feature or request label Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kkaris