kb-cloud-client-typescript 2.4.0-alpha.88 → 2.4.0-alpha.89

package/src/internalapi/models/task-schedule.ts

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { TaskScheduleType } from './task-schedule-type';
+
+/**
+ * 
+ * @export
+ * @interface TaskSchedule
+ */
+export interface TaskSchedule {
+    /**
+     * 
+     * @type {TaskScheduleType}
+     * @memberof TaskSchedule
+     */
+    'type': TaskScheduleType;
+    /**
+     * Start time of the execution window (required for scheduled type)
+     * @type {string}
+     * @memberof TaskSchedule
+     */
+    'startTime'?: string | null;
+    /**
+     * End time of the execution window (required for scheduled type)
+     * @type {string}
+     * @memberof TaskSchedule
+     */
+    'endTime'?: string | null;
+}
+
+
+

package/src/internalapi.yaml

@@ -689,6 +689,92 @@ paths:
           $ref: '#/components/responses/403'
       tags:
         - cluster
+  /internal/v1/organizations/{orgName}/clusters/{clusterName}/parameters:
+    get:
+      operationId: listParameterProps
+      summary: List parameter properties of the cluster
+      tags:
+        - parameter
+        - shared
+      parameters:
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: component type
+          in: query
+          name: component
+          required: false
+          schema:
+            type: string
+        - description: whether to return the raw template content
+          in: query
+          name: rawContent
+          schema:
+            type: boolean
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/parameterList'
+          description: get configuration of the cluster successfully
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+  /internal/v1/organizations/{orgName}/clusters/{clusterName}/reconfigure:
+    post:
+      operationId: reconfigureCluster
+      summary: Update cluster configuration
+      parameters:
+        - description: name of the Org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the KubeBlocks cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/reconfigureCreate'
+        required: true
+      responses:
+        '202':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+          description: Accepted
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - opsrequest
+        - shared
+      x-codegen-request-body-name: body
   /internal/v1/environments/{environmentName}:
     delete:
       operationId: deleteEnvironment
@@ -2104,6 +2190,144 @@ components:
           description: Items is the list of endpoint objects in the list
           items:
             $ref: '#/components/schemas/endpoint'
+    parameterProp:
+      type: object
+      required:
+        - name
+        - type
+        - needRestart
+        - immutable
+      properties:
+        name:
+          description: The name of the parameter
+          type: string
+        description:
+          description: The description of the parameter
+          type: string
+        type:
+          description: The type of the parameter value
+          type: string
+        value:
+          description: The value of the parameter, if parameter is not set in tpl, it's value equal to cue default value.
+          type: object
+        default:
+          description: The value of the parameter, if parameter is not set in tpl, it's value equal to cue default value.
+          type: object
+        needRestart:
+          description: Whether the parameter requires a restart to take effect
+          type: boolean
+        immutable:
+          description: Whether the parameter is an immutable parameter, immutable parameters cannot be modified
+          type: boolean
+        maximum:
+          description: The maximum value of the parameter
+          type: string
+        minimum:
+          description: The minimum value of the parameter
+          type: string
+        enum:
+          description: The value options of the parameter
+          type: array
+          items: {}
+        unit:
+          description: The unit of the parameter value (e.g., seconds, bytes, ms, percentage)
+          type: string
+    parameterItem:
+      type: object
+      description: With the list of parameter properties and the configuration file name
+      properties:
+        props:
+          type: array
+          description: The list of parameters properties
+          items:
+            $ref: '#/components/schemas/parameterProp'
+        additionalProps:
+          type: array
+          description: The additional properties of the parameter
+          items:
+            $ref: '#/components/schemas/parameterProp'
+        fileName:
+          description: The name of the configuration file
+          type: string
+        specName:
+          description: The name of the config spec
+          type: string
+        rawContent:
+          description: The raw content of the configuration file, return only when raw is true in the query.
+          type: string
+    parameterList:
+      description: A list of cluster parameter
+      required:
+        - engine
+        - component
+      properties:
+        engine:
+          description: Name of database engine
+          type: string
+        component:
+          description: Name of component
+          type: string
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/parameterItem'
+    taskScheduleType:
+      type: string
+      enum:
+        - immediate
+        - scheduled
+        - maintenanceWindow
+      description: Schedule type for task execution
+    taskSchedule:
+      type: object
+      properties:
+        type:
+          $ref: '#/components/schemas/taskScheduleType'
+        startTime:
+          type: string
+          format: date-time
+          description: Start time of the execution window (required for scheduled type)
+          x-nullable: true
+        endTime:
+          type: string
+          format: date-time
+          description: End time of the execution window (required for scheduled type)
+          x-nullable: true
+      required:
+        - type
+    reconfigureCreate:
+      description: ReconfigureCreate is the payload to reconfigure a KubeBlocks cluster
+      properties:
+        component:
+          description: component type
+          type: string
+          minLength: 1
+        configFileName:
+          description: config file name
+          type: string
+        parameters:
+          additionalProperties:
+            type: string
+          description: Specify parameters list to be updated
+          type: object
+        rawContent:
+          description: The raw content of the configuration file
+          type: string
+        schedule:
+          $ref: '#/components/schemas/taskSchedule'
+      required:
+        - component
+      type: object
+    opsRequestName:
+      description: OpsRequestName is the name of a KubeBlocks OpsRequest response
+      properties:
+        opsRequestName:
+          type: string
+        taskId:
+          type: string
+      required:
+        - taskId
+      type: object
     apiserverStatus:
       type: string
       enum:

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

@@ -659,6 +659,7 @@ models/localized-description.ts
 models/log-backend-type.ts
 models/log-disk.ts
 models/log-option.ts
+models/log-retention.ts
 models/mapping-description.ts
 models/memory.ts
 models/metering-track-list.ts