kb-cloud-client-typescript 2.3.0-beta.11 → 2.3.0-beta.14

package/src/openapi/models/milvus-role-create-request.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 { MilvusRoleGrant } from './milvus-role-grant';
+
+/**
+ * Milvus role create request.
+ * @export
+ * @interface MilvusRoleCreateRequest
+ */
+export interface MilvusRoleCreateRequest {
+    /**
+     * Milvus role name.
+     * @type {string}
+     * @memberof MilvusRoleCreateRequest
+     */
+    'name': string;
+    /**
+     * Native Milvus privilege grants owned by this role.
+     * @type {Array<MilvusRoleGrant>}
+     * @memberof MilvusRoleCreateRequest
+     */
+    'grants'?: Array<MilvusRoleGrant>;
+}
+

package/src/openapi/models/milvus-role-request.ts

@@ -18,7 +18,7 @@
 import type { MilvusRoleGrant } from './milvus-role-grant';
 
 /**
- * Milvus role upsert request.
+ * Milvus role update request.
  * @export
  * @interface MilvusRoleRequest
  */

package/src/openapi/models/mode-service-ref-helm-value-path.ts

@@ -74,5 +74,11 @@ export interface ModeServiceRefHelmValuePath {
      * @memberof ModeServiceRefHelmValuePath
      */
     'mode'?: string;
+    /**
+     * the helm value path prefix for the extraForManualInput fields of this serviceRef. ClusterCreate API will map each key of serviceRefs[].extraForManualInput to `<extraForManualInput>.<key>` in the cluster chart values. 
+     * @type {string}
+     * @memberof ModeServiceRefHelmValuePath
+     */
+    'extraForManualInput'?: string;
 }
 

package/src/openapi/models/mode-service-ref.ts

@@ -74,6 +74,24 @@ export interface ModeServiceRef {
      * @memberof ModeServiceRef
      */
     'disableManualInput'?: boolean;
+    /**
+     * whether to disable auto creating the ServiceDescriptor object for this serviceRef. If set to false, the serviceDescriptor content (host/port/username/password) will be set directly into the helm values under the helmValuePath.serviceDescriptor path. If omitted, the generated ServiceDescriptor name will be set instead. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableAutoCreateServiceDescriptor'?: boolean | null;
+    /**
+     * whether to disable selecting a related cluster created in the platform for this serviceRef. If set to true, the frontend should only allow manual input instead of selecting from the clusters provided by the list clusters api. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableRelatedCluster'?: boolean;
+    /**
+     * Extra form field definitions for manual input of the serviceRef. The keys are the field names and the frontend renders them as input items. The user-entered values are passed in ClusterCreate serviceRefs[].extraForManualInput and mapped to helm values via helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: any; }}
+     * @memberof ModeServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: any; };
     /**
      * 
      * @type {ModeServiceRefHelmValuePath}

package/src/openapi/models/redis-key-value-item.ts

@@ -27,11 +27,11 @@ export interface RedisKeyValueItem {
      */
     'field'?: string;
     /**
-     * Hash/list/set/json item value.
-     * @type {{ [key: string]: any; }}
+     * Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
+     * @type {any}
      * @memberof RedisKeyValueItem
      */
-    'value'?: { [key: string]: any; };
+    'value'?: any;
     /**
      * Set or sorted-set member.
      * @type {string}

package/src/openapi/models/service-ref.ts

@@ -47,5 +47,11 @@ export interface ServiceRef {
      * @memberof ServiceRef
      */
     'serviceDescriptor'?: ServiceDescriptor;
+    /**
+     * extra fields for manual input of the serviceRef. The keys must be defined in the engineoption modeServiceRef.extraForManualInput. They are mapped to helm values via the corresponding helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: string; }}
+     * @memberof ServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: string; };
 }
 

package/src/openapi.yaml

@@ -17460,6 +17460,53 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+    post:
+      summary: Create Milvus role
+      description: Create a Milvus native role and grant its initial privileges.
+      operationId: createMilvusRole
+      parameters:
+        - description: name of the Org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the Cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      tags:
+        - account
+        - milvus
+        - shared
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/MilvusRoleCreateRequest'
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MilvusRole'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+      x-codegen-request-body-name: body
   /api/v1/data/milvus/organizations/{orgName}/clusters/{clusterName}/accounts/roles/{roleName}:
     get:
       summary: Get Milvus role
@@ -17506,9 +17553,9 @@ paths:
         '500':
           $ref: '#/components/responses/500'
     put:
-      summary: Put Milvus role
-      description: Create or update a Milvus native role and replace its privilege grants.
-      operationId: putMilvusRole
+      summary: Update Milvus role
+      description: Update an existing Milvus native role by replacing its privilege grants.
+      operationId: updateMilvusRole
       parameters:
         - description: name of the Org
           in: path
@@ -23366,6 +23413,14 @@ components:
           description: the cluster definition of the referenced cluster.
         serviceDescriptor:
           $ref: '#/components/schemas/serviceDescriptor'
+        extraForManualInput:
+          type: object
+          additionalProperties:
+            type: string
+          description: |
+            extra fields for manual input of the serviceRef. The keys must be defined in the
+            engineoption modeServiceRef.extraForManualInput. They are mapped to helm values
+            via the corresponding helmValuePath.extraForManualInput.
     clusterObjectStorageConfig:
       type: object
       description: Specify the object storage config for cluster like starrocks
@@ -23570,6 +23625,16 @@ components:
       description: Components is the list of components
       items:
         $ref: '#/components/schemas/componentItem'
+    clusterReference:
+      type: object
+      description: Cluster reference information returned by cluster detail APIs.
+      properties:
+        cluster:
+          type: string
+          description: Name of the cluster that references this cluster.
+        clusterDefinition:
+          type: string
+          description: Cluster definition of the referencing cluster.
     cluster:
       required:
         - engine
@@ -23739,7 +23804,7 @@ components:
           description: this list of objects (currently, object is a cluster) that uses this cluster as a serviceRef
           type: array
           items:
-            $ref: '#/components/schemas/serviceRef'
+            $ref: '#/components/schemas/clusterReference'
         objectStorageConfig:
           $ref: '#/components/schemas/clusterObjectStorageConfig'
         maintainceWindow:
@@ -29281,6 +29346,28 @@ components:
         disableManualInput:
           type: boolean
           description: whether to disable manual input of the service reference. If set to true, users can only select from the serviceRefs provided by list clusters api.
+        disableAutoCreateServiceDescriptor:
+          type: boolean
+          x-nullable: true
+          description: |
+            whether to disable auto creating the ServiceDescriptor object for this serviceRef.
+            If set to false, the serviceDescriptor content (host/port/username/password) will be
+            set directly into the helm values under the helmValuePath.serviceDescriptor path.
+            If omitted, the generated ServiceDescriptor name will be set instead.
+        disableRelatedCluster:
+          type: boolean
+          description: |
+            whether to disable selecting a related cluster created in the platform for this
+            serviceRef. If set to true, the frontend should only allow manual input instead
+            of selecting from the clusters provided by the list clusters api.
+        extraForManualInput:
+          type: object
+          description: |
+            Extra form field definitions for manual input of the serviceRef. The keys are the
+            field names and the frontend renders them as input items. The user-entered values
+            are passed in ClusterCreate serviceRefs[].extraForManualInput and mapped to helm
+            values via helmValuePath.extraForManualInput.
+          additionalProperties: true
         helmValuePath:
           type: object
           description: The path to be used in values. Separated with commas. ClusterCreate API will use these path to override values in the cluster chart.
@@ -29317,6 +29404,12 @@ components:
               description: |
                 hints for addon to determine if we are using an integrated component or a serviceRef. Will be set to `serviceRef` or `component`.
                 This field is required when a serviceRef can be replaced by a component.
+            extraForManualInput:
+              type: string
+              description: |
+                the helm value path prefix for the extraForManualInput fields of this serviceRef.
+                ClusterCreate API will map each key of serviceRefs[].extraForManualInput to
+                `<extraForManualInput>.<key>` in the cluster chart values.
         serviceSelectors:
           type: array
           description: |
@@ -32972,9 +33065,7 @@ components:
           type: string
           description: Hash field name.
         value:
-          type: object
-          description: Hash/list/set/json item value.
-          additionalProperties: true
+          description: Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
         member:
           type: string
           description: Set or sorted-set member.
@@ -35542,8 +35633,11 @@ components:
         format:
           $ref: '#/components/schemas/ESSecurityRoleTemplateFormat'
           nullable: true
+      required:
+        - template
     ESSecurityRoleMapping:
       type: object
+      description: Native Elasticsearch security role mapping. At least one of roles or role_templates must be non-empty.
       properties:
         enabled:
           type: boolean
@@ -35564,6 +35658,9 @@ components:
         metadata:
           type: object
           additionalProperties: true
+      required:
+        - enabled
+        - rules
     ESSecurityRoleMappings:
       type: object
       additionalProperties:
@@ -35904,9 +36001,23 @@ components:
           description: Milvus roles.
           items:
             $ref: '#/components/schemas/MilvusRole'
+    MilvusRoleCreateRequest:
+      type: object
+      description: Milvus role create request.
+      required:
+        - name
+      properties:
+        name:
+          type: string
+          description: Milvus role name.
+        grants:
+          type: array
+          description: Native Milvus privilege grants owned by this role.
+          items:
+            $ref: '#/components/schemas/MilvusRoleGrant'
     MilvusRoleRequest:
       type: object
-      description: Milvus role upsert request.
+      description: Milvus role update request.
       properties:
         grants:
           type: array