Skip to content

octoprint.vendor.with_attrs_docs#

apply_attributes_docs(model: Type[BaseModel], override_existing: bool = True) -> None #

Apply model attributes documentation in-place. Resulted docs are placed inside :code:field.schema.description for pydantic model field. :param model: any pydantic model :param override_existing: override existing descriptions

with_attrs_docs(model_cls: Type[BaseModel]) -> Type[BaseModel] #

Applies 🇵🇾func:.apply_attributes_docs.