docs(space): 空间配置改版设计与 P1 实现计划 --story=132989396

bkflow/space/serializers.py

@@ -81,3 +81,10 @@ def validate_configs(self, configs):
             logger.exception(f"[validate_configs] error: {e}")
             raise serializers.ValidationError(e.message)
         return configs
+
+
+class SpaceConfigVerifySerializer(serializers.Serializer):
+    space_id = serializers.IntegerField(help_text=_("空间ID"))
+    name = serializers.CharField(help_text=_("配置项名称"))
+    value = serializers.JSONField(help_text=_("待验证的配置值"), required=False)
+    params = serializers.DictField(help_text=_("验证参数"), required=False, default=dict)

bkflow/space/views.py

@@ -45,6 +45,7 @@
 from bkflow.space.configs import (
     ApiGatewayCredentialConfig,
     SpaceConfigHandler,
+    SpaceConfigVerifyNotSupported,
     SuperusersConfig,
 )
 from bkflow.space.exceptions import SpaceConfigDefaultValueNotExists
@@ -68,6 +69,7 @@
     SpaceConfigBaseQuerySerializer,
     SpaceConfigBatchApplySerializer,
     SpaceConfigSerializer,
+    SpaceConfigVerifySerializer,
     SpaceSerializer,
 )
 from bkflow.utils.api_client import ApiGwClient, HttpRequestResult
@@ -404,6 +406,36 @@
             SpaceConfig.objects.get_space_config_info(space_id=ser.validated_data["space_id"], simplified=False)
         )
 
+    @swagger_auto_schema(
+        method="post",
+        operation_summary="验证空间配置",
+        request_body=SpaceConfigVerifySerializer,
+    )
+    @action(detail=False, methods=["POST"])
+    def verify(self, request, *args, **kwargs):
+        ser = SpaceConfigVerifySerializer(data=request.data)
+        ser.is_valid(raise_exception=True)
+        data = ser.validated_data
+        try:
+            config_cls = SpaceConfigHandler.get_config(data["name"])
+        except Exception as e:
+            return Response({"ok": False, "error": {"message": str(e)}})
+        try:
+            # 注入操作人
+            params = dict(data.get("params", {}))
+            params.setdefault("operator", getattr(request.user, "username", "admin"))
+            params.pop("space_id", None)
+            params.pop("value", None)
+            verify_data = config_cls.verify(
+                space_id=data["space_id"], value=data.get("value"), **params
+            )
+            return Response({"ok": True, "data": verify_data})
+        except SpaceConfigVerifyNotSupported as e:
+            return Response({"ok": False, "error": {"message": str(e), "not_supported": True}})
+        except Exception as e:
+            logger.error(f"[space_config verify] name={data['name']} error: {e}")
+            return Response({"ok": False, "error": {"message": str(e)}})
+
     def create(self, request, *args, **kwargs):
         serializer = self.get_serializer(data=request.data)
         serializer.is_valid(raise_exception=True)