Index

A

additional_properties (flask_swag.schemas.SchemaSchema attribute) all_of (flask_swag.schemas.SchemaSchema attribute)

allow_empty_value (flask_swag.schemas.ParameterSchema attribute) args (flask_swag.extractor.base.WerkzeugConverter attribute)

B

base_path (flask_swag.schemas.SwaggerSchema attribute)

build_parameters() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) (flask_swag.extractor.MarkExtractor method) (flask_swag.extractor.mark.MarkExtractor method)

C

collect_endpoints() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) collection_format (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) compose() (in module flask_swag.utils) consumes (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) contact (flask_swag.schemas.InfoSchema attribute)

Contact() (in module flask_swag.core) ContactSchema (class in flask_swag.schemas) convert_annotation() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) convert_werkzeug_converter() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) converter (flask_swag.extractor.base.WerkzeugConverter attribute)

D

default (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.SchemaSchema attribute) default_path_param() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) definitions (flask_swag.schemas.SwaggerSchema attribute) delete (flask_swag.schemas.PathItemSchema attribute) deprecated (flask_swag.schemas.OperationSchema attribute) description (flask_swag.schemas.ExternalDocumentationSchema attribute) (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.InfoSchema attribute) (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.ResponseSchema attribute) (flask_swag.schemas.SchemaSchema attribute)

description() (flask_swag.mark.Mark method) description_from_docstring() (flask_swag.mark.Mark method) discriminator (flask_swag.schemas.SchemaSchema attribute) dump() (in module flask_swag.core) dump_formencode() (in module flask_swag.ext) dump_marshmallow() (in module flask_swag.ext)

E

email (flask_swag.schemas.ContactSchema attribute) enum (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) example (flask_swag.schemas.SchemaSchema attribute) examples (flask_swag.schemas.HeaderSchema attribute) exclusive_maximum (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) exclusive_minimum (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) external_docs (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.SchemaSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) ExternalDocumentation() (in module flask_swag.core)

ExternalDocumentationSchema (class in flask_swag.schemas) extract_description() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) extract_others() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) (flask_swag.extractor.MarkExtractor method) (flask_swag.extractor.mark.MarkExtractor method) extract_param() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) extract_paths() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) extract_responses() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) (flask_swag.extractor.MarkExtractor method) (flask_swag.extractor.mark.MarkExtractor method) extract_summary() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) Extractor (class in flask_swag.extractor) (class in flask_swag.extractor.base)

F

flask_swag (module) flask_swag.core (module) flask_swag.ext (module) flask_swag.extractor (module) flask_swag.extractor.base (module) flask_swag.extractor.mark (module) flask_swag.fields (module)

flask_swag.globals (module) flask_swag.mark (module) flask_swag.schemas (module) flask_swag.utils (module) form() (flask_swag.mark.Mark method) format (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) formencode() (flask_swag.mark.Mark method)

G

generate_swagger() (flask_swag.Swag method) get (flask_swag.schemas.PathItemSchema attribute) get_attribute() (flask_swag.schemas.MappingSchema method)

get_mark() (flask_swag.extractor.mark.MarkExtractor method) (flask_swag.extractor.MarkExtractor method) get_swag() (flask_swag.mark.Mark method) get_type_base() (in module flask_swag.utils)

H

head (flask_swag.schemas.PathItemSchema attribute) Header() (in module flask_swag.core) headers (flask_swag.schemas.ResponseSchema attribute)

HeaderSchema (class in flask_swag.schemas) host (flask_swag.schemas.SwaggerSchema attribute)

I

in_ (flask_swag.schemas.ParameterSchema attribute) info (flask_swag.schemas.SwaggerSchema attribute) Info() (in module flask_swag.core) InfoSchema (class in flask_swag.schemas) init_app() (flask_swag.Swag method)

inject_swagger_url() (flask_swag.Swag method) item (flask_swag.extractor.base.PathAndPathItem attribute) items (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) Items() (in module flask_swag.core) ItemsSchema (class in flask_swag.schemas)

K

kwargs (flask_swag.extractor.base.WerkzeugConverter attribute)

L

license (flask_swag.schemas.InfoSchema attribute) License() (in module flask_swag.core)

LicenseSchema (class in flask_swag.schemas)

M

make_blueprint() (flask_swag.Swag method) make_dict_factory() (in module flask_swag.core) make_operation() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) make_path_item() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) MappingSchema (class in flask_swag.schemas) Mark (class in flask_swag.mark) MarkExtractor (class in flask_swag.extractor) (class in flask_swag.extractor.mark) marshmallow() (flask_swag.mark.Mark method) max_items (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) max_length (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute)

max_properties (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.SchemaSchema attribute) maximum (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) merge() (in module flask_swag.utils) merge_swag() (flask_swag.mark.Mark method) min_items (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) min_length (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) min_properties (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.SchemaSchema attribute) minimum (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) multiple_of (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute)

N

name (flask_swag.schemas.ContactSchema attribute) (flask_swag.schemas.LicenseSchema attribute) (flask_swag.schemas.ParameterSchema attribute)

normalize_indent() (in module flask_swag.utils)

O

Operation() (in module flask_swag.core) operation_id (flask_swag.schemas.OperationSchema attribute) OperationSchema (class in flask_swag.schemas)

options (flask_swag.schemas.PathItemSchema attribute) opts (flask_swag.schemas.ContactSchema attribute) (flask_swag.schemas.ExternalDocumentationSchema attribute) (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.InfoSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.LicenseSchema attribute) (flask_swag.schemas.MappingSchema attribute) (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.PathItemSchema attribute) (flask_swag.schemas.ResponseSchema attribute) (flask_swag.schemas.SchemaSchema attribute) (flask_swag.schemas.SwaggerSchema attribute)

P

parameter() (flask_swag.mark.Mark method) Parameter() (in module flask_swag.core) parameters (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.PathItemSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) parameters_from_object_schema() (in module flask_swag.core) ParameterSchema (class in flask_swag.schemas) params (flask_swag.extractor.base.PathAndParams attribute) parse_endpoint() (in module flask_swag.utils) parse_werkzeug_rule() (flask_swag.extractor.base.Extractor method) (flask_swag.extractor.Extractor method) patch (flask_swag.schemas.PathItemSchema attribute) path (flask_swag.extractor.base.PathAndParams attribute) (flask_swag.extractor.base.PathAndPathItem attribute)

PathAndParams (class in flask_swag.extractor.base) PathAndPathItem (class in flask_swag.extractor.base) PathItem() (in module flask_swag.core) PathItemSchema (class in flask_swag.schemas) paths (flask_swag.schemas.SwaggerSchema attribute) pattern (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) post (flask_swag.schemas.PathItemSchema attribute) produces (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) properties (flask_swag.schemas.SchemaSchema attribute) put (flask_swag.schemas.PathItemSchema attribute)

Q

query() (flask_swag.mark.Mark method)

R

read_only (flask_swag.schemas.SchemaSchema attribute) ref (flask_swag.schemas.SchemaSchema attribute) register_blueprint() (flask_swag.Swag method) required (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) RESOURCES_DIR (in module flask_swag.globals)

response() (flask_swag.mark.Mark method) Response() (in module flask_swag.core) responses (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) ResponseSchema (class in flask_swag.schemas) ROOT_DIR (in module flask_swag.globals)

S

schema (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.ResponseSchema attribute) schema() (flask_swag.mark.Mark method) Schema() (in module flask_swag.core) SchemaSchema (class in flask_swag.schemas) schemes (flask_swag.schemas.OperationSchema attribute) (flask_swag.schemas.SwaggerSchema attribute) set_swag() (flask_swag.mark.Mark method) simple_param() (flask_swag.mark.Mark method) summary (flask_swag.schemas.OperationSchema attribute)

summary() (flask_swag.mark.Mark method) summary_from_docstring() (flask_swag.mark.Mark method) Swag (class in flask_swag) swag() (flask_swag.mark.Mark method) Swagger() (in module flask_swag.core) SWAGGER_UI_DIR (in module flask_swag.globals) SwaggerSchema (class in flask_swag.schemas)

T

tags (flask_swag.schemas.OperationSchema attribute) terms_of_service (flask_swag.schemas.InfoSchema attribute) title (flask_swag.schemas.InfoSchema attribute) (flask_swag.schemas.SchemaSchema attribute)

type (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) TypedDict (class in flask_swag.fields)

U

unique_items (flask_swag.schemas.HeaderSchema attribute) (flask_swag.schemas.ItemsSchema attribute) (flask_swag.schemas.ParameterSchema attribute) (flask_swag.schemas.SchemaSchema attribute) update_swag() (flask_swag.mark.Mark method)

url (flask_swag.schemas.ContactSchema attribute) (flask_swag.schemas.ExternalDocumentationSchema attribute) (flask_swag.schemas.LicenseSchema attribute)

V

version (flask_swag.schemas.InfoSchema attribute) (flask_swag.schemas.SwaggerSchema attribute)

W

WerkzeugConverter (class in flask_swag.extractor.base)

X

xml (flask_swag.schemas.SchemaSchema attribute)