Skip to content

OpenAPI Specification

pydantictornado.openapi.OpenAPIDocument

add_tag(name, description=None)

Add a tag to the document.

:raises ValueError: if a tag with the same name exists

tag_operation(rule, http_method, *tags)

Tag an operation.

This method will add Tag instances from the tags argument to the document. If a str is passed, it will search for the tag in the document. If the tag is not found, raises a ValueError.

:raises ValueError: if a tag string is not found :seealso: add_tag

pydantictornado.models.OpenAPI

Bases: FieldOmittingMixin, BaseModel

pydantictornado.models.Operation

Bases: FieldOmittingMixin, BaseModel

pydantictornado.models.Tag

Bases: FieldOmittingMixin, BaseModel