starlette-jsonapi
latest
Getting Started
Tutorial
How to
OpenAPI
API Reference
starlette-jsonapi
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
V
|
W
_
__init__() (starlette_jsonapi.exceptions.JSONAPIException method)
(starlette_jsonapi.exceptions.ResourceNotFound method)
(starlette_jsonapi.fields.JSONAPIRelationship method)
(starlette_jsonapi.openapi.JSONAPISchemaGenerator method)
(starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
(starlette_jsonapi.pagination.BasePagination method)
(starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
(starlette_jsonapi.schema.JSONAPISchema method)
A
after_request() (starlette_jsonapi.resource.BaseRelationshipResource class method)
(starlette_jsonapi.resource.BaseResource class method)
allowed_methods (starlette_jsonapi.resource.BaseRelationshipResource attribute)
(starlette_jsonapi.resource.BaseResource attribute)
B
BaseCursorPagination (class in starlette_jsonapi.pagination)
BaseOffsetPagination (class in starlette_jsonapi.pagination)
BasePageNumberPagination (class in starlette_jsonapi.pagination)
BasePagination (class in starlette_jsonapi.pagination)
BaseRelationshipResource (class in starlette_jsonapi.resource)
BaseResource (class in starlette_jsonapi.resource)
before_request() (starlette_jsonapi.resource.BaseRelationshipResource class method)
(starlette_jsonapi.resource.BaseResource class method)
C
Converter (starlette_jsonapi.openapi.JSONAPIMarshmallowPlugin attribute)
create_pagination_link() (starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
D
data (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
(starlette_jsonapi.pagination.BasePagination attribute)
(starlette_jsonapi.pagination.Pagination property)
default_page_after (starlette_jsonapi.pagination.BaseCursorPagination attribute)
default_page_before (starlette_jsonapi.pagination.BaseCursorPagination attribute)
default_page_number (starlette_jsonapi.pagination.BasePageNumberPagination attribute)
default_page_offset (starlette_jsonapi.pagination.BaseOffsetPagination attribute)
default_page_size (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
delete() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
deserialize_body() (starlette_jsonapi.resource.BaseResource method)
deserialize_ids() (starlette_jsonapi.resource.BaseRelationshipResource method)
detail (starlette_jsonapi.exceptions.ResourceNotFound attribute)
F
filter_sparse_fields() (in module starlette_jsonapi.utils)
G
generate_pagination_links() (starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
(starlette_jsonapi.pagination.BasePagination method)
generate_url() (starlette_jsonapi.schema.JSONAPISchema method)
get() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
get_fields() (starlette_jsonapi.schema.JSONAPISchema class method)
get_many() (starlette_jsonapi.resource.BaseResource method)
get_pagination() (starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
(starlette_jsonapi.pagination.BasePagination method)
get_related() (starlette_jsonapi.resource.BaseResource method)
get_related_url() (starlette_jsonapi.fields.JSONAPIRelationship method)
get_resource_links() (starlette_jsonapi.schema.JSONAPISchema method)
get_schema() (starlette_jsonapi.openapi.JSONAPISchemaGenerator method)
get_self_url() (starlette_jsonapi.fields.JSONAPIRelationship method)
get_top_level_links() (starlette_jsonapi.schema.JSONAPISchema method)
get_url() (starlette_jsonapi.fields.JSONAPIRelationship method)
H
handle_error() (starlette_jsonapi.resource.BaseRelationshipResource class method)
(starlette_jsonapi.resource.BaseResource class method)
handle_request() (starlette_jsonapi.resource.BaseRelationshipResource class method)
(starlette_jsonapi.resource.BaseResource class method)
I
id_mask (starlette_jsonapi.resource.BaseResource attribute)
include_relations() (starlette_jsonapi.resource.BaseResource method)
isinstance_or_subclass() (in module starlette_jsonapi.utils)
J
JSONAPIException
JSONAPIMarshmallowPlugin (class in starlette_jsonapi.openapi)
JSONAPIRelationship (class in starlette_jsonapi.fields)
JSONAPIResponse (class in starlette_jsonapi.responses)
JSONAPISchema (class in starlette_jsonapi.schema)
JSONAPISchema.Meta (class in starlette_jsonapi.schema)
JSONAPISchemaGenerator (class in starlette_jsonapi.openapi)
L
links (starlette_jsonapi.pagination.Pagination property)
M
max_page_size (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
media_type (starlette_jsonapi.responses.JSONAPIResponse attribute)
merge() (in module starlette_jsonapi.utils)
module
starlette_jsonapi.exceptions
starlette_jsonapi.fields
starlette_jsonapi.meta
starlette_jsonapi.openapi
starlette_jsonapi.pagination
starlette_jsonapi.resource
starlette_jsonapi.responses
starlette_jsonapi.schema
starlette_jsonapi.utils
mount (starlette_jsonapi.resource.BaseResource attribute)
O
openapi_info (starlette_jsonapi.resource.BaseRelationshipResource attribute)
(starlette_jsonapi.resource.BaseResource attribute)
OPTIONS_CLASS (starlette_jsonapi.schema.JSONAPISchema attribute)
opts (starlette_jsonapi.schema.JSONAPISchema attribute)
P
page_after (starlette_jsonapi.pagination.BaseCursorPagination attribute)
page_after_param (starlette_jsonapi.pagination.BaseCursorPagination attribute)
page_before (starlette_jsonapi.pagination.BaseCursorPagination attribute)
page_before_param (starlette_jsonapi.pagination.BaseCursorPagination attribute)
page_number (starlette_jsonapi.pagination.BasePageNumberPagination attribute)
page_number_param (starlette_jsonapi.pagination.BasePageNumberPagination attribute)
page_offset (starlette_jsonapi.pagination.BaseOffsetPagination attribute)
page_offset_param (starlette_jsonapi.pagination.BaseOffsetPagination attribute)
page_size (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
page_size_param (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
paginate_request() (starlette_jsonapi.resource.BaseResource method)
Pagination (class in starlette_jsonapi.pagination)
pagination_class (starlette_jsonapi.resource.BaseResource attribute)
parent_resource (starlette_jsonapi.resource.BaseRelationshipResource attribute)
parse_included_params() (in module starlette_jsonapi.utils)
parse_sparse_fields_params() (in module starlette_jsonapi.utils)
patch() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
post() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
prefix_url_path() (in module starlette_jsonapi.utils)
process_query_params() (starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
(starlette_jsonapi.pagination.BasePagination method)
process_sparse_fields() (in module starlette_jsonapi.utils)
process_sparse_fields_request() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
R
register_as (starlette_jsonapi.resource.BaseResource attribute)
register_jsonapi_exception_handlers() (in module starlette_jsonapi.utils)
register_resource (starlette_jsonapi.resource.BaseResource attribute)
register_routes() (starlette_jsonapi.resource.BaseRelationshipResource class method)
(starlette_jsonapi.resource.BaseResource class method)
RegisteredResourceMeta (class in starlette_jsonapi.meta)
related_resource_class (starlette_jsonapi.fields.JSONAPIRelationship property)
relationship_name (starlette_jsonapi.resource.BaseRelationshipResource attribute)
request (starlette_jsonapi.pagination.BaseCursorPagination attribute)
(starlette_jsonapi.pagination.BaseOffsetPagination attribute)
(starlette_jsonapi.pagination.BasePageNumberPagination attribute)
(starlette_jsonapi.pagination.BasePagination attribute)
(starlette_jsonapi.resource.BaseRelationshipResource attribute)
(starlette_jsonapi.resource.BaseResource attribute)
request_context (starlette_jsonapi.resource.BaseRelationshipResource attribute)
(starlette_jsonapi.resource.BaseResource attribute)
request_for_relationship() (in module starlette_jsonapi.openapi)
request_for_schema() (in module starlette_jsonapi.openapi)
ResourceNotFound
response_for_exception() (in module starlette_jsonapi.openapi)
response_for_relationship() (in module starlette_jsonapi.openapi)
response_for_schema() (in module starlette_jsonapi.openapi)
S
safe_merge() (in module starlette_jsonapi.utils)
schema (starlette_jsonapi.resource.BaseResource attribute)
self_url (starlette_jsonapi.schema.JSONAPISchema.Meta attribute)
self_url_kwargs (starlette_jsonapi.schema.JSONAPISchema.Meta attribute)
self_url_many (starlette_jsonapi.schema.JSONAPISchema.Meta attribute)
serialize() (starlette_jsonapi.fields.JSONAPIRelationship method)
(starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
serialize_error() (in module starlette_jsonapi.utils)
serialize_related() (starlette_jsonapi.resource.BaseResource method)
slice_data() (starlette_jsonapi.pagination.BaseCursorPagination method)
(starlette_jsonapi.pagination.BaseOffsetPagination method)
(starlette_jsonapi.pagination.BasePageNumberPagination method)
(starlette_jsonapi.pagination.BasePagination method)
starlette_jsonapi.exceptions
module
starlette_jsonapi.fields
module
starlette_jsonapi.meta
module
starlette_jsonapi.openapi
module
starlette_jsonapi.pagination
module
starlette_jsonapi.resource
module
starlette_jsonapi.responses
module
starlette_jsonapi.schema
module
starlette_jsonapi.utils
module
status_code (starlette_jsonapi.exceptions.ResourceNotFound attribute)
T
to_response() (starlette_jsonapi.resource.BaseRelationshipResource method)
(starlette_jsonapi.resource.BaseResource method)
type_ (starlette_jsonapi.resource.BaseResource attribute)
V
validate_body() (starlette_jsonapi.resource.BaseResource method)
W
with_openapi_info() (in module starlette_jsonapi.openapi)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds