kb-cloud-client-typescript 2.3.0-alpha.225 → 2.3.0-alpha.227

package/src/adminapi.yaml

@@ -1085,18 +1085,12 @@ paths:
           $ref: '#/components/responses/403'
       tags:
         - organizationResourceQuota
-  /admin/v1/organizations/{orgName}/ai-agent/status:
+  /admin/v1/ai-agent/status:
     get:
       tags:
         - AI Agent
       operationId: getAIAgentStatus
       summary: Get AI diagnosis agent status
-      parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
       responses:
         '200':
           description: AI diagnosis agent runtime status
@@ -1110,18 +1104,16 @@ paths:
           $ref: '#/components/responses/403'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations:
+  /admin/v1/ai-agent/conversations:
     get:
       tags:
         - AI Agent
       operationId: listAIAgentConversations
       summary: List AI diagnosis conversations
+      description: |
+        Lists platform AI diagnosis conversations for the current admin user.
+        Admin global entry and admin cluster-detail entry share the same history.
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: limit
           in: query
           required: false
@@ -1133,11 +1125,6 @@ paths:
           required: false
           schema:
             type: string
-        - name: clusterName
-          in: query
-          required: false
-          schema:
-            type: string
       responses:
         '200':
           description: AI diagnosis conversations
@@ -1145,6 +1132,8 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/aiAgentConversationList'
+        '400':
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -1156,12 +1145,6 @@ paths:
         - AI Agent
       operationId: createAIAgentConversation
       summary: Create an AI diagnosis conversation
-      parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
       requestBody:
         required: true
         content:
@@ -1183,18 +1166,13 @@ paths:
           $ref: '#/components/responses/403'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}:
+  /admin/v1/ai-agent/conversations/{conversationId}:
     get:
       tags:
         - AI Agent
       operationId: getAIAgentConversation
       summary: Get an AI diagnosis conversation
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1221,11 +1199,6 @@ paths:
       operationId: deleteAIAgentConversation
       summary: Delete an AI diagnosis conversation
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1248,18 +1221,13 @@ paths:
           $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/messages:
+  /admin/v1/ai-agent/conversations/{conversationId}/messages:
     get:
       tags:
         - AI Agent
       operationId: listAIAgentMessages
       summary: List AI diagnosis conversation messages
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1297,11 +1265,6 @@ paths:
       operationId: sendAIAgentMessage
       summary: Send a user message and start or continue AI diagnosis
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1334,18 +1297,13 @@ paths:
           $ref: '#/components/responses/500'
         '503':
           $ref: '#/components/responses/503'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions:
+  /admin/v1/ai-agent/conversations/{conversationId}/turn-actions:
     get:
       tags:
         - AI Agent
       operationId: listAIAgentTurnActions
       summary: List stable AI diagnosis turn process actions
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1382,18 +1340,13 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}:
+  /admin/v1/ai-agent/conversations/{conversationId}/turn-actions/{actionId}:
     get:
       tags:
         - AI Agent
       operationId: getAIAgentTurnAction
       summary: Get one stable AI diagnosis turn process action
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1419,18 +1372,13 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/browse:
+  /admin/v1/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/browse:
     get:
       tags:
         - AI Agent
       operationId: browseAIAgentTurnActionArtifact
       summary: Browse a generated AI diagnosis report artifact
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1466,18 +1414,13 @@ paths:
           $ref: '#/components/responses/500'
         '503':
           $ref: '#/components/responses/503'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/download:
+  /admin/v1/ai-agent/conversations/{conversationId}/turn-actions/{actionId}/artifacts/{artifactId}/download:
     get:
       tags:
         - AI Agent
       operationId: downloadAIAgentTurnActionArtifact
       summary: Download a generated AI diagnosis report artifact
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1513,18 +1456,13 @@ paths:
           $ref: '#/components/responses/500'
         '503':
           $ref: '#/components/responses/503'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/events:
+  /admin/v1/ai-agent/conversations/{conversationId}/events:
     get:
       tags:
         - AI Agent
       operationId: subscribeAIAgentConversationEvents
       summary: Subscribe to AI diagnosis conversation events
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1550,18 +1488,13 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/tool-confirmations/{confirmationId}/approve:
+  /admin/v1/ai-agent/conversations/{conversationId}/tool-confirmations/{confirmationId}/approve:
     post:
       tags:
         - AI Agent
       operationId: approveAIAgentToolConfirmation
       summary: Approve one AI diagnosis tool confirmation
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1595,18 +1528,13 @@ paths:
           $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/tool-confirmations/{confirmationId}/reject:
+  /admin/v1/ai-agent/conversations/{conversationId}/tool-confirmations/{confirmationId}/reject:
     post:
       tags:
         - AI Agent
       operationId: rejectAIAgentToolConfirmation
       summary: Reject one AI diagnosis tool confirmation
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -1640,18 +1568,13 @@ paths:
           $ref: '#/components/responses/409'
         '500':
           $ref: '#/components/responses/500'
-  /admin/v1/organizations/{orgName}/ai-agent/conversations/{conversationId}/stop:
+  /admin/v1/ai-agent/conversations/{conversationId}/stop:
     post:
       tags:
         - AI Agent
       operationId: stopAIAgentConversation
       summary: Stop the current AI diagnosis turn
       parameters:
-        - name: orgName
-          in: path
-          required: true
-          schema:
-            type: string
         - name: conversationId
           in: path
           required: true
@@ -5420,6 +5343,45 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/DmsQueryResponse'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/sqlExplain/visual:
+    post:
+      tags:
+        - dms
+        - shared
+      operationId: visualSqlExplain
+      summary: explain a SQL as a normalized visual execution plan
+      parameters:
+        - name: orgName
+          in: path
+          description: name of the Org
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: name of the cluster
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          description: id of the datasource
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DmsVisualExplainRequest'
+        required: true
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DmsExecutionPlanResult'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/generateDDL:
     post:
       tags:
@@ -28382,6 +28344,344 @@ components:
           type: string
           description: the database for explaining the SQL
           default: ''
+    DmsVisualExplainRequest:
+      type: object
+      properties:
+        query:
+          type: string
+          description: the sql string
+        database:
+          type: string
+          description: the database for explaining the SQL
+          default: ''
+        analyze:
+          type: boolean
+          description: whether to run an actual/analyze plan when the engine supports it
+          default: false
+    DmsExecutionPlanMode:
+      type: string
+      enum:
+        - estimate
+        - analyze
+        - actual
+        - autotrace
+    DmsExecutionPlanRawFormat:
+      type: string
+      enum:
+        - json
+        - xml
+        - text
+        - table
+    DmsExecutionPlanNodeCategory:
+      type: string
+      enum:
+        - result
+        - sort
+        - join
+        - table_scan
+        - index_scan
+        - lookup
+        - materialize
+        - aggregate
+        - exchange
+        - modify
+        - other
+    DmsExecutionPlanNodeCost:
+      type: object
+      properties:
+        startup:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        total:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        self:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        percent:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanNodeRows:
+      type: object
+      properties:
+        estimated:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        actual:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        actualPerLoop:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        removedByFilter:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        mismatchRatio:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanNodeTiming:
+      type: object
+      properties:
+        startupMs:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        totalMs:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        selfMs:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        loops:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanNodeConditions:
+      type: object
+      properties:
+        filter:
+          type: string
+          nullable: true
+          x-omitempty: true
+        indexCond:
+          type: string
+          nullable: true
+          x-omitempty: true
+        joinCond:
+          type: string
+          nullable: true
+          x-omitempty: true
+        hashCond:
+          type: string
+          nullable: true
+          x-omitempty: true
+        sortKey:
+          type: array
+          items:
+            type: string
+    DmsExecutionPlanNode:
+      type: object
+      properties:
+        id:
+          type: string
+        parentIds:
+          type: array
+          items:
+            type: string
+        childIds:
+          type: array
+          items:
+            type: string
+        order:
+          type: integer
+          format: int64
+          nullable: true
+          x-omitempty: true
+        category:
+          $ref: '#/components/schemas/DmsExecutionPlanNodeCategory'
+        nodeType:
+          type: string
+        label:
+          type: string
+        relationName:
+          type: string
+          nullable: true
+          x-omitempty: true
+        schemaName:
+          type: string
+          nullable: true
+          x-omitempty: true
+        alias:
+          type: string
+          nullable: true
+          x-omitempty: true
+        indexName:
+          type: string
+          nullable: true
+          x-omitempty: true
+        cost:
+          $ref: '#/components/schemas/DmsExecutionPlanNodeCost'
+          nullable: true
+          x-omitempty: true
+        rows:
+          $ref: '#/components/schemas/DmsExecutionPlanNodeRows'
+          nullable: true
+          x-omitempty: true
+        timing:
+          $ref: '#/components/schemas/DmsExecutionPlanNodeTiming'
+          nullable: true
+          x-omitempty: true
+        conditions:
+          $ref: '#/components/schemas/DmsExecutionPlanNodeConditions'
+          nullable: true
+          x-omitempty: true
+        details:
+          type: object
+          additionalProperties: true
+          x-omitempty: true
+    DmsExecutionPlanEdgeRows:
+      type: object
+      properties:
+        estimated:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        actual:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanEdge:
+      type: object
+      properties:
+        id:
+          type: string
+        source:
+          type: string
+        target:
+          type: string
+        rows:
+          $ref: '#/components/schemas/DmsExecutionPlanEdgeRows'
+          nullable: true
+          x-omitempty: true
+        widthWeight:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        label:
+          type: string
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanSummary:
+      type: object
+      properties:
+        totalCost:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        totalActualTimeMs:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        planRows:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        actualRows:
+          type: number
+          format: double
+          nullable: true
+          x-omitempty: true
+        nodeCount:
+          type: integer
+          format: int64
+        maxCostNodeId:
+          type: string
+          nullable: true
+          x-omitempty: true
+        maxRowsNodeId:
+          type: string
+          nullable: true
+          x-omitempty: true
+        maxTimeNodeId:
+          type: string
+          nullable: true
+          x-omitempty: true
+    DmsExecutionPlanWarningSeverity:
+      type: string
+      enum:
+        - info
+        - warning
+        - critical
+    DmsExecutionPlanWarning:
+      type: object
+      properties:
+        code:
+          type: string
+        severity:
+          $ref: '#/components/schemas/DmsExecutionPlanWarningSeverity'
+        nodeId:
+          type: string
+          nullable: true
+          x-omitempty: true
+        message:
+          type: string
+    DmsExecutionPlanResult:
+      type: object
+      properties:
+        originSQL:
+          type: string
+        explainSQL:
+          type: string
+          nullable: true
+          x-omitempty: true
+        engineType:
+          type: string
+        mode:
+          $ref: '#/components/schemas/DmsExecutionPlanMode'
+        hasActualStats:
+          type: boolean
+          x-omitempty: false
+        rawFormat:
+          $ref: '#/components/schemas/DmsExecutionPlanRawFormat'
+        rawPlan:
+          type: object
+          description: Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
+          additionalProperties: true
+          x-omitempty: true
+        rootNodeIds:
+          type: array
+          items:
+            type: string
+        nodes:
+          type: array
+          items:
+            $ref: '#/components/schemas/DmsExecutionPlanNode'
+        edges:
+          type: array
+          items:
+            $ref: '#/components/schemas/DmsExecutionPlanEdge'
+        summary:
+          $ref: '#/components/schemas/DmsExecutionPlanSummary'
+          nullable: true
+          x-omitempty: true
+        warnings:
+          type: array
+          items:
+            $ref: '#/components/schemas/DmsExecutionPlanWarning'
+        fallbackTable:
+          $ref: '#/components/schemas/DmsQueryResponse'
+          nullable: true
+          x-omitempty: true
     DmsGenerateDdlOperationType:
       type: string
       description: operation type

package/src/openapi/.openapi-generator/FILES

@@ -376,6 +376,20 @@ models/dm-tablespace.ts
 models/dms-check-constraint.ts
 models/dms-exclude-constraint-exclude-inner.ts
 models/dms-exclude-constraint.ts
+models/dms-execution-plan-edge-rows.ts
+models/dms-execution-plan-edge.ts
+models/dms-execution-plan-mode.ts
+models/dms-execution-plan-node-category.ts
+models/dms-execution-plan-node-conditions.ts
+models/dms-execution-plan-node-cost.ts
+models/dms-execution-plan-node-rows.ts
+models/dms-execution-plan-node-timing.ts
+models/dms-execution-plan-node.ts
+models/dms-execution-plan-raw-format.ts
+models/dms-execution-plan-result.ts
+models/dms-execution-plan-summary.ts
+models/dms-execution-plan-warning-severity.ts
+models/dms-execution-plan-warning.ts
 models/dms-explain-request.ts
 models/dms-export-request.ts
 models/dms-foreign-key-reference.ts
@@ -411,6 +425,7 @@ models/dms-task-info.ts
 models/dms-task-list.ts
 models/dms-unique-key.ts
 models/dms-view-metadata.ts
+models/dms-visual-explain-request.ts
 models/dmsconsole-enable-opt.ts
 models/dmsconsole-net-mode.ts
 models/dmsconsole-svc-type.ts