atomic operations: response schemas

Author: mahenzon

fastapi_jsonapi/atomic/schemas.py

@@ -138,3 +138,19 @@ def validate_operation(cls, values: dict):
 
 class AtomicOperationRequest(BaseModel):
     operations: List[AtomicOperation] = Field(alias="atomic:operations")
+
+
+class AtomicResult(BaseModel):
+    data: Optional[dict] = Field(default=None, description="the “primary data” resulting from the operation.")
+    meta: Optional[dict] = Field(
+        default=None,
+        description="a meta object that contains non-standard meta-information about the result.",
+    )
+
+
+class AtomicResultResponse(BaseModel):
+    """
+    https://jsonapi.org/ext/atomic/#auto-id-responses-4
+    """
+
+    results: List[AtomicResult] = Field(alias="atomic:results")

tests/test_atomic/test_response.py

@@ -0,0 +1,64 @@
+import pytest
+
+from fastapi_jsonapi.atomic.schemas import AtomicResultResponse
+
+
+class TestAtomicResultResponse:
+    @pytest.mark.parametrize(
+        "operation_response",
+        [
+            {
+                "atomic:results": [
+                    {
+                        "data": {
+                            "links": {
+                                "self": "https://example.com/blogPosts/13",
+                            },
+                            "type": "articles",
+                            "id": "13",
+                            "attributes": {
+                                "title": "JSON API paints my bikeshed!",
+                            },
+                        },
+                    },
+                ],
+            },
+            {
+                "atomic:results": [
+                    {
+                        "data": {
+                            "links": {
+                                "self": "https://example.com/authors/acb2ebd6-ed30-4877-80ce-52a14d77d470",
+                            },
+                            "type": "authors",
+                            "id": "acb2ebd6-ed30-4877-80ce-52a14d77d470",
+                            "attributes": {"name": "dgeb"},
+                        },
+                    },
+                    {
+                        "data": {
+                            "links": {
+                                "self": "https://example.com/articles/bb3ad581-806f-4237-b748-f2ea0261845c",
+                            },
+                            "type": "articles",
+                            "id": "bb3ad581-806f-4237-b748-f2ea0261845c",
+                            "attributes": {
+                                "title": "JSON API paints my bikeshed!",
+                            },
+                            "relationships": {
+                                "author": {
+                                    "links": {
+                                        "self": "https://example.com/articles/bb3ad581-806f-4237-b748-f2ea0261845c/relationships/author",
+                                        "related": "https://example.com/articles/bb3ad581-806f-4237-b748-f2ea0261845c/author",
+                                    },
+                                },
+                            },
+                        },
+                    },
+                ],
+            },
+        ],
+    )
+    def test_response_data(self, operation_response: dict):
+        validated = AtomicResultResponse.parse_obj(operation_response)
+        assert validated.dict(exclude_unset=True, by_alias=True) == operation_response