dbinfrago / dbinfrago/capella-collab-manager

Improve API documentation with pydantic fields

Open
#1,327 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Python
Stars
37
Forks
6
PR merge metrics
No merged PRs in 30d

Description

To improve the API documentation, each pydantic attribute should have a `pydantic.Field` as default value, which has the attributes "description" and "examples". In addition, the validation can be strengthened with min_len, max_len and pattern attributes.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.