Index

A

add_attribute_function() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) add_parameter_attribute_function() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) apispec module APISpec (class in apispec) apispec.core module apispec.exceptions module apispec.ext.marshmallow module

apispec.ext.marshmallow.common module apispec.ext.marshmallow.field_converter module apispec.ext.marshmallow.openapi module apispec.ext.marshmallow.schema_resolver module apispec.utils module APISpecError

B

BasePlugin (class in apispec)

build_reference() (in module apispec.utils)

C

Components (class in apispec.core)

Converter (apispec.ext.marshmallow.MarshmallowPlugin attribute)

D

datetime2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) dedent() (in module apispec.utils) deepupdate() (in module apispec.utils)

dict2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) DuplicateComponentNameError DuplicateParameterError

E

enum2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method)

example() (apispec.core.Components method)

F

field2choices() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2default() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2length() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2nullable() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2pattern() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2property() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2range() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method)

field2read_only() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2required() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) field2type_and_format() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) field2write_only() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) FieldConverterMixin (class in apispec.ext.marshmallow.field_converter) fields2jsonschema() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) filter_excluded_fields() (in module apispec.ext.marshmallow.common)

G

get_fields() (in module apispec.ext.marshmallow.common) get_ref() (apispec.core.Components method)

get_ref_dict() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) get_unique_schema_name() (in module apispec.ext.marshmallow.common)

H

header() (apispec.core.Components method)

header_helper() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method)

I

init_spec() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method)

InvalidParameterError

L

link() (apispec.core.Components method)

list2param() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) list2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method)

M

make_min_max_attributes() (in module apispec.ext.marshmallow.field_converter) make_type_list() (in module apispec.ext.marshmallow.field_converter) map_to_openapi_type() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) (apispec.ext.marshmallow.MarshmallowPlugin method) MarshmallowPlugin (class in apispec.ext.marshmallow) metadata2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) module apispec apispec.core apispec.exceptions apispec.ext.marshmallow apispec.ext.marshmallow.common apispec.ext.marshmallow.field_converter apispec.ext.marshmallow.openapi apispec.ext.marshmallow.schema_resolver apispec.utils

N

nested2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method)

O

OpenAPIConverter (class in apispec.ext.marshmallow.openapi) OpenAPIError

operation_helper() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method)

P

parameter() (apispec.core.Components method) parameter_helper() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method)

path() (apispec.APISpec method) path_helper() (apispec.BasePlugin method) pluck2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method) PluginMethodNotImplementedError

R

resolve_callback() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_nested_schema() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) resolve_operations() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_parameters() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_response() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_schema() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_schema_cls() (in module apispec.ext.marshmallow.common)

resolve_schema_dict() (apispec.ext.marshmallow.schema_resolver.SchemaResolver method) resolve_schema_instance() (in module apispec.ext.marshmallow.common) Resolver (apispec.ext.marshmallow.MarshmallowPlugin attribute) resolver() (in module apispec.ext.marshmallow) response() (apispec.core.Components method) response_helper() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method)

S

schema() (apispec.core.Components method) schema2jsonschema() (apispec.ext.marshmallow.openapi.OpenAPIConverter method) schema2parameters() (apispec.ext.marshmallow.openapi.OpenAPIConverter method)

schema_helper() (apispec.BasePlugin method) (apispec.ext.marshmallow.MarshmallowPlugin method) SchemaResolver (class in apispec.ext.marshmallow.schema_resolver) security_scheme() (apispec.core.Components method)

T

tag() (apispec.APISpec method) timedelta2properties() (apispec.ext.marshmallow.field_converter.FieldConverterMixin method)

to_yaml() (apispec.APISpec method) trim_docstring() (in module apispec.utils)

W

warn_if_fields_defined_in_meta() (in module apispec.ext.marshmallow.common)

warn_if_schema_already_in_spec() (apispec.ext.marshmallow.MarshmallowPlugin method)