chore: update 3 api (#35481)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

api/tests/unit_tests/controllers/console/workspace/test_endpoint.py

@@ -2,14 +2,17 @@ from unittest.mock import MagicMock, patch
 
 import pytest
 
+from controllers.console import console_ns
 from controllers.console.workspace.endpoint import (
-    EndpointCreateApi,
-    EndpointDeleteApi,
+    DeprecatedEndpointCreateApi,
+    DeprecatedEndpointDeleteApi,
+    DeprecatedEndpointUpdateApi,
+    EndpointCollectionApi,
     EndpointDisableApi,
     EndpointEnableApi,
+    EndpointItemApi,
     EndpointListApi,
     EndpointListForSinglePluginApi,
-    EndpointUpdateApi,
 )
 from core.plugin.impl.exc import PluginPermissionDeniedError
 
@@ -35,9 +38,9 @@ def patch_current_account(user_and_tenant):
 
 
 @pytest.mark.usefixtures("patch_current_account")
-class TestEndpointCreateApi:
+class TestEndpointCollectionApi:
     def test_create_success(self, app):
-        api = EndpointCreateApi()
+        api = EndpointCollectionApi()
         method = unwrap(api.post)
 
         payload = {
@@ -55,7 +58,7 @@ class TestEndpointCreateApi:
         assert result["success"] is True
 
     def test_create_permission_denied(self, app):
-        api = EndpointCreateApi()
+        api = EndpointCollectionApi()
         method = unwrap(api.post)
 
         payload = {
@@ -75,7 +78,7 @@ class TestEndpointCreateApi:
                 method(api)
 
     def test_create_validation_error(self, app):
-        api = EndpointCreateApi()
+        api = EndpointCollectionApi()
         method = unwrap(api.post)
 
         payload = {
@@ -91,6 +94,27 @@ class TestEndpointCreateApi:
                 method(api)
 
 
+@pytest.mark.usefixtures("patch_current_account")
+class TestDeprecatedEndpointCreateApi:
+    def test_create_success(self, app):
+        api = DeprecatedEndpointCreateApi()
+        method = unwrap(api.post)
+
+        payload = {
+            "plugin_unique_identifier": "plugin-1",
+            "name": "endpoint",
+            "settings": {"a": 1},
+        }
+
+        with (
+            app.test_request_context("/", json=payload),
+            patch("controllers.console.workspace.endpoint.EndpointService.create_endpoint", return_value=True),
+        ):
+            result = method(api)
+
+        assert result["success"] is True
+
+
 @pytest.mark.usefixtures("patch_current_account")
 class TestEndpointListApi:
     def test_list_success(self, app):
@@ -146,9 +170,96 @@ class TestEndpointListForSinglePluginApi:
 
 
 @pytest.mark.usefixtures("patch_current_account")
-class TestEndpointDeleteApi:
+class TestEndpointItemApi:
     def test_delete_success(self, app):
-        api = EndpointDeleteApi()
+        api = EndpointItemApi()
+        method = unwrap(api.delete)
+
+        with (
+            app.test_request_context("/", method="DELETE"),
+            patch(
+                "controllers.console.workspace.endpoint.EndpointService.delete_endpoint",
+                return_value=True,
+            ) as mock_delete,
+        ):
+            result = method(api, "e1")
+
+        assert result["success"] is True
+        mock_delete.assert_called_once_with(tenant_id="t1", user_id="u1", endpoint_id="e1")
+
+    def test_delete_service_failure(self, app):
+        api = EndpointItemApi()
+        method = unwrap(api.delete)
+
+        with (
+            app.test_request_context("/", method="DELETE"),
+            patch("controllers.console.workspace.endpoint.EndpointService.delete_endpoint", return_value=False),
+        ):
+            result = method(api, "e1")
+
+        assert result["success"] is False
+
+    def test_update_success(self, app):
+        api = EndpointItemApi()
+        method = unwrap(api.patch)
+
+        payload = {
+            "name": "new-name",
+            "settings": {"x": 1},
+        }
+
+        with (
+            app.test_request_context("/", method="PATCH", json=payload),
+            patch(
+                "controllers.console.workspace.endpoint.EndpointService.update_endpoint",
+                return_value=True,
+            ) as mock_update,
+        ):
+            result = method(api, "e1")
+
+        assert result["success"] is True
+        mock_update.assert_called_once_with(
+            tenant_id="t1",
+            user_id="u1",
+            endpoint_id="e1",
+            name="new-name",
+            settings={"x": 1},
+        )
+
+    def test_update_validation_error(self, app):
+        api = EndpointItemApi()
+        method = unwrap(api.patch)
+
+        payload = {"settings": {}}
+
+        with (
+            app.test_request_context("/", method="PATCH", json=payload),
+        ):
+            with pytest.raises(ValueError):
+                method(api, "e1")
+
+    def test_update_service_failure(self, app):
+        api = EndpointItemApi()
+        method = unwrap(api.patch)
+
+        payload = {
+            "name": "n",
+            "settings": {},
+        }
+
+        with (
+            app.test_request_context("/", method="PATCH", json=payload),
+            patch("controllers.console.workspace.endpoint.EndpointService.update_endpoint", return_value=False),
+        ):
+            result = method(api, "e1")
+
+        assert result["success"] is False
+
+
+@pytest.mark.usefixtures("patch_current_account")
+class TestDeprecatedEndpointDeleteApi:
+    def test_delete_success(self, app):
+        api = DeprecatedEndpointDeleteApi()
         method = unwrap(api.post)
 
         payload = {"endpoint_id": "e1"}
@@ -162,7 +273,7 @@ class TestEndpointDeleteApi:
         assert result["success"] is True
 
     def test_delete_invalid_payload(self, app):
-        api = EndpointDeleteApi()
+        api = DeprecatedEndpointDeleteApi()
         method = unwrap(api.post)
 
         with (
@@ -172,7 +283,7 @@ class TestEndpointDeleteApi:
                 method(api)
 
     def test_delete_service_failure(self, app):
-        api = EndpointDeleteApi()
+        api = DeprecatedEndpointDeleteApi()
         method = unwrap(api.post)
 
         payload = {"endpoint_id": "e1"}
@@ -187,9 +298,9 @@ class TestEndpointDeleteApi:
 
 
 @pytest.mark.usefixtures("patch_current_account")
-class TestEndpointUpdateApi:
+class TestDeprecatedEndpointUpdateApi:
     def test_update_success(self, app):
-        api = EndpointUpdateApi()
+        api = DeprecatedEndpointUpdateApi()
         method = unwrap(api.post)
 
         payload = {
@@ -207,7 +318,7 @@ class TestEndpointUpdateApi:
         assert result["success"] is True
 
     def test_update_validation_error(self, app):
-        api = EndpointUpdateApi()
+        api = DeprecatedEndpointUpdateApi()
         method = unwrap(api.post)
 
         payload = {"endpoint_id": "e1", "settings": {}}
@@ -219,7 +330,7 @@ class TestEndpointUpdateApi:
                 method(api)
 
     def test_update_service_failure(self, app):
-        api = EndpointUpdateApi()
+        api = DeprecatedEndpointUpdateApi()
         method = unwrap(api.post)
 
         payload = {
@@ -237,6 +348,36 @@ class TestEndpointUpdateApi:
         assert result["success"] is False
 
 
+class TestEndpointRouteMetadata:
+    def test_legacy_write_routes_are_marked_deprecated(self):
+        assert DeprecatedEndpointCreateApi.post.__apidoc__["deprecated"] is True
+        assert DeprecatedEndpointDeleteApi.post.__apidoc__["deprecated"] is True
+        assert DeprecatedEndpointUpdateApi.post.__apidoc__["deprecated"] is True
+        assert EndpointCollectionApi.post.__apidoc__.get("deprecated") is not True
+        assert EndpointItemApi.delete.__apidoc__.get("deprecated") is not True
+        assert EndpointItemApi.patch.__apidoc__.get("deprecated") is not True
+
+    def test_canonical_and_legacy_write_routes_are_registered(self):
+        route_map = {
+            resource.__name__: urls
+            for resource, urls, _route_doc, _kwargs in console_ns.resources
+            if resource.__name__
+            in {
+                "EndpointCollectionApi",
+                "EndpointItemApi",
+                "DeprecatedEndpointCreateApi",
+                "DeprecatedEndpointDeleteApi",
+                "DeprecatedEndpointUpdateApi",
+            }
+        }
+
+        assert route_map["EndpointCollectionApi"] == ("/workspaces/current/endpoints",)
+        assert route_map["EndpointItemApi"] == ("/workspaces/current/endpoints/<string:id>",)
+        assert route_map["DeprecatedEndpointCreateApi"] == ("/workspaces/current/endpoints/create",)
+        assert route_map["DeprecatedEndpointDeleteApi"] == ("/workspaces/current/endpoints/delete",)
+        assert route_map["DeprecatedEndpointUpdateApi"] == ("/workspaces/current/endpoints/update",)
+
+
 @pytest.mark.usefixtures("patch_current_account")
 class TestEndpointEnableApi:
     def test_enable_success(self, app):