Welcome to drf-json-api-atomic-operations documentation!

drf-json-api-atomic-operation

Extension for django-rest-framework-json-api to support atomic operations.

See the usage section of the docs for example integration.

Implemented Features

• creating, updating, removing multiple resources in a single request (sequential db calls)

• Updating To-One Relationships

• Updating To-Many Relationships

• error reporting with json pointer to the concrete operation and the wrong attributes

ToDo

• permission handling

• use django bulk operations to optimize db execution time

• local identity (lid) handling

Contents

• Installation
  • 1. Install python package
• Usage
• Development
  • 1. Clone the project
  • 2. Install python dependencies
  • 4. Running tests
  • 5. Build docs
• Changelog
  • [0.2.0] - 2023-07-06
    • Added
    • Fixed
    • Changed
  • [0.1.0] - 2023-07-04
    • Added
• Code documentation
  • InvalidPrimaryDataType
  • JsonApiParseError
  • MissingPrimaryData
  • UnprocessableEntity
    • UnprocessableEntity.default_code
    • UnprocessableEntity.default_detail
    • UnprocessableEntity.status_code
  • AtomicOperationParser
    • AtomicOperationParser.check_add_operation()
    • AtomicOperationParser.check_operation()
    • AtomicOperationParser.check_relation_update()
    • AtomicOperationParser.check_remove_operation()
    • AtomicOperationParser.check_resource_identifier_object()
    • AtomicOperationParser.check_root()
    • AtomicOperationParser.check_update_operation()
    • AtomicOperationParser.media_type
    • AtomicOperationParser.parse_data()
    • AtomicOperationParser.parse_id_and_type()
    • AtomicOperationParser.parse_operation()
    • AtomicOperationParser.renderer_class
  • AtomicResultRenderer
    • AtomicResultRenderer.check_error()
    • AtomicResultRenderer.format
    • AtomicResultRenderer.media_type
    • AtomicResultRenderer.render()
  • AtomicOperationView
    • AtomicOperationView.get_serializer()
    • AtomicOperationView.get_serializer_class()
    • AtomicOperationView.get_serializer_classes()
    • AtomicOperationView.get_serializer_context()
    • AtomicOperationView.http_method_names
    • AtomicOperationView.parser_classes
    • AtomicOperationView.perform_operations()
    • AtomicOperationView.post()
    • AtomicOperationView.renderer_classes
    • AtomicOperationView.serializer_classes