feat: service list 接口返回增加 plan_schema 字段，以指导服务方案配置 (TencentBlueKing#233)

Author: SheepSheepChen

sdks/paas-service/CHANGES.md

@@ -1,4 +1,7 @@
 # 版本历史
+## 2.0.3
+- service list 接口返回增加 `plan_schema` 字段，以指导服务方案配置 
+
 ## 2.0.2
 - Support multi tenant 
 

sdks/paas-service/paas_service/__init__.py

@@ -16,6 +16,6 @@
 We undertake not to change the open source license (MIT license) applicable
 to the current version of the project delivered to anyone in the future.
 """
-__version__ = '2.0.2'
+__version__ = '2.0.3'
 
 default_app_config = 'paas_service.apps.PaaSServiceConfig'

sdks/paas-service/paas_service/base_vendor.py

@@ -19,6 +19,8 @@
 from abc import ABCMeta, abstractmethod
 from typing import ClassVar, Dict, Optional
 
+from pydantic import BaseModel, Field
+
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.module_loading import import_string
@@ -33,6 +35,22 @@ def get_provider_cls():
     return import_string(SVC_PROVIDER_CLS)
 
 
+def get_plan_schema_cls():
+    # 尝试从设置中获取类路径
+    plan_schema_cls = getattr(settings, 'PAAS_SERVICE_PLAN_SCHEMA_CLS', None)
+
+    # 若存在有效类路径则导入，否则返回默认类
+    return import_string(plan_schema_cls) if plan_schema_cls else EmptyPlanSchema
+
+
+def get_plan_schema() -> dict:
+    return get_plan_schema_cls().schema()
+
+
+class EmptyPlanSchema(BaseModel):
+    ...
+
+
 class BaseVendorException(Exception):
     """Base class for vendor exception"""
 
@@ -80,3 +98,12 @@ def delete(self, instanceData: InstanceData):
 
     def patch(self, instanceData: InstanceData, params: Dict) -> InstanceData:
         raise NotImplementedError
+
+
+# Plan Schema
+class BasePlanSchema(BaseModel):
+    ...
+
+
+class DummySchema(BasePlanSchema):
+    foo: str = Field(..., description="这是一个示例字段")

sdks/paas-service/paas_service/serializers.py

@@ -18,6 +18,7 @@
 """
 from typing import Optional
 
+from paas_service.base_vendor import get_plan_schema as get_svc_plan_schema
 from paas_service.models import Plan, Service, ServiceInstance, SpecDefinition, Specification
 from rest_framework import serializers
 
@@ -32,6 +33,7 @@ class ServiceSLZ(serializers.ModelSerializer):
     specifications = serializers.ListField(child=SpecDefinitionSLZ(), source='specifications.all')
     logo = serializers.SerializerMethodField()
     config = serializers.JSONField()
+    plan_schema = serializers.SerializerMethodField()
 
     def get_logo(self, obj):
         # type: (Service) -> Optional[str]
@@ -42,6 +44,9 @@ def get_logo(self, obj):
         else:
             return None
 
+    def get_plan_schema(self, obj) -> dict:
+        return get_svc_plan_schema()
+
     class Meta(object):
         model = Service
         exclude = ['created', 'updated']