Index

A

add_routes_views() (pyramid_jsonapi.endpoints.EndpointData method) add_stage_handler() (pyramid_jsonapi.collection_view.CollectionViewBase class method) after_collection_get() (in module pyramid_jsonapi.callbacks_doc) after_get() (in module pyramid_jsonapi.callbacks_doc) after_related_get() (in module pyramid_jsonapi.callbacks_doc) after_relationships_get() (in module pyramid_jsonapi.callbacks_doc) after_serialise_identifier() (in module pyramid_jsonapi.callbacks_doc) after_serialise_object() (in module pyramid_jsonapi.callbacks_doc) all_attributes (pyramid_jsonapi.collection_view.CollectionViewBase attribute) (pyramid_jsonapi.unit_tests.TestView attribute)

allowed_fields (pyramid_jsonapi.collection_view.CollectionViewBase property) allowed_object() (pyramid_jsonapi.collection_view.CollectionViewBase method) allowed_rel_changes() (in module pyramid_jsonapi.workflow) allowed_requested_query_columns (pyramid_jsonapi.collection_view.CollectionViewBase property) allowed_requested_relationships_local_columns (pyramid_jsonapi.collection_view.CollectionViewBase property) altered_objects_iterator() (in module pyramid_jsonapi.workflow.loop) api (pyramid_jsonapi.collection_view.CollectionViewBase attribute) association_proxy_query() (pyramid_jsonapi.collection_view.CollectionViewBase method) attributes (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

B

bad_include_paths (pyramid_jsonapi.collection_view.CollectionViewBase property) base_collection_query() (pyramid_jsonapi.collection_view.CollectionViewBase method) before_collection_post() (in module pyramid_jsonapi.callbacks_doc) before_delete() (in module pyramid_jsonapi.callbacks_doc) before_patch() (in module pyramid_jsonapi.callbacks_doc) before_relationships_delete() (in module pyramid_jsonapi.callbacks_doc)

before_relationships_patch() (in module pyramid_jsonapi.callbacks_doc) before_relationships_post() (in module pyramid_jsonapi.callbacks_doc) build_content() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI static method) build_definitions() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) build_parameters() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) build_request() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) build_responses() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method)

C

callbacks (pyramid_jsonapi.collection_view.CollectionViewBase attribute) collection_get_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) collection_name (pyramid_jsonapi.collection_view.CollectionViewBase attribute) collection_post_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) collection_query_info() (pyramid_jsonapi.collection_view.CollectionViewBase class method) collection_view_factory() (pyramid_jsonapi.PyramidJSONAPI method) CollectionViewBase (class in pyramid_jsonapi.collection_view)

compute_meta() (pyramid_jsonapi.workflow.Results method) config_defaults (pyramid_jsonapi.PyramidJSONAPI attribute) create_jsonapi() (pyramid_jsonapi.PyramidJSONAPI method) create_jsonapi_using_magic_and_pixie_dust() (pyramid_jsonapi.PyramidJSONAPI method) create_pattern() (pyramid_jsonapi.endpoints.RoutePatternConstructor method) create_resource() (pyramid_jsonapi.PyramidJSONAPI method) current_related_ris() (in module pyramid_jsonapi.workflow)

D

data (pyramid_jsonapi.filters.FilterRegistry attribute) data() (pyramid_jsonapi.workflow.Results method) dbsession (pyramid_jsonapi.collection_view.CollectionViewBase attribute) DebugView (class in pyramid_jsonapi)

default_limit (pyramid_jsonapi.collection_view.CollectionViewBase attribute) delete_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) Doc (class in pyramid_jsonapi.workflow) drop() (pyramid_jsonapi.DebugView method)

E

enable_permission_handlers() (pyramid_jsonapi.PyramidJSONAPI method) endpoint_schema() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) endpoint_schema_view() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) EndpointData (class in pyramid_jsonapi.endpoints)

engine (pyramid_jsonapi.DebugView attribute) Entity (class in pyramid_jsonapi.collection_view) error() (pyramid_jsonapi.PyramidJSONAPI static method) execute_stage() (in module pyramid_jsonapi.workflow) exposed_fields (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

F

fields (pyramid_jsonapi.collection_view.CollectionViewBase attribute) fill_result_object_related() (in module pyramid_jsonapi.workflow.loop) filter() (pyramid_jsonapi.workflow.Results method)

FilterRegistry (class in pyramid_jsonapi.filters) find_all_keys() (pyramid_jsonapi.endpoints.EndpointData method) follow_rel() (in module pyramid_jsonapi.workflow) from_dict() (pyramid_jsonapi.resource.ResourceIndicator class method)

G

generate_openapi() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) generate_pkg_metadata() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) get_class_by_tablename() (in module pyramid_jsonapi) get_doc() (in module pyramid_jsonapi.workflow.loop.item_get) get_filter() (pyramid_jsonapi.filters.FilterRegistry method) get_function_name() (pyramid_jsonapi.endpoints.EndpointData method) get_item() (in module pyramid_jsonapi.workflow) (pyramid_jsonapi.collection_view.CollectionViewBase method)

get_jsonapi_accepts() (in module pyramid_jsonapi.workflow) get_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) get_one() (pyramid_jsonapi.collection_view.CollectionViewBase method) get_one_altered_result_object() (in module pyramid_jsonapi.workflow.loop) get_related() (in module pyramid_jsonapi.workflow.loop) get_results() (in module pyramid_jsonapi.workflow.loop.related_get) get_version() (in module pyramid_jsonapi.version)

H

http_methods (pyramid_jsonapi.endpoints.EndpointData property)

http_to_view_methods (pyramid_jsonapi.endpoints.EndpointData property) hybrid_attributes (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

I

id (pyramid_jsonapi.resource.ResourceIndicator attribute) id_col() (pyramid_jsonapi.collection_view.CollectionViewBase static method) identifier() (pyramid_jsonapi.workflow.ResultObject method) identifier_to_str() (pyramid_jsonapi.workflow.Rejected method)

identifiers() (pyramid_jsonapi.workflow.Results method) included() (pyramid_jsonapi.workflow.Results method) included_dict (pyramid_jsonapi.workflow.ResultObject property) (pyramid_jsonapi.workflow.Results property) item (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

J

JSONSchema (class in pyramid_jsonapi.metadata.JSONSchema)

K

key_column (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

L

load_schema() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method)

M

make_method() (in module pyramid_jsonapi.workflow) make_route_name() (pyramid_jsonapi.endpoints.EndpointData method) make_routes_views() (pyramid_jsonapi.metadata.MetaData method) mapped_info_from_name() (pyramid_jsonapi.collection_view.CollectionViewBase method) max_limit (pyramid_jsonapi.collection_view.CollectionViewBase attribute) meta (pyramid_jsonapi.workflow.Results property) MetaData (class in pyramid_jsonapi.metadata) metadata (pyramid_jsonapi.DebugView attribute) methods (pyramid_jsonapi.collection_view.CollectionViewBase attribute) mirror_relationship (pyramid_jsonapi.StdRelationship property) model() (pyramid_jsonapi.collection_view.CollectionViewBase method) model_from_table() (pyramid_jsonapi.collection_view.CollectionViewBase method) module pyramid_jsonapi pyramid_jsonapi.callbacks_doc pyramid_jsonapi.collection_view pyramid_jsonapi.endpoints pyramid_jsonapi.filters pyramid_jsonapi.metadata pyramid_jsonapi.metadata.JSONSchema pyramid_jsonapi.metadata.OpenAPI pyramid_jsonapi.resource pyramid_jsonapi.unit_tests pyramid_jsonapi.version pyramid_jsonapi.workflow pyramid_jsonapi.workflow.loop pyramid_jsonapi.workflow.loop.collection_get pyramid_jsonapi.workflow.loop.collection_post pyramid_jsonapi.workflow.loop.item_delete pyramid_jsonapi.workflow.loop.item_get pyramid_jsonapi.workflow.loop.item_patch pyramid_jsonapi.workflow.loop.related_get pyramid_jsonapi.workflow.loop.relationships_delete pyramid_jsonapi.workflow.loop.relationships_get pyramid_jsonapi.workflow.loop.relationships_patch pyramid_jsonapi.workflow.loop.relationships_post

N

not_found_message (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

O

obj (pyramid_jsonapi.StdRelationship attribute) obj_id (pyramid_jsonapi.collection_view.CollectionViewBase attribute)

object_exists() (pyramid_jsonapi.collection_view.CollectionViewBase method) OpenAPI (class in pyramid_jsonapi.metadata.OpenAPI) openapi_spec() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method)

P

pagination_links() (pyramid_jsonapi.collection_view.CollectionViewBase method) partition() (in module pyramid_jsonapi.workflow) partition_doc_data() (in module pyramid_jsonapi.workflow) patch_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) patch_rel_new_data() (in module pyramid_jsonapi.workflow) path_is_included() (pyramid_jsonapi.collection_view.CollectionViewBase method) pattern_from_components() (pyramid_jsonapi.endpoints.RoutePatternConstructor method) permission_filter() (pyramid_jsonapi.collection_view.CollectionViewBase method) permission_filters (pyramid_jsonapi.collection_view.CollectionViewBase attribute) permission_handler() (in module pyramid_jsonapi.workflow) (in module pyramid_jsonapi.workflow.loop) (pyramid_jsonapi.collection_view.CollectionViewBase class method) permission_object() (pyramid_jsonapi.collection_view.CollectionViewBase method) permission_template (pyramid_jsonapi.collection_view.CollectionViewBase attribute) Permissions (class in pyramid_jsonapi.unit_tests) populate() (pyramid_jsonapi.DebugView method) proxy_direction (pyramid_jsonapi.StdRelationship property) proxy_mirror_relationship (pyramid_jsonapi.StdRelationship property) proxy_tgt_class (pyramid_jsonapi.StdRelationship property) pyramid_jsonapi module pyramid_jsonapi.callbacks_doc module pyramid_jsonapi.collection_view module pyramid_jsonapi.endpoints module pyramid_jsonapi.filters module pyramid_jsonapi.metadata module pyramid_jsonapi.metadata.JSONSchema module

pyramid_jsonapi.metadata.OpenAPI module pyramid_jsonapi.resource module pyramid_jsonapi.unit_tests module pyramid_jsonapi.version module pyramid_jsonapi.workflow module pyramid_jsonapi.workflow.loop module pyramid_jsonapi.workflow.loop.collection_get module pyramid_jsonapi.workflow.loop.collection_post module pyramid_jsonapi.workflow.loop.item_delete module pyramid_jsonapi.workflow.loop.item_get module pyramid_jsonapi.workflow.loop.item_patch module pyramid_jsonapi.workflow.loop.related_get module pyramid_jsonapi.workflow.loop.relationships_delete module pyramid_jsonapi.workflow.loop.relationships_get module pyramid_jsonapi.workflow.loop.relationships_patch module pyramid_jsonapi.workflow.loop.relationships_post module PyramidJSONAPI (class in pyramid_jsonapi)

Q

query_add_filtering() (pyramid_jsonapi.collection_view.CollectionViewBase method)

query_add_sorting() (pyramid_jsonapi.collection_view.CollectionViewBase method)

R

recurse_remove_keys() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) recurse_replace_in_value() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) register() (pyramid_jsonapi.filters.FilterRegistry method) register_permission_filter() (pyramid_jsonapi.collection_view.CollectionViewBase class method) register_standard_filters() (pyramid_jsonapi.filters.FilterRegistry method) reject_attributes() (pyramid_jsonapi.workflow.Rejected method) reject_object() (pyramid_jsonapi.workflow.Rejected method) reject_relationships() (pyramid_jsonapi.workflow.Rejected method) Rejected (class in pyramid_jsonapi.workflow) rejected_dict (pyramid_jsonapi.workflow.Rejected property) rel (pyramid_jsonapi.collection_view.CollectionViewBase attribute) rel_class (pyramid_jsonapi.collection_view.CollectionViewBase attribute) rel_dict() (pyramid_jsonapi.workflow.Results method) rel_direction (pyramid_jsonapi.StdRelationship property) rel_mirror_relationship (pyramid_jsonapi.StdRelationship property) rel_patch_to_actions() (in module pyramid_jsonapi.workflow) rel_tgt_class (pyramid_jsonapi.StdRelationship property) rel_view (pyramid_jsonapi.collection_view.CollectionViewBase attribute) related_get_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) related_limit() (pyramid_jsonapi.collection_view.CollectionViewBase method) related_query() (pyramid_jsonapi.collection_view.CollectionViewBase method) relationships (pyramid_jsonapi.collection_view.CollectionViewBase attribute) (pyramid_jsonapi.unit_tests.TestView attribute)

relationships_delete_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) relationships_get_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) relationships_patch_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) relationships_post_old() (pyramid_jsonapi.collection_view.CollectionViewBase method) relname (pyramid_jsonapi.collection_view.CollectionViewBase attribute) replace_in_value_inner() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI method) request (pyramid_jsonapi.collection_view.CollectionViewBase attribute) requested_attributes (pyramid_jsonapi.collection_view.CollectionViewBase property) requested_field_names (pyramid_jsonapi.collection_view.CollectionViewBase property) requested_fields (pyramid_jsonapi.collection_view.CollectionViewBase property) requested_include_names() (pyramid_jsonapi.collection_view.CollectionViewBase method) requested_relationships (pyramid_jsonapi.collection_view.CollectionViewBase property) reset() (pyramid_jsonapi.DebugView method) resource_attributes() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) resource_attributes_view() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) ResourceIndicator (class in pyramid_jsonapi.resource) ResultObject (class in pyramid_jsonapi.workflow) Results (class in pyramid_jsonapi.workflow) route_pattern_to_suffix() (pyramid_jsonapi.endpoints.EndpointData method) RoutePatternConstructor (class in pyramid_jsonapi.endpoints) RQLQuery (class in pyramid_jsonapi.collection_view)

S

serialise() (pyramid_jsonapi.workflow.ResultObject method) (pyramid_jsonapi.workflow.Results method) serialise_object_with() (pyramid_jsonapi.workflow.Results method) settings (pyramid_jsonapi.collection_view.CollectionViewBase attribute) setUp() (pyramid_jsonapi.unit_tests.Permissions method) sh_alter_document_add_denied() (in module pyramid_jsonapi.workflow) sh_alter_document_add_returned_count() (in module pyramid_jsonapi.workflow) sh_alter_document_debug_info() (in module pyramid_jsonapi.workflow) sh_alter_document_self_link() (in module pyramid_jsonapi.workflow) sh_alter_request_add_info() (in module pyramid_jsonapi.workflow) sh_validate_request_common_validity() (in module pyramid_jsonapi.workflow) sh_validate_request_headers() (in module pyramid_jsonapi.workflow) sh_validate_request_object_exists() (in module pyramid_jsonapi.workflow) sh_validate_request_valid_json() (in module pyramid_jsonapi.workflow)

SharedState (class in pyramid_jsonapi.workflow) shp_collection_post_alter_request() (in module pyramid_jsonapi.workflow) shp_delete_alter_request() (in module pyramid_jsonapi.workflow) shp_get_alter_document() (in module pyramid_jsonapi.workflow) shp_get_item_alter_result() (in module pyramid_jsonapi.workflow.loop) shp_patch_alter_request() (in module pyramid_jsonapi.workflow) shp_relationships_delete_alter_request() (in module pyramid_jsonapi.workflow) shp_relationships_patch_alter_request() (in module pyramid_jsonapi.workflow) shp_relationships_post_alter_request() (in module pyramid_jsonapi.workflow) single_item_query() (pyramid_jsonapi.collection_view.CollectionViewBase method) standard_relationship_query() (pyramid_jsonapi.collection_view.CollectionViewBase method) StdRelationship (class in pyramid_jsonapi) str_identifier (pyramid_jsonapi.workflow.ResultObject property) swagger_ui() (pyramid_jsonapi.metadata.OpenAPI.OpenAPI static method)

T

template() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) test_create_empty() (pyramid_jsonapi.unit_tests.Permissions method) test_create_no_template() (pyramid_jsonapi.unit_tests.Permissions method) test_create_subtractive() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_attributes() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_bool_attributes() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_false_id() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_incorrect_atts() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_incorrect_rels() (pyramid_jsonapi.unit_tests.Permissions method) test_create_with_rels() (pyramid_jsonapi.unit_tests.Permissions method) test_data (pyramid_jsonapi.DebugView attribute) test_op_and() (pyramid_jsonapi.unit_tests.Permissions method)

test_op_or() (pyramid_jsonapi.unit_tests.Permissions method) test_op_sub() (pyramid_jsonapi.unit_tests.Permissions method) test_template_from_view() (pyramid_jsonapi.unit_tests.Permissions method) TestView (class in pyramid_jsonapi.unit_tests) to_dict() (pyramid_jsonapi.resource.ResourceIndicator method) (pyramid_jsonapi.workflow.ResultObject method) to_many (pyramid_jsonapi.StdRelationship property) to_one (pyramid_jsonapi.StdRelationship property) true_filter() (pyramid_jsonapi.collection_view.CollectionViewBase static method) tuple_identifier (pyramid_jsonapi.workflow.ResultObject property) type (pyramid_jsonapi.collection_view.Entity attribute) (pyramid_jsonapi.resource.ResourceIndicator attribute)

U

update_child() (pyramid_jsonapi.workflow.Doc method)

V

valid_filter_names() (pyramid_jsonapi.filters.FilterRegistry method) validate() (pyramid_jsonapi.metadata.JSONSchema.JSONSchema method) validate_patch_request() (in module pyramid_jsonapi.workflow.loop.item_patch)

view_classes (pyramid_jsonapi.collection_view.CollectionViewBase attribute) (pyramid_jsonapi.PyramidJSONAPI attribute) view_instance() (pyramid_jsonapi.collection_view.CollectionViewBase method) VIEWS (in module pyramid_jsonapi.metadata)

W

workflow() (in module pyramid_jsonapi.workflow.loop.collection_get) (in module pyramid_jsonapi.workflow.loop.collection_post) (in module pyramid_jsonapi.workflow.loop.item_delete) (in module pyramid_jsonapi.workflow.loop.item_get) (in module pyramid_jsonapi.workflow.loop.item_patch) (in module pyramid_jsonapi.workflow.loop.related_get) (in module pyramid_jsonapi.workflow.loop.relationships_delete) (in module pyramid_jsonapi.workflow.loop.relationships_get) (in module pyramid_jsonapi.workflow.loop.relationships_patch) (in module pyramid_jsonapi.workflow.loop.relationships_post)

wrap_permission_filter() (pyramid_jsonapi.collection_view.CollectionViewBase class method) wrapped_query_all() (in module pyramid_jsonapi.workflow)