Index

A

add_tags() (openapilib.spec.Operation method) additional_items (openapilib.spec.Schema attribute) additional_properties (openapilib.spec.Schema attribute) all_of (openapilib.spec.Schema attribute)

allow_empty_value (openapilib.spec.Parameter attribute) any_of (openapilib.spec.Schema attribute) attr_registry() (in module openapilib.spec) attr_required() (in module openapilib.spec) attr_skippable() (in module openapilib.spec)

C

callbacks (openapilib.spec.Components attribute) component_type_for_spec() (openapilib.spec.Components static method) Components (class in openapilib.spec) components (openapilib.serialization.SerializationContext attribute) (openapilib.spec.OpenAPI attribute) ComponentType (class in openapilib.spec)

Contact (class in openapilib.spec) contact (openapilib.spec.Info attribute) content (openapilib.spec.RequestBody attribute) (openapilib.spec.Response attribute) COOKIE (openapilib.spec.ParameterLocation attribute) create_registry_for_spec() (openapilib.spec.Components method)

D

DATETIME (openapilib.spec.StringFormat attribute) default (openapilib.spec.Schema attribute) definitions (openapilib.spec.Schema attribute) delete (openapilib.spec.PathItem attribute) deprecated (openapilib.spec.Parameter attribute) description (openapilib.spec.Info attribute) (openapilib.spec.Operation attribute) (openapilib.spec.Parameter attribute) (openapilib.spec.PathItem attribute) (openapilib.spec.RequestBody attribute) (openapilib.spec.Response attribute) (openapilib.spec.Schema attribute)

disable_referencing (openapilib.serialization.SerializationContext attribute)

E

email (openapilib.spec.Contact attribute) EMAIL (openapilib.spec.StringFormat attribute) enum_to_string() (in module openapilib.spec) example (openapilib.spec.MediaType attribute) (openapilib.spec.Schema attribute)

examples (openapilib.spec.Components attribute) (openapilib.spec.Schema attribute) exclusive_maximum (openapilib.spec.Schema attribute) exclusive_minimum (openapilib.spec.Schema attribute) exists() (openapilib.spec.Components method) external_docs (openapilib.spec.OpenAPI attribute)

F

filter_attributes() (in module openapilib.serialization) format (openapilib.spec.Schema attribute) from_builtin_simple_type() (openapilib.spec.Schema class method)

from_properties() (openapilib.spec.Schema class method) from_type() (openapilib.spec.Schema class method) from_type_hint() (openapilib.spec.Schema class method) from_user_type() (openapilib.spec.Schema class method)

G

get (openapilib.spec.PathItem attribute) get_ref() (openapilib.spec.Components method)

get_ref_str() (openapilib.spec.Components method) get_registry_for_spec() (openapilib.spec.Components method) get_stored() (openapilib.spec.Components method)

H

head (openapilib.spec.PathItem attribute) HEADER (openapilib.spec.ParameterLocation attribute)

headers (openapilib.spec.Components attribute) HOSTNAME (openapilib.spec.StringFormat attribute)

I

in_ (openapilib.spec.Parameter attribute) Info (class in openapilib.spec) info (openapilib.spec.OpenAPI attribute)

IPV4 (openapilib.spec.StringFormat attribute) IPV6 (openapilib.spec.StringFormat attribute) items (openapilib.spec.Schema attribute)

J

JSON_POINTER (openapilib.spec.StringFormat attribute)

L

License (class in openapilib.spec)

license (openapilib.spec.Info attribute) links (openapilib.spec.Components attribute)

M

max_length (openapilib.spec.Schema attribute) maximum (openapilib.spec.Schema attribute) MediaType (class in openapilib.spec)

min_length (openapilib.spec.Schema attribute) minimum (openapilib.spec.Schema attribute) multiple_of (openapilib.spec.Schema attribute)

N

name (openapilib.spec.Contact attribute) (openapilib.spec.License attribute) (openapilib.spec.Parameter attribute)

not_ (openapilib.spec.Schema attribute)

O

one_of (openapilib.spec.Schema attribute) OpenAPI (class in openapilib.spec) openapi (openapilib.spec.OpenAPI attribute) openapilib (module) openapilib.sentinel (module)

openapilib.serialization (module) openapilib.spec (module) Operation (class in openapilib.spec) operation_id (openapilib.spec.Operation attribute) options (openapilib.spec.PathItem attribute)

P

Parameter (class in openapilib.spec) ParameterLocation (class in openapilib.spec) parameters (openapilib.spec.Components attribute) (openapilib.spec.Operation attribute) (openapilib.spec.PathItem attribute) patch (openapilib.spec.PathItem attribute)

PATH (openapilib.spec.ParameterLocation attribute) PathItem (class in openapilib.spec) paths (openapilib.spec.OpenAPI attribute) pattern (openapilib.spec.Schema attribute) post (openapilib.spec.PathItem attribute) properties (openapilib.spec.Schema attribute) put (openapilib.spec.PathItem attribute)

Q

QUERY (openapilib.spec.ParameterLocation attribute)

R

read_only (openapilib.spec.Schema attribute) ref (openapilib.spec.Reference attribute) Reference (class in openapilib.spec) rename_key() (in module openapilib.serialization) request_bodies (openapilib.spec.Components attribute) request_body (openapilib.spec.Operation attribute)

RequestBody (class in openapilib.spec) REQUIRED (in module openapilib.spec) required (openapilib.spec.Parameter attribute) (openapilib.spec.Schema attribute) Response (class in openapilib.spec) responses (openapilib.spec.Components attribute) (openapilib.spec.Operation attribute)

S

Schema (class in openapilib.spec) schema (openapilib.spec.MediaType attribute) (openapilib.spec.Parameter attribute) SchemaHelperError SchemaHelperUnhandled schemas (openapilib.spec.Components attribute) security (openapilib.spec.OpenAPI attribute) security_schemas (openapilib.spec.Components attribute) Sentinel (class in openapilib.sentinel) SerializationContext (class in openapilib.serialization) serialize() (in module openapilib.serialization) (openapilib.serialization.SerializationContext method)

serialize_maybe_reference() (openapilib.serialization.SerializationContext method) serialize_spec() (in module openapilib) (in module openapilib.serialization) serialize_value() (openapilib.serialization.SerializationContext method) servers (openapilib.spec.OpenAPI attribute) SKIP (in module openapilib.spec) spec_to_dict() (in module openapilib.serialization) store() (openapilib.spec.Components method) StringFormat (class in openapilib.spec) summary (openapilib.spec.Operation attribute) (openapilib.spec.PathItem attribute)

T

T_Component (in module openapilib.spec) tags (openapilib.spec.OpenAPI attribute) (openapilib.spec.Operation attribute)

terms_of_service (openapilib.spec.Info attribute) title (openapilib.spec.Info attribute) (openapilib.spec.Schema attribute) trace (openapilib.spec.PathItem attribute)

U

URI (openapilib.spec.StringFormat attribute) URI_REFERENCE (openapilib.spec.StringFormat attribute)

URI_TEMPLATE (openapilib.spec.StringFormat attribute) url (openapilib.spec.Contact attribute) (openapilib.spec.License attribute)

V

validate_required() (in module openapilib.spec)

version (openapilib.spec.Info attribute)

W

write_only (openapilib.spec.Schema attribute)