target.example_autosummary.AutoSummaryModel

pydantic model target.example_autosummary.AutoSummaryModel

Document your project settings very conveniently. Applies like wise to pydantic models.

Show JSON schema

{
   "title": "AutoSummaryModel",
   "description": "Document your project settings very conveniently. Applies like wise\nto pydantic models.",
   "type": "object",
   "properties": {
      "field_plain_with_validator": {
         "title": "Field Plain With Validator",
         "default": 200,
         "type": "integer"
      },
      "BarFoo": {
         "title": "Barfoo",
         "default": "FooBar",
         "type": "string"
      },
      "field_with_constraints_and_description": {
         "title": "Field With Constraints And Description",
         "description": "Shows constraints within doc string.",
         "default": 5,
         "minimum": 0,
         "maximum": 100,
         "type": "integer"
      }
   }
}

Config

• allow_mutation: bool = True

• env_prefix: str = foo_

Fields

• field_plain_with_validator (int)

• field_with_validator_and_alias (str)

• field_with_constraints_and_description (int)

Validators

• check_max_length_ten » field_with_validator_and_alias

• check_max_length_ten » field_plain_with_validator

field field_plain_with_validator: int = 200

Show standard field with type annotation.

Validated by

• check_max_length_ten

field field_with_constraints_and_description: int = 5

Shows constraints within doc string.

Constraints

• minimum = 0

• maximum = 100

field field_with_validator_and_alias: str = 'FooBar' (alias 'BarFoo')

Shows corresponding validator with link/anchor.

Validated by

• check_max_length_ten

validator check_max_length_ten  »  field_with_validator_and_alias, field_plain_with_validator

Show corresponding field with link/anchor.