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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/dist/adminapi/apis/account-api.d.ts +151 -79
  2. package/dist/adminapi/apis/account-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/account-api.js +165 -85
  4. package/dist/adminapi/apis/account-api.js.map +1 -1
  5. package/dist/adminapi/apis/milvus-api.d.ts +151 -79
  6. package/dist/adminapi/apis/milvus-api.d.ts.map +1 -1
  7. package/dist/adminapi/apis/milvus-api.js +153 -73
  8. package/dist/adminapi/apis/milvus-api.js.map +1 -1
  9. package/dist/adminapi/apis/shared-api.d.ts +151 -79
  10. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/shared-api.js +165 -85
  12. package/dist/adminapi/apis/shared-api.js.map +1 -1
  13. package/dist/adminapi/models/cluster-reference.d.ts +31 -0
  14. package/dist/adminapi/models/cluster-reference.d.ts.map +1 -0
  15. package/dist/adminapi/models/cluster-reference.js +16 -0
  16. package/dist/adminapi/models/cluster-reference.js.map +1 -0
  17. package/dist/adminapi/models/cluster.d.ts +3 -2
  18. package/dist/adminapi/models/cluster.d.ts.map +1 -1
  19. package/dist/adminapi/models/index.d.ts +2 -0
  20. package/dist/adminapi/models/index.d.ts.map +1 -1
  21. package/dist/adminapi/models/index.js +2 -0
  22. package/dist/adminapi/models/index.js.map +1 -1
  23. package/dist/adminapi/models/milvus-role-create-request.d.ts +32 -0
  24. package/dist/adminapi/models/milvus-role-create-request.d.ts.map +1 -0
  25. package/dist/adminapi/models/milvus-role-create-request.js +16 -0
  26. package/dist/adminapi/models/milvus-role-create-request.js.map +1 -0
  27. package/dist/adminapi/models/milvus-role-request.d.ts +1 -1
  28. package/dist/adminapi/models/mode-service-ref-helm-value-path.d.ts +6 -0
  29. package/dist/adminapi/models/mode-service-ref-helm-value-path.d.ts.map +1 -1
  30. package/dist/adminapi/models/mode-service-ref.d.ts +20 -0
  31. package/dist/adminapi/models/mode-service-ref.d.ts.map +1 -1
  32. package/dist/adminapi/models/redis-key-value-item.d.ts +3 -5
  33. package/dist/adminapi/models/redis-key-value-item.d.ts.map +1 -1
  34. package/dist/adminapi/models/service-ref.d.ts +8 -0
  35. package/dist/adminapi/models/service-ref.d.ts.map +1 -1
  36. package/dist/internalapi/models/cluster-reference.d.ts +31 -0
  37. package/dist/internalapi/models/cluster-reference.d.ts.map +1 -0
  38. package/dist/internalapi/models/cluster-reference.js +16 -0
  39. package/dist/internalapi/models/cluster-reference.js.map +1 -0
  40. package/dist/internalapi/models/cluster.d.ts +3 -2
  41. package/dist/internalapi/models/cluster.d.ts.map +1 -1
  42. package/dist/internalapi/models/index.d.ts +1 -0
  43. package/dist/internalapi/models/index.d.ts.map +1 -1
  44. package/dist/internalapi/models/index.js +1 -0
  45. package/dist/internalapi/models/index.js.map +1 -1
  46. package/dist/internalapi/models/service-ref.d.ts +8 -0
  47. package/dist/internalapi/models/service-ref.d.ts.map +1 -1
  48. package/dist/openapi/apis/account-api.d.ts +151 -79
  49. package/dist/openapi/apis/account-api.d.ts.map +1 -1
  50. package/dist/openapi/apis/account-api.js +165 -85
  51. package/dist/openapi/apis/account-api.js.map +1 -1
  52. package/dist/openapi/apis/milvus-api.d.ts +151 -79
  53. package/dist/openapi/apis/milvus-api.d.ts.map +1 -1
  54. package/dist/openapi/apis/milvus-api.js +153 -73
  55. package/dist/openapi/apis/milvus-api.js.map +1 -1
  56. package/dist/openapi/apis/shared-api.d.ts +151 -79
  57. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  58. package/dist/openapi/apis/shared-api.js +165 -85
  59. package/dist/openapi/apis/shared-api.js.map +1 -1
  60. package/dist/openapi/models/cluster-reference.d.ts +31 -0
  61. package/dist/openapi/models/cluster-reference.d.ts.map +1 -0
  62. package/dist/openapi/models/cluster-reference.js +16 -0
  63. package/dist/openapi/models/cluster-reference.js.map +1 -0
  64. package/dist/openapi/models/cluster.d.ts +3 -2
  65. package/dist/openapi/models/cluster.d.ts.map +1 -1
  66. package/dist/openapi/models/index.d.ts +2 -0
  67. package/dist/openapi/models/index.d.ts.map +1 -1
  68. package/dist/openapi/models/index.js +2 -0
  69. package/dist/openapi/models/index.js.map +1 -1
  70. package/dist/openapi/models/milvus-role-create-request.d.ts +32 -0
  71. package/dist/openapi/models/milvus-role-create-request.d.ts.map +1 -0
  72. package/dist/openapi/models/milvus-role-create-request.js +16 -0
  73. package/dist/openapi/models/milvus-role-create-request.js.map +1 -0
  74. package/dist/openapi/models/milvus-role-request.d.ts +1 -1
  75. package/dist/openapi/models/mode-service-ref-helm-value-path.d.ts +6 -0
  76. package/dist/openapi/models/mode-service-ref-helm-value-path.d.ts.map +1 -1
  77. package/dist/openapi/models/mode-service-ref.d.ts +20 -0
  78. package/dist/openapi/models/mode-service-ref.d.ts.map +1 -1
  79. package/dist/openapi/models/redis-key-value-item.d.ts +3 -5
  80. package/dist/openapi/models/redis-key-value-item.d.ts.map +1 -1
  81. package/dist/openapi/models/service-ref.d.ts +8 -0
  82. package/dist/openapi/models/service-ref.d.ts.map +1 -1
  83. package/package.json +1 -1
  84. package/src/adminapi/.openapi-generator/FILES +2 -0
  85. package/src/adminapi/apis/account-api.ts +266 -138
  86. package/src/adminapi/apis/milvus-api.ts +242 -114
  87. package/src/adminapi/apis/shared-api.ts +266 -138
  88. package/src/adminapi/models/cluster-reference.ts +36 -0
  89. package/src/adminapi/models/cluster.ts +5 -2
  90. package/src/adminapi/models/index.ts +2 -0
  91. package/src/adminapi/models/milvus-role-create-request.ts +39 -0
  92. package/src/adminapi/models/milvus-role-request.ts +1 -1
  93. package/src/adminapi/models/mode-service-ref-helm-value-path.ts +6 -0
  94. package/src/adminapi/models/mode-service-ref.ts +18 -0
  95. package/src/adminapi/models/redis-key-value-item.ts +3 -3
  96. package/src/adminapi/models/service-ref.ts +6 -0
  97. package/src/adminapi.yaml +113 -8
  98. package/src/internalapi/.openapi-generator/FILES +1 -0
  99. package/src/internalapi/models/cluster-reference.ts +36 -0
  100. package/src/internalapi/models/cluster.ts +5 -2
  101. package/src/internalapi/models/index.ts +1 -0
  102. package/src/internalapi/models/service-ref.ts +6 -0
  103. package/src/internalapi.yaml +19 -1
  104. package/src/openapi/.openapi-generator/FILES +2 -0
  105. package/src/openapi/apis/account-api.ts +266 -138
  106. package/src/openapi/apis/milvus-api.ts +242 -114
  107. package/src/openapi/apis/shared-api.ts +266 -138
  108. package/src/openapi/models/cluster-reference.ts +36 -0
  109. package/src/openapi/models/cluster.ts +5 -2
  110. package/src/openapi/models/index.ts +2 -0
  111. package/src/openapi/models/milvus-role-create-request.ts +39 -0
  112. package/src/openapi/models/milvus-role-request.ts +1 -1
  113. package/src/openapi/models/mode-service-ref-helm-value-path.ts +6 -0
  114. package/src/openapi/models/mode-service-ref.ts +18 -0
  115. package/src/openapi/models/redis-key-value-item.ts +3 -3
  116. package/src/openapi/models/service-ref.ts +6 -0
  117. package/src/openapi.yaml +113 -8
@@ -74,6 +74,24 @@ export interface ModeServiceRef {
74
74
  * @memberof ModeServiceRef
75
75
  */
76
76
  'disableManualInput'?: boolean;
77
+ /**
78
+ * 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.
79
+ * @type {boolean}
80
+ * @memberof ModeServiceRef
81
+ */
82
+ 'disableAutoCreateServiceDescriptor'?: boolean | null;
83
+ /**
84
+ * 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.
85
+ * @type {boolean}
86
+ * @memberof ModeServiceRef
87
+ */
88
+ 'disableRelatedCluster'?: boolean;
89
+ /**
90
+ * 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.
91
+ * @type {{ [key: string]: any; }}
92
+ * @memberof ModeServiceRef
93
+ */
94
+ 'extraForManualInput'?: { [key: string]: any; };
77
95
  /**
78
96
  *
79
97
  * @type {ModeServiceRefHelmValuePath}
@@ -27,11 +27,11 @@ export interface RedisKeyValueItem {
27
27
  */
28
28
  'field'?: string;
29
29
  /**
30
- * Hash/list/set/json item value.
31
- * @type {{ [key: string]: any; }}
30
+ * Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
31
+ * @type {any}
32
32
  * @memberof RedisKeyValueItem
33
33
  */
34
- 'value'?: { [key: string]: any; };
34
+ 'value'?: any;
35
35
  /**
36
36
  * Set or sorted-set member.
37
37
  * @type {string}
@@ -47,5 +47,11 @@ export interface ServiceRef {
47
47
  * @memberof ServiceRef
48
48
  */
49
49
  'serviceDescriptor'?: ServiceDescriptor;
50
+ /**
51
+ * 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.
52
+ * @type {{ [key: string]: string; }}
53
+ * @memberof ServiceRef
54
+ */
55
+ 'extraForManualInput'?: { [key: string]: string; };
50
56
  }
51
57
 
package/src/openapi.yaml CHANGED
@@ -17460,6 +17460,53 @@ paths:
17460
17460
  $ref: '#/components/responses/404'
17461
17461
  '500':
17462
17462
  $ref: '#/components/responses/500'
17463
+ post:
17464
+ summary: Create Milvus role
17465
+ description: Create a Milvus native role and grant its initial privileges.
17466
+ operationId: createMilvusRole
17467
+ parameters:
17468
+ - description: name of the Org
17469
+ in: path
17470
+ name: orgName
17471
+ required: true
17472
+ schema:
17473
+ type: string
17474
+ - description: name of the Cluster
17475
+ in: path
17476
+ name: clusterName
17477
+ required: true
17478
+ schema:
17479
+ type: string
17480
+ tags:
17481
+ - account
17482
+ - milvus
17483
+ - shared
17484
+ requestBody:
17485
+ required: true
17486
+ content:
17487
+ application/json:
17488
+ schema:
17489
+ $ref: '#/components/schemas/MilvusRoleCreateRequest'
17490
+ responses:
17491
+ '200':
17492
+ description: A successful response.
17493
+ content:
17494
+ application/json:
17495
+ schema:
17496
+ $ref: '#/components/schemas/MilvusRole'
17497
+ '400':
17498
+ $ref: '#/components/responses/400'
17499
+ '401':
17500
+ $ref: '#/components/responses/401'
17501
+ '403':
17502
+ $ref: '#/components/responses/403'
17503
+ '404':
17504
+ $ref: '#/components/responses/404'
17505
+ '409':
17506
+ $ref: '#/components/responses/409'
17507
+ '500':
17508
+ $ref: '#/components/responses/500'
17509
+ x-codegen-request-body-name: body
17463
17510
  /api/v1/data/milvus/organizations/{orgName}/clusters/{clusterName}/accounts/roles/{roleName}:
17464
17511
  get:
17465
17512
  summary: Get Milvus role
@@ -17506,9 +17553,9 @@ paths:
17506
17553
  '500':
17507
17554
  $ref: '#/components/responses/500'
17508
17555
  put:
17509
- summary: Put Milvus role
17510
- description: Create or update a Milvus native role and replace its privilege grants.
17511
- operationId: putMilvusRole
17556
+ summary: Update Milvus role
17557
+ description: Update an existing Milvus native role by replacing its privilege grants.
17558
+ operationId: updateMilvusRole
17512
17559
  parameters:
17513
17560
  - description: name of the Org
17514
17561
  in: path
@@ -23366,6 +23413,14 @@ components:
23366
23413
  description: the cluster definition of the referenced cluster.
23367
23414
  serviceDescriptor:
23368
23415
  $ref: '#/components/schemas/serviceDescriptor'
23416
+ extraForManualInput:
23417
+ type: object
23418
+ additionalProperties:
23419
+ type: string
23420
+ description: |
23421
+ extra fields for manual input of the serviceRef. The keys must be defined in the
23422
+ engineoption modeServiceRef.extraForManualInput. They are mapped to helm values
23423
+ via the corresponding helmValuePath.extraForManualInput.
23369
23424
  clusterObjectStorageConfig:
23370
23425
  type: object
23371
23426
  description: Specify the object storage config for cluster like starrocks
@@ -23570,6 +23625,16 @@ components:
23570
23625
  description: Components is the list of components
23571
23626
  items:
23572
23627
  $ref: '#/components/schemas/componentItem'
23628
+ clusterReference:
23629
+ type: object
23630
+ description: Cluster reference information returned by cluster detail APIs.
23631
+ properties:
23632
+ cluster:
23633
+ type: string
23634
+ description: Name of the cluster that references this cluster.
23635
+ clusterDefinition:
23636
+ type: string
23637
+ description: Cluster definition of the referencing cluster.
23573
23638
  cluster:
23574
23639
  required:
23575
23640
  - engine
@@ -23739,7 +23804,7 @@ components:
23739
23804
  description: this list of objects (currently, object is a cluster) that uses this cluster as a serviceRef
23740
23805
  type: array
23741
23806
  items:
23742
- $ref: '#/components/schemas/serviceRef'
23807
+ $ref: '#/components/schemas/clusterReference'
23743
23808
  objectStorageConfig:
23744
23809
  $ref: '#/components/schemas/clusterObjectStorageConfig'
23745
23810
  maintainceWindow:
@@ -29281,6 +29346,28 @@ components:
29281
29346
  disableManualInput:
29282
29347
  type: boolean
29283
29348
  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.
29349
+ disableAutoCreateServiceDescriptor:
29350
+ type: boolean
29351
+ x-nullable: true
29352
+ description: |
29353
+ whether to disable auto creating the ServiceDescriptor object for this serviceRef.
29354
+ If set to false, the serviceDescriptor content (host/port/username/password) will be
29355
+ set directly into the helm values under the helmValuePath.serviceDescriptor path.
29356
+ If omitted, the generated ServiceDescriptor name will be set instead.
29357
+ disableRelatedCluster:
29358
+ type: boolean
29359
+ description: |
29360
+ whether to disable selecting a related cluster created in the platform for this
29361
+ serviceRef. If set to true, the frontend should only allow manual input instead
29362
+ of selecting from the clusters provided by the list clusters api.
29363
+ extraForManualInput:
29364
+ type: object
29365
+ description: |
29366
+ Extra form field definitions for manual input of the serviceRef. The keys are the
29367
+ field names and the frontend renders them as input items. The user-entered values
29368
+ are passed in ClusterCreate serviceRefs[].extraForManualInput and mapped to helm
29369
+ values via helmValuePath.extraForManualInput.
29370
+ additionalProperties: true
29284
29371
  helmValuePath:
29285
29372
  type: object
29286
29373
  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:
29317
29404
  description: |
29318
29405
  hints for addon to determine if we are using an integrated component or a serviceRef. Will be set to `serviceRef` or `component`.
29319
29406
  This field is required when a serviceRef can be replaced by a component.
29407
+ extraForManualInput:
29408
+ type: string
29409
+ description: |
29410
+ the helm value path prefix for the extraForManualInput fields of this serviceRef.
29411
+ ClusterCreate API will map each key of serviceRefs[].extraForManualInput to
29412
+ `<extraForManualInput>.<key>` in the cluster chart values.
29320
29413
  serviceSelectors:
29321
29414
  type: array
29322
29415
  description: |
@@ -32972,9 +33065,7 @@ components:
32972
33065
  type: string
32973
33066
  description: Hash field name.
32974
33067
  value:
32975
- type: object
32976
- description: Hash/list/set/json item value.
32977
- additionalProperties: true
33068
+ description: Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
32978
33069
  member:
32979
33070
  type: string
32980
33071
  description: Set or sorted-set member.
@@ -35910,9 +36001,23 @@ components:
35910
36001
  description: Milvus roles.
35911
36002
  items:
35912
36003
  $ref: '#/components/schemas/MilvusRole'
36004
+ MilvusRoleCreateRequest:
36005
+ type: object
36006
+ description: Milvus role create request.
36007
+ required:
36008
+ - name
36009
+ properties:
36010
+ name:
36011
+ type: string
36012
+ description: Milvus role name.
36013
+ grants:
36014
+ type: array
36015
+ description: Native Milvus privilege grants owned by this role.
36016
+ items:
36017
+ $ref: '#/components/schemas/MilvusRoleGrant'
35913
36018
  MilvusRoleRequest:
35914
36019
  type: object
35915
- description: Milvus role upsert request.
36020
+ description: Milvus role update request.
35916
36021
  properties:
35917
36022
  grants:
35918
36023
  type: array