Patch endpoints (#744)

* Adding patch endpoints.

* Adding annotated from main.

* Fixing and adding tests.

* Updating changelog.

* Fixing ruff errors.

* Ruff format.

* Switching to List for python 3.8.

* Updating docs make file.

* Switching from Item/Collection to Dict to allow partial updates.

* Ruff format fix.

* Fixing broken tests.

* Adding missing asyncs for patchs.

* Moving request to kwargs for patch item and collection.

* Switching to TypedDict.

* Adding hearder parameter to the input models.

* Removing print statement.
Adding default for content_type.

* Removing basemodel from patch types.
Moving transaction types back to extensions.transaction.
Adding literals for content_type.
Removing sys check for TypedDict import.

* Fixing imports.

* Moving models to correct locations.

* Switching from attrs to basemodel for patch operations.

* Switching to stac.PartialItem etc.

* Updating PatchMoveCopy model.

* Updating type for 3.8.

* Switching to StacBaseModels for patch operations.

* pre-commits.

* Add json dump of operation value.

* remove computed field decorator.

* Adding default "not implemented" for JSON Patch.

* pre-commit.

* Add default raise not implement to collection JSON Patch.

* removing json merge and patch.

* content_type None default.

* Fixing test.

* back to PartialItem & PatchOperation

* using openapi_extra for Content-Type.

* PartialCollection not PartialItem.

* Adding merge to operations.

* Adding example code for patch.

* Adding default None to partials.

* patch not update for backend.

* patch_collection not patch_item.

* Add tests for merge to operations.

* Switch to model_json_schema for patch schema.

* update from main

* update changelog

* Removing numberMatched & numberReturned.

* fix openapi schemas

---------

Co-authored-by: vincentsarago <[email protected]>

Author: rhysrevans3

CHANGES.md

@@ -4,6 +4,7 @@
 
 ### Changed
 
+* 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) in the `TransactionExtension`
 - remove support of `cql-json` in Filter extension ([#840](https://github.com/stac-utils/stac-fastapi/pull/840))
 
 ### Fixed
@@ -175,7 +176,6 @@
 ## [3.0.0] - 2024-07-29
 
 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,9 @@ def create_item(self, *args, **kwargs):
     def update_item(self, *args, **kwargs):
         return "dummy response"
 
+    def patch_item(self, *args, **kwargs):
+        return "dummy response"
+
     def delete_item(self, *args, **kwargs):
         return "dummy response"
 
@@ -439,6 +439,9 @@ def create_collection(self, *args, **kwargs):
     def update_collection(self, *args, **kwargs):
         return "dummy response"
 
+    def 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

@@ -5,6 +5,7 @@
 
 import attr
 from fastapi import APIRouter, Body, FastAPI
+from pydantic import TypeAdapter
 from stac_pydantic import Collection, Item, ItemCollection
 from stac_pydantic.shared import MimeTypes
 from starlette.responses import Response
@@ -15,6 +16,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
 
 
 class TransactionConformanceClasses(str, Enum):
@@ -42,13 +44,112 @@ 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)
+
+
 @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)
+
+
+_patch_item_schema = TypeAdapter(List[PatchOperation]).json_schema() | {
+    "examples": [
+        [
+            {
+                "op": "add",
+                "path": "/properties/foo",
+                "value": "bar",
+            },
+            {
+                "op": "replace",
+                "path": "/properties/foo",
+                "value": "bar",
+            },
+            {
+                "op": "test",
+                "path": "/properties/foo",
+                "value": "bar",
+            },
+            {
+                "op": "copy",
+                "path": "/properties/foo",
+                "from": "/properties/bar",
+            },
+            {
+                "op": "move",
+                "path": "/properties/foo",
+                "from": "/properties/bar",
+            },
+            {
+                "op": "remove",
+                "path": "/properties/foo",
+            },
+        ]
+    ]
+}
+# ref: https://github.com/pydantic/pydantic/issues/889
+_patch_item_schema["items"]["anyOf"] = list(_patch_item_schema["$defs"].values())
+
+_patch_collection_schema = TypeAdapter(List[PatchOperation]).json_schema() | {
+    "examples": [
+        [
+            {
+                "op": "add",
+                "path": "/summeries/foo",
+                "value": "bar",
+            },
+            {
+                "op": "replace",
+                "path": "/summeries/foo",
+                "value": "bar",
+            },
+            {
+                "op": "test",
+                "path": "/summeries/foo",
+                "value": "bar",
+            },
+            {
+                "op": "copy",
+                "path": "/summeries/foo",
+                "from": "/summeries/bar",
+            },
+            {
+                "op": "move",
+                "path": "/summeries/foo",
+                "from": "/summeries/bar",
+            },
+            {
+                "op": "remove",
+                "path": "/summeries/foo",
+            },
+        ]
+    ]
+}
+# ref: https://github.com/pydantic/pydantic/issues/889
+_patch_collection_schema["items"]["anyOf"] = list(
+    _patch_collection_schema["$defs"].values()
+)
+
+
 @attr.s
 class TransactionExtension(ApiExtension):
     """Transaction Extension.
@@ -126,6 +227,47 @@ 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,
+                }
+            },
+            openapi_extra={
+                "requestBody": {
+                    "content": {
+                        "application/json-patch+json": {
+                            "schema": _patch_item_schema,
+                        },
+                        "application/merge-patch+json": {
+                            "schema": PartialItem.model_json_schema(),
+                        },
+                        "application/json": {
+                            "schema": PartialItem.model_json_schema(),
+                        },
+                    },
+                    "required": True,
+                },
+            },
+            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})."""
@@ -148,11 +290,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(
@@ -196,6 +333,46 @@ 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,
+                }
+            },
+            openapi_extra={
+                "requestBody": {
+                    "content": {
+                        "application/json-patch+json": {
+                            "schema": _patch_collection_schema,
+                        },
+                        "application/merge-patch+json": {
+                            "schema": PartialCollection.model_json_schema(),
+                        },
+                        "application/json": {
+                            "schema": PartialCollection.model_json_schema(),
+                        },
+                    },
+                    "required": True,
+                },
+            },
+            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(
@@ -217,10 +394,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.
 
@@ -233,8 +406,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"])