Patch endpoints

CHANGES.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+* Add Item and Collection `PATCH` endpoints with support for [RFC 6902](https://tools.ietf.org/html/rfc6902) and [RFC 7396](https://tools.ietf.org/html/rfc7386)
+
 ## [3.0.1] - 2024-08-27
 
 ### Changed
@@ -10,8 +12,7 @@
 
 ## [3.0.0] - 2024-07-29
 
-Full changelog: https://stac-utils.github.io/stac-fastapi/migrations/v3.0.0/#changelog
-
+Full changelog: https://stac-utils.github.io/stac-fastapi/migrations/v3.0.0/#changelog 
 **Changes since 3.0.0b3:**
 
 ### Changed

stac_fastapi/api/tests/test_api.py

@@ -3,10 +3,7 @@
 
 from stac_fastapi.api.app import StacApi
 from stac_fastapi.api.models import ItemCollectionUri, create_request_model
-from stac_fastapi.extensions.core import (
-    TokenPaginationExtension,
-    TransactionExtension,
-)
+from stac_fastapi.extensions.core import TokenPaginationExtension, TransactionExtension
 from stac_fastapi.types import config, core
 
 
@@ -430,6 +427,12 @@ def create_item(self, *args, **kwargs):
     def update_item(self, *args, **kwargs):
         return "dummy response"
 
+    def json_patch_item(self, *args, **kwargs):
+        return "dummy response"
+
+    def merge_patch_item(self, *args, **kwargs):
+        return "dummy response"
+
     def delete_item(self, *args, **kwargs):
         return "dummy response"
 
@@ -439,6 +442,12 @@ def create_collection(self, *args, **kwargs):
     def update_collection(self, *args, **kwargs):
         return "dummy response"
 
+    def merge_patch_collection(self, *args, **kwargs):
+        return "dummy response"
+
+    def json_patch_collection(self, *args, **kwargs):
+        return "dummy response"
+
     def delete_collection(self, *args, **kwargs):
         return "dummy response"
 

stac_fastapi/extensions/stac_fastapi/extensions/core/transaction.py

@@ -1,9 +1,9 @@
 """Transaction extension."""
 
-from typing import List, Optional, Type, Union
+from typing import List, Literal, Optional, Type, Union
 
 import attr
-from fastapi import APIRouter, Body, FastAPI
+from fastapi import APIRouter, Body, FastAPI, Header
 from stac_pydantic import Collection, Item, ItemCollection
 from stac_pydantic.shared import MimeTypes
 from starlette.responses import JSONResponse, Response
@@ -14,6 +14,7 @@
 from stac_fastapi.types.config import ApiSettings
 from stac_fastapi.types.core import AsyncBaseTransactionsClient, BaseTransactionsClient
 from stac_fastapi.types.extension import ApiExtension
+from stac_fastapi.types.stac import PartialCollection, PartialItem, PatchOperation
 
 
 @attr.s
@@ -30,13 +31,53 @@ class PutItem(ItemUri):
     item: Annotated[Item, Body()] = attr.ib(default=None)
 
 
+@attr.s
+class PatchItem(ItemUri):
+    """Patch Item."""
+
+    patch: Annotated[
+        Union[PartialItem, List[PatchOperation]],
+        Body(),
+    ] = attr.ib(default=None)
+    content_type: Annotated[
+        Optional[
+            Literal[
+                "application/json-patch+json",
+                "application/merge-patch+json",
+                "application/json",
+            ]
+        ],
+        Header(),
+    ] = attr.ib(default="application/json")
+
+
 @attr.s
 class PutCollection(CollectionUri):
     """Update Collection."""
 
     collection: Annotated[Collection, Body()] = attr.ib(default=None)
 
 
+@attr.s
+class PatchCollection(CollectionUri):
+    """Patch Collection."""
+
+    patch: Annotated[
+        Union[PartialCollection, List[PatchOperation]],
+        Body(),
+    ] = attr.ib(default=None)
+    content_type: Annotated[
+        Optional[
+            Literal[
+                "application/json-patch+json",
+                "application/merge-patch+json",
+                "application/json",
+            ]
+        ],
+        Header(),
+    ] = attr.ib(default="application/json")
+
+
 @attr.s
 class TransactionExtension(ApiExtension):
     """Transaction Extension.
@@ -114,6 +155,31 @@ def register_update_item(self):
             endpoint=create_async_endpoint(self.client.update_item, PutItem),
         )
 
+    def register_patch_item(self):
+        """Register patch item endpoint (PATCH
+        /collections/{collection_id}/items/{item_id})."""
+        self.router.add_api_route(
+            name="Patch Item",
+            path="/collections/{collection_id}/items/{item_id}",
+            response_model=Item if self.settings.enable_response_models else None,
+            responses={
+                200: {
+                    "content": {
+                        MimeTypes.geojson.value: {},
+                    },
+                    "model": Item,
+                }
+            },
+            response_class=self.response_class,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["PATCH"],
+            endpoint=create_async_endpoint(
+                self.client.patch_item,
+                PatchItem,
+            ),
+        )
+
     def register_delete_item(self):
         """Register delete item endpoint (DELETE
         /collections/{collection_id}/items/{item_id})."""
@@ -136,11 +202,6 @@ def register_delete_item(self):
             endpoint=create_async_endpoint(self.client.delete_item, ItemUri),
         )
 
-    def register_patch_item(self):
-        """Register patch item endpoint (PATCH
-        /collections/{collection_id}/items/{item_id})."""
-        raise NotImplementedError
-
     def register_create_collection(self):
         """Register create collection endpoint (POST /collections)."""
         self.router.add_api_route(
@@ -184,6 +245,30 @@ def register_update_collection(self):
             endpoint=create_async_endpoint(self.client.update_collection, PutCollection),
         )
 
+    def register_patch_collection(self):
+        """Register patch collection endpoint (PATCH /collections/{collection_id})."""
+        self.router.add_api_route(
+            name="Patch Collection",
+            path="/collections/{collection_id}",
+            response_model=Collection if self.settings.enable_response_models else None,
+            responses={
+                200: {
+                    "content": {
+                        MimeTypes.geojson.value: {},
+                    },
+                    "model": Collection,
+                }
+            },
+            response_class=self.response_class,
+            response_model_exclude_unset=True,
+            response_model_exclude_none=True,
+            methods=["PATCH"],
+            endpoint=create_async_endpoint(
+                self.client.patch_collection,
+                PatchCollection,
+            ),
+        )
+
     def register_delete_collection(self):
         """Register delete collection endpoint (DELETE /collections/{collection_id})."""
         self.router.add_api_route(
@@ -205,10 +290,6 @@ def register_delete_collection(self):
             endpoint=create_async_endpoint(self.client.delete_collection, CollectionUri),
         )
 
-    def register_patch_collection(self):
-        """Register patch collection endpoint (PATCH /collections/{collection_id})."""
-        raise NotImplementedError
-
     def register(self, app: FastAPI) -> None:
         """Register the extension with a FastAPI application.
 
@@ -221,8 +302,10 @@ def register(self, app: FastAPI) -> None:
         self.router.prefix = app.state.router_prefix
         self.register_create_item()
         self.register_update_item()
+        self.register_patch_item()
         self.register_delete_item()
         self.register_create_collection()
         self.register_update_collection()
+        self.register_patch_collection()
         self.register_delete_collection()
         app.include_router(self.router, tags=["Transaction Extension"])

stac_fastapi/extensions/tests/test_transaction.py

@@ -1,5 +1,5 @@
 import json
-from typing import Iterator, Union
+from typing import Dict, Iterator, List, Union
 
 import pytest
 from stac_pydantic import Collection
@@ -11,6 +11,7 @@
 from stac_fastapi.extensions.core import TransactionExtension
 from stac_fastapi.types.config import ApiSettings
 from stac_fastapi.types.core import BaseCoreClient, BaseTransactionsClient
+from stac_fastapi.types.stac import PatchOperation
 
 
 class DummyCoreClient(BaseCoreClient):
@@ -46,6 +47,32 @@ def update_item(self, collection_id: str, item_id: str, item: Item, **kwargs):
             "type": item.type,
         }
 
+    def merge_patch_item(
+        self,
+        collection_id: str,
+        item_id: str,
+        item: Dict,
+        **kwargs,
+    ):
+        return {
+            "path_collection_id": collection_id,
+            "path_item_id": item_id,
+            "type": item["type"],
+        }
+
+    def json_patch_item(
+        self,
+        collection_id: str,
+        item_id: str,
+        operations: List[PatchOperation],
+        **kwargs,
+    ):
+        return {
+            "path_collection_id": collection_id,
+            "path_item_id": item_id,
+            "first_op_type": operations[0].op,
+        }
+
     def delete_item(self, item_id: str, collection_id: str, **kwargs):
         return {
             "path_collection_id": collection_id,
@@ -58,6 +85,25 @@ def create_collection(self, collection: Collection, **kwargs):
     def update_collection(self, collection_id: str, collection: Collection, **kwargs):
         return {"path_collection_id": collection_id, "type": collection.type}
 
+    def merge_patch_collection(
+        self,
+        collection_id: str,
+        collection: Dict,
+        **kwargs,
+    ):
+        return {"path_collection_id": collection_id, "type": collection["type"]}
+
+    def json_patch_collection(
+        self,
+        collection_id: str,
+        operations: List[PatchOperation],
+        **kwargs,
+    ):
+        return {
+            "path_collection_id": collection_id,
+            "first_op_type": operations[0].op,
+        }
+
     def delete_collection(self, collection_id: str, **kwargs):
         return {"path_collection_id": collection_id}
 
@@ -88,6 +134,32 @@ def test_update_item(client: TestClient, item: Item) -> None:
     assert response.json()["type"] == "Feature"
 
 
+def test_merge_patch_item(client: TestClient, item: Item) -> None:
+    response = client.patch(
+        "/collections/a-collection/items/an-item", content=json.dumps(item)
+    )
+    assert response.is_success, response.text
+    assert response.json()["path_collection_id"] == "a-collection"
+    assert response.json()["path_item_id"] == "an-item"
+    assert response.json()["type"] == "Feature"
+
+
+def test_json_patch_item(client: TestClient) -> None:
+    operations = [
+        {"op": "add", "path": "properties.new_prop", "value": "new_prop_value"}
+    ]
+    headers = {"Content-Type": "application/json-patch+json"}
+    response = client.patch(
+        "/collections/a-collection/items/an-item",
+        headers=headers,
+        content=json.dumps(operations),
+    )
+    assert response.is_success, response.text
+    assert response.json()["path_collection_id"] == "a-collection"
+    assert response.json()["path_item_id"] == "an-item"
+    assert response.json()["first_op_type"] == "add"
+
+
 def test_delete_item(client: TestClient) -> None:
     response = client.delete("/collections/a-collection/items/an-item")
     assert response.is_success, response.text
@@ -108,6 +180,31 @@ def test_update_collection(client: TestClient, collection: Collection) -> None:
     assert response.json()["type"] == "Collection"
 
 
+def test_merge_patch_collection(client: TestClient, collection: Collection) -> None:
+    response = client.patch(
+        "/collections/a-collection",
+        content=json.dumps(collection),
+    )
+    assert response.is_success, response.text
+    assert response.json()["path_collection_id"] == "a-collection"
+    assert response.json()["type"] == "Collection"
+
+
+def test_json_patch_collection(client: TestClient) -> None:
+    operations = [
+        {"op": "add", "path": "summaries.new_prop", "value": "new_prop_value"}
+    ]
+    headers = {"Content-Type": "application/json-patch+json"}
+    response = client.patch(
+        "/collections/a-collection/items/an-item",
+        headers=headers,
+        content=json.dumps(operations),
+    )
+    assert response.is_success, response.text
+    assert response.json()["path_collection_id"] == "a-collection"
+    assert response.json()["first_op_type"] == "add"
+
+
 def test_delete_collection(client: TestClient, collection: Collection) -> None:
     response = client.delete("/collections/a-collection")
     assert response.is_success, response.text
@@ -176,7 +273,9 @@ def collection() -> Collection:
         "description": "A test collection",
         "extent": {
             "spatial": {"bbox": [[-180, -90, 180, 90]]},
-            "temporal": {"interval": [["2000-01-01T00:00:00Z", "2024-01-01T00:00:00Z"]]},
+            "temporal": {
+                "interval": [["2000-01-01T00:00:00Z", "2024-01-01T00:00:00Z"]]
+            },
         },
         "links": [],
         "assets": {},