Flask-COMBO-JSONAPI
Navigation
Installation
A minimal API
Quickstart
Logical data abstraction
Resource Manager
Data layer
Routing
Filtering
Include related objects
Sparse fieldsets
Pagination
Sorting
Errors
Api
Permission
OAuth
Configuration
Changelog
Related Topics
Documentation overview
Quick search
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
A
AccessDenied
add_pagination_links() (in module flask_combo_jsonapi.pagination)
after_create_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_create_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_delete() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
after_delete_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_delete_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_get() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
after_get_collection() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_get_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_get_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_patch() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
after_post() (flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
after_update_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
after_update_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
Api (class in flask_combo_jsonapi.api)
apply_nested_fields() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
apply_relationships() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
B
BadRequest
before_create_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_create_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_delete() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
before_delete_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_delete_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_get() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
before_get_collection() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_get_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_get_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_marshmallow() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceList method)
before_patch() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
before_post() (flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
before_update_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
before_update_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
build_scope() (flask_combo_jsonapi.api.Api static method)
C
check_headers() (in module flask_combo_jsonapi.decorators)
check_method_requirements() (in module flask_combo_jsonapi.decorators)
check_permissions() (flask_combo_jsonapi.api.Api static method)
column (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
compute_schema() (in module flask_combo_jsonapi.schema)
create_filter() (flask_combo_jsonapi.data_layers.filtering.alchemy.Node method)
,
[1]
create_filters() (in module flask_combo_jsonapi.data_layers.filtering.alchemy)
,
[1]
create_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
(flask_combo_jsonapi.resource.ResourceList method)
create_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
D
decorators (flask_combo_jsonapi.resource.ResourceDetail attribute)
(flask_combo_jsonapi.resource.ResourceList attribute)
(flask_combo_jsonapi.resource.ResourceRelationship attribute)
delete() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
delete_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
(flask_combo_jsonapi.resource.ResourceDetail method)
delete_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
dispatch_request() (flask_combo_jsonapi.resource.Resource method)
E
eagerload_includes() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
F
fields (flask_combo_jsonapi.querystring.QueryStringManager property)
filter_query() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
filters (flask_combo_jsonapi.querystring.QueryStringManager property)
flask_combo_jsonapi.api
module
flask_combo_jsonapi.data_layers.alchemy
module
flask_combo_jsonapi.data_layers.filtering.alchemy
module
,
[1]
flask_combo_jsonapi.decorators
module
flask_combo_jsonapi.errors
module
flask_combo_jsonapi.exceptions
module
flask_combo_jsonapi.pagination
module
flask_combo_jsonapi.querystring
module
flask_combo_jsonapi.resource
module
flask_combo_jsonapi.schema
module
format_http_exception() (in module flask_combo_jsonapi.errors)
G
get() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
get_collection() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
(flask_combo_jsonapi.resource.ResourceList method)
get_collection_count() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
get_model_field() (in module flask_combo_jsonapi.schema)
get_nested_fields() (in module flask_combo_jsonapi.schema)
get_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
(flask_combo_jsonapi.resource.ResourceDetail method)
get_related_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
get_related_schema() (in module flask_combo_jsonapi.schema)
get_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
get_relationships() (in module flask_combo_jsonapi.schema)
get_schema_field() (in module flask_combo_jsonapi.schema)
get_schema_from_type() (in module flask_combo_jsonapi.schema)
H
has_permission() (flask_combo_jsonapi.api.Api method)
I
include (flask_combo_jsonapi.querystring.QueryStringManager property)
init_app() (flask_combo_jsonapi.api.Api method)
InvalidField
InvalidFilters
InvalidInclude
InvalidSort
InvalidType
J
jsonapi_errors() (in module flask_combo_jsonapi.errors)
jsonapi_exception_formatter() (in module flask_combo_jsonapi.decorators)
JsonApiException
JsonApiPluginException
M
MANAGED_KEYS (flask_combo_jsonapi.querystring.QueryStringManager attribute)
methods (flask_combo_jsonapi.resource.ResourceDetail attribute)
(flask_combo_jsonapi.resource.ResourceList attribute)
(flask_combo_jsonapi.resource.ResourceRelationship attribute)
module
flask_combo_jsonapi.api
flask_combo_jsonapi.data_layers.alchemy
flask_combo_jsonapi.data_layers.filtering.alchemy
,
[1]
flask_combo_jsonapi.decorators
flask_combo_jsonapi.errors
flask_combo_jsonapi.exceptions
flask_combo_jsonapi.pagination
flask_combo_jsonapi.querystring
flask_combo_jsonapi.resource
flask_combo_jsonapi.schema
N
name (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
Node (class in flask_combo_jsonapi.data_layers.filtering.alchemy)
,
[1]
O
oauth_manager() (flask_combo_jsonapi.api.Api method)
ObjectNotFound
op (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
operator (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
P
paginate_query() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
pagination (flask_combo_jsonapi.querystring.QueryStringManager property)
patch() (flask_combo_jsonapi.resource.ResourceDetail method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
permission_manager() (flask_combo_jsonapi.api.Api method)
PluginMethodNotImplementedError
plugins (flask_combo_jsonapi.resource.ResourceDetail attribute)
(flask_combo_jsonapi.resource.ResourceList attribute)
(flask_combo_jsonapi.resource.ResourceRelationship attribute)
post() (flask_combo_jsonapi.resource.ResourceList method)
(flask_combo_jsonapi.resource.ResourceRelationship method)
post_init() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
Q
qs_manager_class (flask_combo_jsonapi.resource.Resource attribute)
query() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
querystring (flask_combo_jsonapi.querystring.QueryStringManager property)
QueryStringManager (class in flask_combo_jsonapi.querystring)
R
related_model (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
related_schema (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]
RelatedObjectNotFound
RelationNotFound
resolve() (flask_combo_jsonapi.data_layers.filtering.alchemy.Node method)
,
[1]
Resource (class in flask_combo_jsonapi.resource)
ResourceDetail (class in flask_combo_jsonapi.resource)
ResourceList (class in flask_combo_jsonapi.resource)
ResourceMeta (class in flask_combo_jsonapi.resource)
ResourceRelationship (class in flask_combo_jsonapi.resource)
retrieve_object_query() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
route() (flask_combo_jsonapi.api.Api method)
S
sort_query() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
sorting (flask_combo_jsonapi.querystring.QueryStringManager property)
source (flask_combo_jsonapi.exceptions.InvalidField attribute)
(flask_combo_jsonapi.exceptions.InvalidFilters attribute)
(flask_combo_jsonapi.exceptions.InvalidInclude attribute)
(flask_combo_jsonapi.exceptions.InvalidSort attribute)
(flask_combo_jsonapi.exceptions.JsonApiException attribute)
SqlalchemyDataLayer (class in flask_combo_jsonapi.data_layers.alchemy)
status (flask_combo_jsonapi.exceptions.AccessDenied attribute)
(flask_combo_jsonapi.exceptions.BadRequest attribute)
(flask_combo_jsonapi.exceptions.InvalidType attribute)
(flask_combo_jsonapi.exceptions.JsonApiException attribute)
(flask_combo_jsonapi.exceptions.ObjectNotFound attribute)
(flask_combo_jsonapi.exceptions.Unauthorized attribute)
T
title (flask_combo_jsonapi.exceptions.AccessDenied attribute)
(flask_combo_jsonapi.exceptions.BadRequest attribute)
(flask_combo_jsonapi.exceptions.InvalidField attribute)
(flask_combo_jsonapi.exceptions.InvalidFilters attribute)
(flask_combo_jsonapi.exceptions.InvalidInclude attribute)
(flask_combo_jsonapi.exceptions.InvalidSort attribute)
(flask_combo_jsonapi.exceptions.InvalidType attribute)
(flask_combo_jsonapi.exceptions.JsonApiException attribute)
(flask_combo_jsonapi.exceptions.ObjectNotFound attribute)
(flask_combo_jsonapi.exceptions.RelatedObjectNotFound attribute)
(flask_combo_jsonapi.exceptions.RelationNotFound attribute)
(flask_combo_jsonapi.exceptions.Unauthorized attribute)
to_dict() (flask_combo_jsonapi.exceptions.JsonApiException method)
U
Unauthorized
update_object() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
(flask_combo_jsonapi.resource.ResourceDetail method)
update_relationship() (flask_combo_jsonapi.data_layers.alchemy.SqlalchemyDataLayer method)
V
value (flask_combo_jsonapi.data_layers.filtering.alchemy.Node property)
,
[1]