refactor(cluster, api): deprecate the knowledge Open API (#116)

Author: Yuiham

apps/main/[3]cluster/[1]instances/components/ClusterTable/index.tsx

@@ -6,12 +6,10 @@ import {
   ClusterInfo,
   ClusterOperationStatus,
   ClusterStatus,
-  KnowledgeOfClusterType,
   PagedResult,
 } from '@/api/model'
 import { CopyIconButton } from '@/components/CopyToClipboard'
 import { resolveRoute } from '@pages-macro'
-import { useQueryKnowledge } from '@/api/hooks/knowledge'
 import {
   invalidateClusterDetail,
   invalidateClustersList,
@@ -33,7 +31,7 @@ import { NameAndID } from '@/components/NameAndID'
 loadI18n()
 
 export default function ClusterTable() {
-  const { columns, isKnowledgeLoading } = useTableColumn()
+  const { columns } = useTableColumn()
 
   const {
     data,
@@ -45,12 +43,10 @@ export default function ClusterTable() {
     pagination,
   } = useFetchClustersData()
 
-  const isLoading = isDataLoading || isKnowledgeLoading
-
   return (
     <HeavyTable
       headerTitle={null}
-      loading={isLoading}
+      loading={isDataLoading}
       className={styles.clusterTable}
       dataSource={data?.data?.data?.clusters || []}
       onSubmit={(filters) => {
@@ -119,7 +115,6 @@ type BootType = 'boot' | 'reboot'
 
 function useTableColumn() {
   const { t, i18n } = useI18n()
-  const { data, isLoading } = useQueryKnowledge()
 
   const queryClient = useQueryClient()
   const rebootCluster = useRebootCluster()
@@ -175,30 +170,22 @@ function useTableColumn() {
 
   const columns = useMemo(
     // FIXME: Filter not updated in time
-    () =>
-      getColumns(
-        t,
-        getClusterTypes(data?.data?.data || []),
-        bootAction,
-        stopAction
-      ),
-    [i18n.language, isLoading, bootAction, stopAction]
+    () => getColumns(t, getClusterTypes(), bootAction, stopAction),
+    [i18n.language, bootAction, stopAction]
   )
 
   return {
     columns,
-    isKnowledgeLoading: isLoading,
   }
 }
 
-function getClusterTypes(raw: KnowledgeOfClusterType[]) {
-  const result = {} as ProSchemaValueEnumObj
-  raw.forEach(
-    (r) =>
-      (result[r.clusterType!.code!] = {
-        text: r.clusterType!.name!,
-      })
-  )
+function getClusterTypes() {
+  const result = {
+    TiDB: {
+      text: 'TiDB',
+    },
+  } as ProSchemaValueEnumObj
+
   return result
 }
 

external/api/swagger.json

@@ -2470,61 +2470,6 @@
         }
       }
     },
-    "/knowledges/": {
-      "get": {
-        "security": [
-          {
-            "ApiKeyAuth": []
-          }
-        ],
-        "description": "show cluster knowledge",
-        "consumes": ["application/json"],
-        "produces": ["application/json"],
-        "tags": ["knowledge"],
-        "summary": "show cluster knowledge",
-        "responses": {
-          "200": {
-            "description": "OK",
-            "schema": {
-              "allOf": [
-                {
-                  "$ref": "#/definitions/controller.CommonResult"
-                },
-                {
-                  "type": "object",
-                  "properties": {
-                    "data": {
-                      "type": "array",
-                      "items": {
-                        "$ref": "#/definitions/knowledge.ClusterTypeSpec"
-                      }
-                    }
-                  }
-                }
-              ]
-            }
-          },
-          "401": {
-            "description": "Unauthorized",
-            "schema": {
-              "$ref": "#/definitions/controller.CommonResult"
-            }
-          },
-          "403": {
-            "description": "Forbidden",
-            "schema": {
-              "$ref": "#/definitions/controller.CommonResult"
-            }
-          },
-          "500": {
-            "description": "Internal Server Error",
-            "schema": {
-              "$ref": "#/definitions/controller.CommonResult"
-            }
-          }
-        }
-      }
-    },
     "/param-groups/": {
       "get": {
         "security": [
@@ -6871,133 +6816,6 @@
         }
       }
     },
-    "knowledge.ClusterComponent": {
-      "type": "object",
-      "properties": {
-        "componentName": {
-          "type": "string"
-        },
-        "componentPurpose": {
-          "type": "string"
-        },
-        "componentType": {
-          "type": "string"
-        }
-      }
-    },
-    "knowledge.ClusterComponentSpec": {
-      "type": "object",
-      "properties": {
-        "clusterComponent": {
-          "$ref": "#/definitions/knowledge.ClusterComponent"
-        },
-        "componentConstraint": {
-          "$ref": "#/definitions/knowledge.ComponentConstraint"
-        },
-        "componentPortConstraint": {
-          "$ref": "#/definitions/knowledge.ComponentPortConstraint"
-        }
-      }
-    },
-    "knowledge.ClusterType": {
-      "type": "object",
-      "properties": {
-        "code": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        }
-      }
-    },
-    "knowledge.ClusterTypeSpec": {
-      "type": "object",
-      "properties": {
-        "clusterType": {
-          "$ref": "#/definitions/knowledge.ClusterType"
-        },
-        "versionSpecs": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/knowledge.ClusterVersionSpec"
-          }
-        }
-      }
-    },
-    "knowledge.ClusterVersion": {
-      "type": "object",
-      "properties": {
-        "code": {
-          "type": "string"
-        },
-        "name": {
-          "type": "string"
-        }
-      }
-    },
-    "knowledge.ClusterVersionSpec": {
-      "type": "object",
-      "properties": {
-        "archTypes": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "clusterPortConstraint": {
-          "$ref": "#/definitions/knowledge.ComponentPortConstraint"
-        },
-        "clusterVersion": {
-          "$ref": "#/definitions/knowledge.ClusterVersion"
-        },
-        "componentSpecs": {
-          "type": "array",
-          "items": {
-            "$ref": "#/definitions/knowledge.ClusterComponentSpec"
-          }
-        }
-      }
-    },
-    "knowledge.ComponentConstraint": {
-      "type": "object",
-      "properties": {
-        "availableSpecCodes": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "componentRequired": {
-          "type": "boolean"
-        },
-        "minZoneQuantity": {
-          "type": "integer"
-        },
-        "parasite": {
-          "type": "boolean"
-        },
-        "suggestedNodeQuantities": {
-          "type": "array",
-          "items": {
-            "type": "integer"
-          }
-        }
-      }
-    },
-    "knowledge.ComponentPortConstraint": {
-      "type": "object",
-      "properties": {
-        "portCount": {
-          "type": "integer"
-        },
-        "portRangeEnd": {
-          "type": "integer"
-        },
-        "portRangeStart": {
-          "type": "integer"
-        }
-      }
-    },
     "message.AddPermissionsForRoleReq": {
       "type": "object",
       "properties": {

src/api/client.ts

@@ -16,7 +16,6 @@ import {
   ChangeFeedApi as ClusterDataReplicationApi,
   ParameterGroupApi,
   Configuration,
-  KnowledgeApi,
   PlatformApi,
   ResourceApi,
   TaskApi,
@@ -78,7 +77,6 @@ function initApis(basePath: string, axiosInstance: AxiosInstance) {
       undefined,
       axiosInstance
     ),
-    Knowledge: new KnowledgeApi(configuration, undefined, axiosInstance),
     Task: new TaskApi(configuration, undefined, axiosInstance),
     Logs: new ClusterLogApi(configuration, undefined, axiosInstance),
     Transport: new ClusterDataTransportApi(

src/api/hooks/knowledge.ts

@@ -9,17 +9,11 @@ import {
   ControllerResultWithPage,
   MessageLoginReq,
   MessageLoginResp,
-  KnowledgeClusterComponent,
-  KnowledgeClusterComponentSpec,
-  KnowledgeClusterVersionSpec,
   MessageQueryWorkFlowDetailResp,
   StructsWorkFlowInfo,
   StructsWorkFlowInfoStatusEnum,
   StructsWorkFlowNodeInfoStatusEnum,
   StructsWorkFlowNodeInfo,
-  KnowledgeClusterType,
-  KnowledgeClusterTypeSpec,
-  KnowledgeClusterVersion,
   ClusterPreviewClusterResp,
   MessageDataExportReq,
   MessageDataImportReq,
@@ -76,10 +70,6 @@ export type ClusterDownstreamKafka = ClusterKafkaDownstream
 export type ClusterDownstreamMySQL = ClusterMysqlDownstream
 export type ClusterDownstreamTiDB = ClusterTiDBDownstream
 
-export type ClusterType = KnowledgeClusterType
-export type ClusterVersion = KnowledgeClusterVersion
-export type ClusterComponent = KnowledgeClusterComponent
-
 export type TransportRecord = StructsDataImportExportRecordInfo
 
 export type HostInfo = StructsHostInfo
@@ -92,10 +82,6 @@ export type TaskWorkflowInfo = StructsWorkFlowInfo
 export type TaskWorkflowDetailInfo = MessageQueryWorkFlowDetailResp
 export type TaskWorkflowSubTaskInfo = StructsWorkFlowNodeInfo
 
-export type KnowledgeOfClusterType = KnowledgeClusterTypeSpec
-export type KnowledgeOfClusterVersion = KnowledgeClusterVersionSpec
-export type KnowledgeOfClusterComponent = KnowledgeClusterComponentSpec
-
 export type UserLoginRequest = MessageLoginReq
 
 export type RequestBackupCreate = ClusterBackupClusterDataReq