OpenApiGeneratorModel

pydantic model documenteer.conf._toml.OpenApiGeneratorModel

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

Parameters:

data (Any)

Show JSON schema

{
   "title": "OpenApiGeneratorModel",
   "description": "Specification for the OpenAPI generator function used by the\n``documenteer.ext.openapi`` Sphinx extension.",
   "type": "object",
   "properties": {
      "function": {
         "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.",
         "title": "Function",
         "type": "string"
      },
      "positional_args": {
         "description": "Positional arguments to pass to the generator function.",
         "items": {},
         "title": "Positional Args",
         "type": "array"
      },
      "keyword_args": {
         "additionalProperties": true,
         "description": "Keyword arguments to pass to the generator function.",
         "title": "Keyword Args",
         "type": "object"
      }
   },
   "required": [
      "function"
   ]
}

Fields:

• function (str)

• keyword_args (dict[str, Any])

• positional_args (list[Any])

field function: str [Required]

The Python function that generates the OpenAPI spec file. It must have the form module:func. The function must return a JSON-serialized string.

field keyword_args: dict[str, Any] [Optional]

Keyword arguments to pass to the generator function.

field positional_args: list[Any] [Optional]

Positional arguments to pass to the generator function.