OpenApiGeneratorModel

class documenteer.conf._toml.OpenApiGeneratorModel(**data)

Bases: BaseModel

Specification for the OpenAPI generator function used by the documenteer.ext.openapi Sphinx extension.

Parameters:

data (Any) –

Attributes Summary

model_computed_fields	A dictionary of computed field names and their corresponding ComputedFieldInfo objects.
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_fields	Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

Attributes Documentation

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'function': FieldInfo(annotation=str, required=True, description='The Python function that generates the OpenAPI spec file. It must have the form ``module:func``. The function must return a JSON-serialized string.'), 'keyword_args': FieldInfo(annotation=Dict[str, Any], required=False, default_factory=dict, description='Keyword arguments to pass to the generator function.'), 'positional_args': FieldInfo(annotation=List[Any], required=False, default_factory=list, description='Positional arguments to pass to the generator function.')}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.