feat: use DELETE for multitenancy subwallet removal (#4172)

* feat: use DELETE for multitenancy subwallet removal

Replace POST /multitenancy/wallet/{wallet_id}/remove with
DELETE /multitenancy/wallet/{wallet_id} for REST consistency.
Updates docs and regenerated OpenAPI/Swagger specs.

Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>

* feat: keep deprecated POST subwallet remove endpoint

Retain POST /multitenancy/wallet/{wallet_id}/remove as a deprecated alias
of DELETE /multitenancy/wallet/{wallet_id} to avoid a breaking change.
Marks the old route deprecated in the OpenAPI/Swagger specs and docs.

Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>

---------

Signed-off-by: Emiliano Suñé <2395873+esune@users.noreply.github.com>
Co-authored-by: jamshale <31809382+jamshale@users.noreply.github.com>

Author: esune

acapy_agent/multitenant/admin/routes.py

@@ -677,6 +677,23 @@ async def wallet_remove(request: web.BaseRequest):
     return web.json_response({})
 
 
+@docs(
+    tags=["multitenancy"],
+    summary="Remove a subwallet",
+    deprecated=True,
+)
+@match_info_schema(WalletIdMatchInfoSchema())
+@request_schema(RemoveWalletRequestSchema)
+@response_schema(MultitenantModuleResponseSchema(), 200, description="")
+@admin_authentication
+async def wallet_remove_deprecated(request: web.BaseRequest):
+    """Deprecated alias for wallet_remove.
+
+    Use ``DELETE /multitenancy/wallet/{wallet_id}`` instead.
+    """
+    return await wallet_remove(request)
+
+
 # MTODO: add wallet import route
 # MTODO: add wallet export route
 # MTODO: add rotate wallet key route
@@ -691,7 +708,8 @@ async def register(app: web.Application):
             web.get("/multitenancy/wallet/{wallet_id}", wallet_get, allow_head=False),
             web.put("/multitenancy/wallet/{wallet_id}", wallet_update),
             web.post("/multitenancy/wallet/{wallet_id}/token", wallet_create_token),
-            web.post("/multitenancy/wallet/{wallet_id}/remove", wallet_remove),
+            web.delete("/multitenancy/wallet/{wallet_id}", wallet_remove),
+            web.post("/multitenancy/wallet/{wallet_id}/remove", wallet_remove_deprecated),
         ]
     )
 

acapy_agent/multitenant/admin/tests/test_routes.py

@@ -833,6 +833,27 @@ async def test_wallet_remove_managed(self):
             mock_response.assert_called_once_with({})
             assert result == mock_response.return_value
 
+    async def test_wallet_remove_deprecated_delegates(self):
+        self.request.has_body = False
+        self.request.match_info = {"wallet_id": "dummy"}
+        mock_multitenant_mgr = mock.AsyncMock(BaseMultitenantManager, autospec=True)
+        mock_multitenant_mgr.remove_wallet = mock.CoroutineMock()
+        self.profile.context.injector.bind_instance(
+            BaseMultitenantManager, mock_multitenant_mgr
+        )
+
+        with (
+            mock.patch.object(test_module.web, "json_response") as mock_response,
+            mock.patch.object(
+                test_module.WalletRecord, "retrieve_by_id", mock.CoroutineMock()
+            ),
+        ):
+            result = await test_module.wallet_remove_deprecated(self.request)
+
+            mock_multitenant_mgr.remove_wallet.assert_called_once_with("dummy", None)
+            mock_response.assert_called_once_with({})
+            assert result == mock_response.return_value
+
     async def test_wallet_remove_unmanaged(self):
         self.request.match_info = {"wallet_id": "dummy"}
         self.request.json = mock.CoroutineMock(return_value={"wallet_key": "dummy_key"})

docs/features/Multitenancy.md

@@ -367,7 +367,7 @@ The following information is required to delete a tenant:
 Example
 
 ```sh
-curl -X POST "${ACAPY_ADMIN_URL}/multitenancy/wallet/{wallet_id}/remove" \
+curl -X DELETE "${ACAPY_ADMIN_URL}/multitenancy/wallet/{wallet_id}" \
    -H "Content-Type: application/json" \
    -H "x-api-key: $ACAPY_ADMIN_URL_API_KEY" \
    -d '{ "wallet_key": "example-encryption-key-02" }'
@@ -379,6 +379,10 @@ curl -X POST "${ACAPY_ADMIN_URL}/multitenancy/wallet/{wallet_id}/remove" \
 {}
 ```
 
+> The `POST /multitenancy/wallet/{wallet_id}/remove` endpoint is deprecated and
+> will be removed in a future release. Use `DELETE /multitenancy/wallet/{wallet_id}`
+> instead.
+
 ### Per tenant settings
 
 To allow the configuring of ACA-Py startup parameters/environment variables at a tenant/subwallet level. [PR#2233](https://github.com/openwallet-foundation/acapy/pull/2233) will provide the ability to update the following subset of settings when creating or updating the subwallet:

open-api/openapi.json

@@ -3932,10 +3932,47 @@
         "summary" : "Update a subwallet",
         "tags" : [ "multitenancy" ],
         "x-codegen-request-body-name" : "body"
+      },
+      "delete" : {
+        "parameters" : [ {
+          "description" : "Subwallet identifier",
+          "in" : "path",
+          "name" : "wallet_id",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "requestBody" : {
+          "content" : {
+            "*/*" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/RemoveWalletRequest"
+              }
+            }
+          },
+          "required" : false
+        },
+        "responses" : {
+          "200" : {
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/MultitenantModuleResponse"
+                }
+              }
+            },
+            "description" : ""
+          }
+        },
+        "summary" : "Remove a subwallet",
+        "tags" : [ "multitenancy" ],
+        "x-codegen-request-body-name" : "body"
       }
     },
     "/multitenancy/wallet/{wallet_id}/remove" : {
       "post" : {
+        "deprecated" : true,
         "parameters" : [ {
           "description" : "Subwallet identifier",
           "in" : "path",

open-api/swagger.json

@@ -3244,12 +3244,40 @@
             }
           }
         }
+      },
+      "delete" : {
+        "tags" : [ "multitenancy" ],
+        "summary" : "Remove a subwallet",
+        "produces" : [ "application/json" ],
+        "parameters" : [ {
+          "in" : "body",
+          "name" : "body",
+          "required" : false,
+          "schema" : {
+            "$ref" : "#/definitions/RemoveWalletRequest"
+          }
+        }, {
+          "name" : "wallet_id",
+          "in" : "path",
+          "description" : "Subwallet identifier",
+          "required" : true,
+          "type" : "string"
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "",
+            "schema" : {
+              "$ref" : "#/definitions/MultitenantModuleResponse"
+            }
+          }
+        }
       }
     },
     "/multitenancy/wallet/{wallet_id}/remove" : {
       "post" : {
         "tags" : [ "multitenancy" ],
         "summary" : "Remove a subwallet",
+        "deprecated" : true,
         "produces" : [ "application/json" ],
         "parameters" : [ {
           "in" : "body",