Index

A

additional_properties (Schema attribute) all_of (Schema attribute) allow_inf_nan (AllowInfNan attribute) (Field attribute) AllowInfNan (class in flask_jsonrpc.types.params) AnnotatedMetadataAutoGenerated (class in flask_jsonrpc.types.types) AnnotatedMetadataTypeError

annotations (Properties attribute) any_of (Schema attribute) APIKeyAuth (class in flask_jsonrpc.contrib.openrpc.typing) app_jinja_loader (JSONRPCBrowseTemplateLoader attribute) ARRAY (SchemaDataType attribute) AUTHORIZATION_CODE (OAuth2FlowType attribute) authorization_url (OAuth2Flow attribute) auto_generated (AnnotatedMetadataAutoGenerated attribute)

B

base_url (JSONRPC attribute), [1] (JSONRPCBrowse attribute) (JSONRPCSite attribute) BaseAnnotatedMetadata (class in flask_jsonrpc.types.params) BaseMethodAnnotatedMetadata (class in flask_jsonrpc.types.methods) BaseMethodAnnotatedOrigin (class in flask_jsonrpc.types.methods) BaseModel (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.contrib.openrpc.utils) (class in flask_jsonrpc.typing)

batch_dispatch() (JSONRPCSite method) BearerAuth (class in flask_jsonrpc.contrib.openrpc.typing) bindfy() (in module flask_jsonrpc.funcutils) BOOLEAN (SchemaDataType attribute) browse_jinja_loader (JSONRPCBrowseTemplateLoader attribute) build_package_tree() (in module flask_jsonrpc.contrib.browse) BY_NAME (ParamStructure attribute) BY_POSITION (ParamStructure attribute)

C

check_type() (JSONRPCNewType method) CLIENT_CREDENTIALS (OAuth2FlowType attribute) code (Error attribute), [1], [2] (JSONRPCError attribute) Components (class in flask_jsonrpc.contrib.openrpc.typing) components (OpenRPCSchema attribute)

CONFIG_TO_ENV() (in module flask_jsonrpc.conf.global_settings) const (Schema attribute) Contact (class in flask_jsonrpc.contrib.openrpc.typing) contact (Info attribute) contains (Schema attribute) content_descriptors (Components attribute) ContentDescriptor (class in flask_jsonrpc.contrib.openrpc.typing)

D

data (Error attribute), [1], [2] (JSONRPCError attribute) decimal_places (DecimalPlaces attribute) (Field attribute) DecimalPlaces (class in flask_jsonrpc.types.params) default (Schema attribute) (ServerVariable attribute) default_jsonrpc_site (in module flask_jsonrpc.globals) default_jsonrpc_site_api (in module flask_jsonrpc.globals) DefaultTypeCheckMixin (class in flask_jsonrpc.types.params) defs (Schema attribute) dependent_required (Schema attribute) dependent_schemas (Schema attribute) Deprecated (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.types.params) deprecated (ContentDescriptor attribute) (Deprecated attribute), [1] (Field attribute) (Method attribute), [1] (MethodExtendSchema attribute) (Schema attribute) describe (JSONRPCSite attribute)

description (APIKeyAuth attribute) (BearerAuth attribute) Description (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.types.params) description (ContentDescriptor attribute) (Description attribute), [1] (Example attribute), [1], [2] (ExampleField attribute), [1] (ExamplePairing attribute) (ExternalDocumentation attribute) (Field attribute) (Info attribute) (Link attribute) (Method attribute), [1] (MethodExtendSchema attribute) (OAuth2 attribute) (Schema attribute) (Server attribute), [1] (ServerVariable attribute) (ServiceDescribe attribute) (Tag attribute), [1] dispatch() (JSONRPCSite method) dispatch_request() (JSONRPCSite method)

E

EITHER (ParamStructure attribute) else_ (Schema attribute) email (Contact attribute) enable_web_browsable_api (JSONRPC attribute), [1] enum (Schema attribute) (ServerVariable attribute) ENV_TO_CONFIG() (in module flask_jsonrpc.conf.global_settings) Err (class in flask_jsonrpc.types.params) Error (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.typing) error_handlers (JSONRPCSite attribute) errorhandler() (JSONRPCDecoratorMixin method) errors (Components attribute) (Method attribute), [1] (MethodExtendSchema attribute) Example (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.types.params) (class in flask_jsonrpc.typing)

example_pairing_objects (Components attribute) ExampleField (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.typing) ExamplePairing (class in flask_jsonrpc.contrib.openrpc.typing) examples (Components attribute) (Field attribute) (Method attribute), [1] (MethodExtendSchema attribute) (Schema attribute) exclusive_maximum (Schema attribute) exclusive_minimum (Schema attribute) extend_schema() (in module flask_jsonrpc.contrib.openrpc.utils) (OpenRPCExtendSchemaDecoratorMixin method) external_docs (Method attribute) (MethodExtendSchema attribute) (OpenRPCSchema attribute) (Tag attribute) external_value (Example attribute) ExternalDocumentation (class in flask_jsonrpc.contrib.openrpc.typing) extract_digits_and_decimals() (in module flask_jsonrpc.types.params)

F

Field (class in flask_jsonrpc.typing) flask_jsonrpc module flask_jsonrpc.app module flask_jsonrpc.blueprints module flask_jsonrpc.conf module flask_jsonrpc.conf.global_settings module flask_jsonrpc.contrib module flask_jsonrpc.contrib.browse module flask_jsonrpc.contrib.openrpc module flask_jsonrpc.contrib.openrpc.methods module flask_jsonrpc.contrib.openrpc.typing module flask_jsonrpc.contrib.openrpc.utils module flask_jsonrpc.contrib.openrpc.wrappers module flask_jsonrpc.descriptor module flask_jsonrpc.encoders module

flask_jsonrpc.exceptions module flask_jsonrpc.funcutils module flask_jsonrpc.globals module flask_jsonrpc.site module flask_jsonrpc.types module flask_jsonrpc.types.methods module flask_jsonrpc.types.params module flask_jsonrpc.types.types module flask_jsonrpc.typing module flask_jsonrpc.utils module flask_jsonrpc.views module flask_jsonrpc.wrappers module flows (OAuth2 attribute) format (Schema attribute) from_rpc_describe_type() (SchemaDataType static method)

G

get_browse_dashboard_menu_name() (JSONRPCBrowse method) get_browse_dashboard_partial_template() (JSONRPCBrowse method) get_browse_description() (JSONRPCBrowse method) get_browse_fork_me_button_enabled() (JSONRPCBrowse method) get_browse_login_template() (JSONRPCBrowse method) get_browse_logout_template() (JSONRPCBrowse method) get_browse_media_css() (JSONRPCBrowse method) get_browse_media_js() (JSONRPCBrowse method) get_browse_subtitle() (JSONRPCBrowse method)

get_browse_title() (JSONRPCBrowse method) get_browse_title_url() (JSONRPCBrowse method) get_jsonrpc_site() (JSONRPC method), [1] (JSONRPCBlueprint method), [1] (JSONRPCDecoratorMixin method) get_jsonrpc_site_api() (JSONRPC method), [1] (JSONRPCBlueprint method), [1] (JSONRPCDecoratorMixin method) get_source() (JSONRPCBrowseTemplateLoader method)

H

handle_dispatch_except() (JSONRPCSite method)

handle_exception() (JSONRPCSite method) handle_view_func() (JSONRPCSite method)

I

id (Schema attribute) (ServiceDescribe attribute) if_ (Schema attribute) import_name (JSONRPCBlueprint attribute), [1] in_ (APIKeyAuth attribute) (BearerAuth attribute) Info (class in flask_jsonrpc.contrib.openrpc.typing) info (OpenRPCSchema attribute) init_app() (JSONRPC method), [1] (JSONRPCBrowse method) (OpenRPC method)

init_browse_app() (JSONRPC method), [1] INTEGER (SchemaDataType attribute) InternalError InvalidParamsError InvalidRequestError IS_ENV_KEY() (in module flask_jsonrpc.conf.global_settings) is_json (JSONRPCSite property) items (Schema attribute)

J

jsonify() (in module flask_jsonrpc.encoders) JSONRPC (class in flask_jsonrpc) (class in flask_jsonrpc.app) jsonrpc_app (OpenRPC attribute) jsonrpc_apps (JSONRPC attribute), [1] jsonrpc_browse (JSONRPC attribute), [1] jsonrpc_format (JSONRPCError property) jsonrpc_site (JSONRPC attribute), [1] (JSONRPCBlueprint attribute), [1] (JSONRPCServiceDescriptor attribute) (JSONRPCView attribute), [1] jsonrpc_site_api (JSONRPC attribute), [1] (JSONRPCBlueprint attribute), [1]

jsonrpc_sites (JSONRPCBrowse attribute) JSONRPCBlueprint (class in flask_jsonrpc) (class in flask_jsonrpc.blueprints) JSONRPCBrowse (class in flask_jsonrpc.contrib.browse) JSONRPCBrowseTemplateLoader (class in flask_jsonrpc.contrib.browse) JSONRPCDecoratorMixin (class in flask_jsonrpc.wrappers) JSONRPCError JSONRPCNewType (class in flask_jsonrpc.types.types) JSONRPCServiceDescriptor (class in flask_jsonrpc.descriptor) JSONRPCSite (class in flask_jsonrpc.site) JSONRPCView (class in flask_jsonrpc) (class in flask_jsonrpc.views)

L

LazyObject (class in flask_jsonrpc.conf) LazySettings (class in flask_jsonrpc.conf) License (class in flask_jsonrpc.contrib.openrpc.typing) license_ (Info attribute) Link (class in flask_jsonrpc.contrib.openrpc.typing)

links (Components attribute) (Method attribute) (MethodExtendSchema attribute) loads() (in module flask_jsonrpc.funcutils) logger (JSONRPCDecoratorMixin property) (JSONRPCSite property)

M

make_response() (JSONRPCSite method) max_contains (Schema attribute) max_digits (Field attribute) (MaxDigits attribute) max_items (Schema attribute) max_length (Field attribute) (MaxLength attribute) (Schema attribute) max_properties (Schema attribute) MaxDigits (class in flask_jsonrpc.types.params) Maximum (class in flask_jsonrpc.types.params) maximum (Field attribute) (Maximum attribute) (Schema attribute) MaxLength (class in flask_jsonrpc.types.params) message (Err attribute) (Error attribute), [1], [2] (JSONRPCError attribute) Method (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.typing) method (Link attribute) method() (JSONRPCDecoratorMixin method) MethodAnnotatedType (in module flask_jsonrpc.types.methods) MethodExtendSchema (class in flask_jsonrpc.contrib.openrpc.utils) MethodNotFoundError methods (JSONRPCView attribute), [1] (OpenRPCSchema attribute) (ServiceDescribe attribute) min_contains (Schema attribute) min_items (Schema attribute) min_length (Field attribute) (MinLength attribute) (Schema attribute) min_properties (Schema attribute) Minimum (class in flask_jsonrpc.types.params) minimum (Field attribute) (Minimum attribute) (Schema attribute) MinLength (class in flask_jsonrpc.types.params) model_config (APIKeyAuth attribute) (BaseModel attribute), [1], [2] (BearerAuth attribute) (Components attribute) (Contact attribute) (ContentDescriptor attribute) (Error attribute), [1] (Example attribute), [1] (ExampleField attribute) (ExamplePairing attribute) (ExternalDocumentation attribute) (Field attribute) (Info attribute) (License attribute) (Link attribute) (Method attribute), [1] (MethodExtendSchema attribute) (OAuth2 attribute) (OAuth2Flow attribute) (OpenRPCSchema attribute) (Reference attribute) (Schema attribute) (Server attribute), [1] (ServerVariable attribute) (ServiceDescribe attribute) (Tag attribute)

module flask_jsonrpc flask_jsonrpc.app flask_jsonrpc.blueprints flask_jsonrpc.conf flask_jsonrpc.conf.global_settings flask_jsonrpc.contrib flask_jsonrpc.contrib.browse flask_jsonrpc.contrib.openrpc flask_jsonrpc.contrib.openrpc.methods flask_jsonrpc.contrib.openrpc.typing flask_jsonrpc.contrib.openrpc.utils flask_jsonrpc.contrib.openrpc.wrappers flask_jsonrpc.descriptor flask_jsonrpc.encoders flask_jsonrpc.exceptions flask_jsonrpc.funcutils flask_jsonrpc.globals flask_jsonrpc.site flask_jsonrpc.types flask_jsonrpc.types.methods flask_jsonrpc.types.params flask_jsonrpc.types.types flask_jsonrpc.typing flask_jsonrpc.utils flask_jsonrpc.views flask_jsonrpc.wrappers multiple_of (Field attribute) (MultipleOf attribute) (Schema attribute) MultipleOf (class in flask_jsonrpc.types.params) mypyc_attr() (in module flask_jsonrpc.utils)

N

name (APIKeyAuth attribute) (BearerAuth attribute) (Contact attribute) (ContentDescriptor attribute) (Example attribute), [1], [2], [3] (ExampleField attribute), [1] (ExamplePairing attribute) (Field attribute) (JSONRPCBlueprint attribute), [1] (JSONRPCNewType attribute) (JSONRPCSite attribute) (License attribute) (Link attribute) (Method attribute), [1] (MethodExtendSchema attribute) (Server attribute) (ServiceDescribe attribute) (Tag attribute), [1]

new_method_proxy() (in module flask_jsonrpc.conf) not_ (Schema attribute) Notification (class in flask_jsonrpc.types.methods) notification (Method attribute) (Notification attribute) NULL (SchemaDataType attribute) Nullable (class in flask_jsonrpc.types.params) nullable (Field attribute) (Nullable attribute)

O

OAuth2 (class in flask_jsonrpc.contrib.openrpc.typing) OAuth2Flow (class in flask_jsonrpc.contrib.openrpc.typing) OAuth2FlowType (class in flask_jsonrpc.contrib.openrpc.typing) OBJECT (SchemaDataType attribute) Ok (class in flask_jsonrpc.types.params) one_of (Schema attribute)

OpenRPC (class in flask_jsonrpc.contrib.openrpc) openrpc (OpenRPCSchema attribute) openrpc_discover_method() (in module flask_jsonrpc.contrib.openrpc.methods) openrpc_schema (OpenRPC attribute) OpenRPCExtendSchemaDecoratorMixin (class in flask_jsonrpc.contrib.openrpc.wrappers) OpenRPCSchema (class in flask_jsonrpc.contrib.openrpc.typing)

P

param_structure (Method attribute) (MethodExtendSchema attribute) params (Example attribute), [1] (ExamplePairing attribute) (Link attribute) (Method attribute), [1] (MethodExtendSchema attribute) ParamStructure (class in flask_jsonrpc.contrib.openrpc.typing) ParseError PASSWORD (OAuth2FlowType attribute) path (JSONRPC attribute), [1] (JSONRPCSite attribute)

Pattern (class in flask_jsonrpc.types.params) pattern (Field attribute) (Pattern attribute) (Schema attribute) pattern_properties (Schema attribute) post() (JSONRPCView method), [1] prefix_items (Schema attribute) Properties (class in flask_jsonrpc.types.params) properties (Field attribute) (Schema attribute) propertify() (in module flask_jsonrpc.types.types) property_names (Schema attribute)

R

read_only (Schema attribute) ref (Reference attribute) (Schema attribute) Reference (class in flask_jsonrpc.contrib.openrpc.typing) refresh_url (OAuth2Flow attribute) register() (JSONRPC method), [1] (JSONRPCBlueprint method), [1] (JSONRPCServiceDescriptor method) (JSONRPCSite method) register_blueprint() (JSONRPC method), [1] register_browse() (JSONRPC method), [1] register_error_handler() (JSONRPCDecoratorMixin method) (JSONRPCSite method)

register_jsonrpc_site() (JSONRPCBrowse method) register_middleware() (in module flask_jsonrpc.contrib.browse) register_view_function() (JSONRPCDecoratorMixin method) Required (class in flask_jsonrpc.types.params) required (ContentDescriptor attribute) (Field attribute) (Required attribute) (Schema attribute) result (ExamplePairing attribute) (Method attribute) (MethodExtendSchema attribute) returns (Example attribute), [1] (Method attribute)

S

Schema (class in flask_jsonrpc.contrib.openrpc.typing) schema_ (ContentDescriptor attribute) (Schema attribute) SchemaDataType (class in flask_jsonrpc.contrib.openrpc.typing) schemas (Components attribute) scopes (APIKeyAuth attribute) (BearerAuth attribute) (OAuth2Flow attribute) serializable() (in module flask_jsonrpc.encoders) Server (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.typing) server (Link attribute) ServerError servers (Method attribute) (MethodExtendSchema attribute) (OpenRPCSchema attribute) (ServiceDescribe attribute) ServerVariable (class in flask_jsonrpc.contrib.openrpc.typing) service_describe() (JSONRPCServiceDescriptor method)

ServiceDescribe (class in flask_jsonrpc.typing) set_base_url() (JSONRPCSite method) set_path() (JSONRPCSite method) Settings (class in flask_jsonrpc.conf) status_code (Error attribute), [1] (JSONRPCError attribute) STRING (SchemaDataType attribute) Summary (class in flask_jsonrpc.types.methods) (class in flask_jsonrpc.types.params) summary (ContentDescriptor attribute) (Example attribute), [1], [2] (ExampleField attribute), [1] (ExamplePairing attribute) (Field attribute) (Link attribute) (Method attribute), [1] (MethodExtendSchema attribute) (Server attribute) (Summary attribute), [1] (Tag attribute), [1]

T

Tag (class in flask_jsonrpc.contrib.openrpc.typing) (class in flask_jsonrpc.types.methods) tags (Components attribute) (Method attribute), [1] (MethodExtendSchema attribute) terms_of_service (Info attribute) then (Schema attribute) title (Info attribute) (Schema attribute) (ServiceDescribe attribute) to_dict() (in module flask_jsonrpc.types.types) to_json() (JSONRPCSite method) token_url (OAuth2Flow attribute) trait() (in module flask_jsonrpc.utils) type (APIKeyAuth attribute) (BearerAuth attribute) (Field attribute) (Method attribute) (OAuth2 attribute) (OAuth2Flow attribute) (Schema attribute)

type_check() (AllowInfNan method) (BaseAnnotatedMetadata method) (DecimalPlaces method) (DefaultTypeCheckMixin method) (MaxDigits method) (Maximum method) (MaxLength method) (Minimum method) (MinLength method) (MultipleOf method) (Nullable method) (Pattern method) (Required method) type_checker() (in module flask_jsonrpc.types.types) type_metadata_checker() (in module flask_jsonrpc.types.types) types (JSONRPCNewType attribute)

U

unique_items (Schema attribute) unpack_tuple_returns() (JSONRPCSite method) url (Contact attribute) (ExternalDocumentation attribute) (License attribute) (Server attribute), [1]

url_prefix (JSONRPCBrowse attribute) uuid (JSONRPCSite attribute)

V

Validate (class in flask_jsonrpc.types.methods) validate (Validate attribute) validate() (JSONRPCSite method) validate_request() (JSONRPCSite method) validation (Method attribute) value (Example attribute), [1] (ExampleField attribute), [1] (Ok attribute) variables (Server attribute) version (Info attribute) (JSONRPC attribute), [1] (JSONRPCBlueprint attribute), [1] (JSONRPCSite attribute) (ServiceDescribe attribute)

vf_index() (JSONRPCBrowse method) vf_json_method() (JSONRPCBrowse method) vf_json_packages() (JSONRPCBrowse method) vf_login() (JSONRPCBrowse method) vf_logout() (JSONRPCBrowse method) vf_partials_dashboard() (JSONRPCBrowse method) vf_partials_field_describe() (JSONRPCBrowse method) vf_partials_menu_tree() (JSONRPCBrowse method) vf_partials_response_object() (JSONRPCBrowse method) view_funcs (JSONRPCSite attribute)

W

write_only (Schema attribute)

X

x_security (Method attribute) (MethodExtendSchema attribute)

x_security_schemes (Components attribute)