rest_framework_json_api package

Subpackages

• rest_framework_json_api.django_filters package
  • Submodules
    • rest_framework_json_api.django_filters.backends module
      • DjangoFilterBackend
• rest_framework_json_api.schemas package

Submodules

• rest_framework_json_api.compat module
• rest_framework_json_api.exceptions module
  • rendered_with_json_api()
  • exception_handler()
  • Conflict
    • Conflict.status_code
    • Conflict.default_detail
• rest_framework_json_api.filters module
  • OrderingFilter
    • OrderingFilter.ordering_param
    • OrderingFilter.ordering_description
    • OrderingFilter.remove_invalid_fields()
  • QueryParameterValidationFilter
    • QueryParameterValidationFilter.query_regex
    • QueryParameterValidationFilter.validate_query_params()
    • QueryParameterValidationFilter.filter_queryset()
• rest_framework_json_api.metadata module
  • JSONAPIMetadata
    • JSONAPIMetadata.type_lookup
    • JSONAPIMetadata.relation_type_lookup
    • JSONAPIMetadata.determine_metadata()
    • JSONAPIMetadata.get_serializer_info()
    • JSONAPIMetadata.get_field_info()
• rest_framework_json_api.pagination module
  • JsonApiPageNumberPagination
    • JsonApiPageNumberPagination.page_query_param
    • JsonApiPageNumberPagination.page_size_query_param
    • JsonApiPageNumberPagination.max_page_size
    • JsonApiPageNumberPagination.build_link()
    • JsonApiPageNumberPagination.get_paginated_response()
  • JsonApiLimitOffsetPagination
    • JsonApiLimitOffsetPagination.limit_query_param
    • JsonApiLimitOffsetPagination.offset_query_param
    • JsonApiLimitOffsetPagination.max_limit
    • JsonApiLimitOffsetPagination.get_last_link()
    • JsonApiLimitOffsetPagination.get_first_link()
    • JsonApiLimitOffsetPagination.get_paginated_response()
• rest_framework_json_api.parsers module
  • JSONParser
    • JSONParser.media_type
    • JSONParser.renderer_class
    • JSONParser.parse_attributes()
    • JSONParser.parse_relationships()
    • JSONParser.parse_metadata()
    • JSONParser.parse_data()
    • JSONParser.parse()
• rest_framework_json_api.relations module
  • SkipDataMixin
    • SkipDataMixin.get_attribute()
    • SkipDataMixin.to_representation()
  • ManyRelatedFieldWithNoData
  • HyperlinkedMixin
    • HyperlinkedMixin.self_link_view_name
    • HyperlinkedMixin.related_link_view_name
    • HyperlinkedMixin.related_link_lookup_field
    • HyperlinkedMixin.get_url()
    • HyperlinkedMixin.get_links()
  • HyperlinkedRelatedField
    • HyperlinkedRelatedField.many_init()
  • ResourceRelatedField
    • ResourceRelatedField.self_link_view_name
    • ResourceRelatedField.related_link_view_name
    • ResourceRelatedField.related_link_lookup_field
    • ResourceRelatedField.default_error_messages
    • ResourceRelatedField.use_pk_only_optimization()
    • ResourceRelatedField.conflict()
    • ResourceRelatedField.to_internal_value()
    • ResourceRelatedField.to_representation()
    • ResourceRelatedField.get_resource_id()
    • ResourceRelatedField.get_resource_type_from_included_serializer()
    • ResourceRelatedField.get_parent_serializer()
    • ResourceRelatedField.is_serializer()
    • ResourceRelatedField.get_choices()
  • PolymorphicResourceRelatedField
    • PolymorphicResourceRelatedField.default_error_messages
    • PolymorphicResourceRelatedField.use_pk_only_optimization()
    • PolymorphicResourceRelatedField.to_internal_value()
  • SerializerMethodFieldBase
    • SerializerMethodFieldBase.bind()
    • SerializerMethodFieldBase.get_attribute()
  • ManySerializerMethodResourceRelatedField
    • ManySerializerMethodResourceRelatedField.to_representation()
  • SerializerMethodResourceRelatedField
    • SerializerMethodResourceRelatedField.many_kwargs
    • SerializerMethodResourceRelatedField.many_cls
    • SerializerMethodResourceRelatedField.many_init()
  • ManySerializerMethodHyperlinkedRelatedField
  • SerializerMethodHyperlinkedRelatedField
    • SerializerMethodHyperlinkedRelatedField.many_cls
• rest_framework_json_api.renderers module
  • JSONRenderer
    • JSONRenderer.media_type
    • JSONRenderer.format
    • JSONRenderer.extract_attributes()
    • JSONRenderer.extract_relationships()
    • JSONRenderer.extract_relation_instance()
    • JSONRenderer.extract_included()
    • JSONRenderer.extract_meta()
    • JSONRenderer.extract_root_meta()
    • JSONRenderer.build_json_resource_obj()
    • JSONRenderer.render_relationship_view()
    • JSONRenderer.render_errors()
    • JSONRenderer.render()
  • BrowsableAPIRenderer
    • BrowsableAPIRenderer.template
    • BrowsableAPIRenderer.includes_template
    • BrowsableAPIRenderer.get_context()
    • BrowsableAPIRenderer.get_includes_form()
• rest_framework_json_api.serializers module
  • ResourceIdentifierObjectSerializer
    • ResourceIdentifierObjectSerializer.default_error_messages
    • ResourceIdentifierObjectSerializer.model_class
    • ResourceIdentifierObjectSerializer.to_representation()
    • ResourceIdentifierObjectSerializer.to_internal_value()
  • SparseFieldsetsMixin
  • IncludedResourcesValidationMixin
  • ReservedFieldNamesMixin
    • ReservedFieldNamesMixin.get_fields()
  • LazySerializersDict
  • SerializerMetaclass
  • Serializer
  • HyperlinkedModelSerializer
  • ModelSerializer
    • ModelSerializer.serializer_related_field
    • ModelSerializer.get_field_names()
  • PolymorphicSerializerMetaclass
  • PolymorphicModelSerializer
    • PolymorphicModelSerializer.get_fields()
    • PolymorphicModelSerializer.get_polymorphic_serializer_for_instance()
    • PolymorphicModelSerializer.get_polymorphic_model_for_serializer()
    • PolymorphicModelSerializer.get_polymorphic_serializer_for_type()
    • PolymorphicModelSerializer.get_polymorphic_model_for_type()
    • PolymorphicModelSerializer.get_polymorphic_types()
    • PolymorphicModelSerializer.to_representation()
    • PolymorphicModelSerializer.to_internal_value()
• rest_framework_json_api.settings module
  • JSONAPISettings
  • reload_json_api_settings()
• rest_framework_json_api.utils module
  • get_resource_name()
  • get_serializer_fields()
  • format_field_names()
  • undo_format_field_names()
  • format_field_name()
  • undo_format_field_name()
  • format_link_segment()
  • undo_format_link_segment()
  • format_value()
  • format_resource_type()
  • get_related_resource_type()
  • get_resource_type_from_model()
  • get_resource_type_from_queryset()
  • get_resource_type_from_instance()
  • get_resource_type_from_manager()
  • get_resource_type_from_serializer()
  • get_resource_id()
  • get_included_resources()
  • get_default_included_resources_from_serializer()
  • get_relation_instance()
  • is_relationship_field()
  • Hyperlink
    • Hyperlink.is_hyperlink
  • format_drf_errors()
  • format_error_object()
  • format_errors()
• rest_framework_json_api.views module
  • PreloadIncludesMixin
    • PreloadIncludesMixin.get_select_related()
    • PreloadIncludesMixin.get_prefetch_related()
    • PreloadIncludesMixin.get_queryset()
  • AutoPrefetchMixin
    • AutoPrefetchMixin.get_queryset()
  • RelatedMixin
    • RelatedMixin.retrieve_related()
    • RelatedMixin.get_related_serializer()
    • RelatedMixin.get_related_serializer_class()
    • RelatedMixin.get_related_field_name()
    • RelatedMixin.get_related_instance()
  • ModelViewSet
    • ModelViewSet.http_method_names
  • ReadOnlyModelViewSet
    • ReadOnlyModelViewSet.http_method_names
  • RelationshipView
    • RelationshipView.serializer_class
    • RelationshipView.self_link_view_name
    • RelationshipView.related_link_view_name
    • RelationshipView.field_name_mapping
    • RelationshipView.http_method_names
    • RelationshipView.get_serializer_class()
    • RelationshipView.get_url()
    • RelationshipView.get_links()
    • RelationshipView.get()
    • RelationshipView.remove_relationships()
    • RelationshipView.patch()
    • RelationshipView.post()
    • RelationshipView.delete()
    • RelationshipView.get_related_instance()
    • RelationshipView.get_related_field_name()
    • RelationshipView.get_resource_name()
    • RelationshipView.set_resource_name()
    • RelationshipView.resource_name