target.usage_autosummary.AutoSummaryModel

pydantic model AutoSummaryModel[source]

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": {
         "default": 200,
         "title": "Field Plain With Validator",
         "type": "integer"
      },
      "BarFoo": {
         "default": "FooBar",
         "title": "Barfoo",
         "type": "string"
      },
      "field_with_constraints_and_description": {
         "default": 5,
         "description": "Shows constraints within doc string.",
         "maximum": 100,
         "minimum": 0,
         "title": "Field With Constraints And Description",
         "type": "integer"
      }
   }
}

Config:

  • frozen: bool = False

Fields:
Validators:
field field_plain_with_validator: int = 200

Show standard field with type annotation.

Validated by:
field field_with_constraints_and_description: int = 5

Shows constraints within doc string.

Constraints:

  • ge = 0

  • le = 100

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

Shows corresponding validator with link/anchor.

Validated by:
validator check_max_length_ten  Β»  field_plain_with_validator, field_with_validator_and_alias[source]

Show corresponding field with link/anchor.