kb-cloud-client-typescript 2.3.0-alpha.136 → 2.3.0-alpha.137

package/src/adminapi/models/index.ts

@@ -429,11 +429,13 @@ export * from './import-task-status';
 export * from './init-option-item';
 export * from './init-option-object';
 export * from './init-option-type';
+export * from './inspection-criticality';
 export * from './inspection-script';
 export * from './inspection-script-category';
 export * from './inspection-task';
 export * from './inspection-task-format';
 export * from './inspection-task-item';
+export * from './inspection-threshold-direction';
 export * from './instance';
 export * from './instance-disk-usage-item';
 export * from './instance-event-item';

package/src/adminapi/models/inspection-criticality.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * First-version criticality assumption for score weighting and red-item veto behavior. Missing legacy values are treated as medium.
+ * @export
+ * @enum {string}
+ */
+
+export const InspectionCriticality = {
+    critical: 'critical',
+    high: 'high',
+    medium: 'medium',
+    low: 'low'
+} as const;
+
+export type InspectionCriticality = typeof InspectionCriticality[keyof typeof InspectionCriticality];
+
+
+

package/src/adminapi/models/inspection-script-category.ts

@@ -15,17 +15,20 @@
 
 
 /**
- * Specifies the category of the inspection script.
+ * Current inspection category vocabulary. Existing legacy categories are normalized by the backend before they are returned.
  * @export
  * @enum {string}
  */
 
 export const InspectionScriptCategory = {
-    performance: 'performance',
     availability: 'availability',
-    security: 'security',
+    performance: 'performance',
+    connections: 'connections',
+    resource: 'resource',
+    capacity: 'capacity',
+    vacuumWraparound: 'vacuumWraparound',
     backup: 'backup',
-    other: 'other'
+    security: 'security'
 } as const;
 
 export type InspectionScriptCategory = typeof InspectionScriptCategory[keyof typeof InspectionScriptCategory];

package/src/adminapi/models/inspection-script.ts

@@ -13,11 +13,17 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InspectionCriticality } from './inspection-criticality';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { InspectionScriptCategory } from './inspection-script-category';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { InspectionThresholdDirection } from './inspection-threshold-direction';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { LocalizedDescription } from './localized-description';
 
 /**
@@ -80,6 +86,42 @@ export interface InspectionScript {
      * @memberof InspectionScript
      */
     'checkExpr'?: string;
+    /**
+     * 
+     * @type {InspectionCriticality}
+     * @memberof InspectionScript
+     */
+    'criticality'?: InspectionCriticality;
+    /**
+     * First-version warning threshold assumption. It documents the script contract and is not a permanent product conclusion.
+     * @type {number}
+     * @memberof InspectionScript
+     */
+    'warnThreshold'?: number | null;
+    /**
+     * First-version critical threshold assumption. It documents the script contract and is not a permanent product conclusion.
+     * @type {number}
+     * @memberof InspectionScript
+     */
+    'critThreshold'?: number | null;
+    /**
+     * 
+     * @type {InspectionThresholdDirection}
+     * @memberof InspectionScript
+     */
+    'direction'?: InspectionThresholdDirection;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InspectionScript
+     */
+    'remediation'?: LocalizedDescription;
+    /**
+     * 
+     * @type {string}
+     * @memberof InspectionScript
+     */
+    'docLink'?: string;
     /**
      * scope type, such as \"system\"/\"global\"/\"org\"
      * @type {string}

package/src/adminapi/models/inspection-task-item.ts

@@ -13,6 +13,12 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InspectionCriticality } from './inspection-criticality';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InspectionThresholdDirection } from './inspection-threshold-direction';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { LocalizedDescription } from './localized-description';
@@ -89,6 +95,60 @@ export interface InspectionTaskItem {
      * @memberof InspectionTaskItem
      */
     'result'?: string;
+    /**
+     * Numeric form of result when the result is parseable.
+     * @type {number}
+     * @memberof InspectionTaskItem
+     */
+    'valueNum'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof InspectionTaskItem
+     */
+    'warnThreshold'?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof InspectionTaskItem
+     */
+    'critThreshold'?: number | null;
+    /**
+     * 
+     * @type {InspectionThresholdDirection}
+     * @memberof InspectionTaskItem
+     */
+    'direction'?: InspectionThresholdDirection;
+    /**
+     * 
+     * @type {InspectionCriticality}
+     * @memberof InspectionTaskItem
+     */
+    'criticality'?: InspectionCriticality;
+    /**
+     * Structured evidence used to explain the item result. Prometheus/exporter no-data is reported here as no data or unknown instead of being converted into a healthy result.
+     * @type {{ [key: string]: any; }}
+     * @memberof InspectionTaskItem
+     */
+    'evidence'?: { [key: string]: any; };
+    /**
+     * Item-level timestamp for when this item\'s status was last evaluated or changed.
+     * @type {string}
+     * @memberof InspectionTaskItem
+     */
+    'statusChangedAt'?: string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof InspectionTaskItem
+     */
+    'remediation'?: LocalizedDescription;
+    /**
+     * 
+     * @type {string}
+     * @memberof InspectionTaskItem
+     */
+    'docLink'?: string;
     /**
      * 
      * @type {string}
@@ -115,3 +175,5 @@ export interface InspectionTaskItem {
     'updatedAt'?: string;
 }
 
+
+

package/src/adminapi/models/inspection-task.ts

@@ -96,11 +96,35 @@ export interface InspectionTask {
      */
     'score'?: number;
     /**
-     * 
+     * Backend truth derived from the worst item state and criticality-aware score caps. A red item makes the task red; a critical red item caps score at 40.
      * @type {string}
      * @memberof InspectionTask
      */
     'result'?: string;
+    /**
+     * Last inspection execution timestamp used for freshness checks.
+     * @type {string}
+     * @memberof InspectionTask
+     */
+    'latestRunAt'?: string;
+    /**
+     * Expected first-version inspection interval assumption, for example 1h.
+     * @type {string}
+     * @memberof InspectionTask
+     */
+    'expectedInterval'?: string;
+    /**
+     * Expected next inspection time derived from latestRunAt and expectedInterval.
+     * @type {string}
+     * @memberof InspectionTask
+     */
+    'nextRunAt'?: string;
+    /**
+     * True when the latest inspection is older than the expected interval. Stale or missing inspection data must not be displayed as healthy.
+     * @type {boolean}
+     * @memberof InspectionTask
+     */
+    'isStale'?: boolean;
     /**
      * 
      * @type {Array<InspectionTaskItem>}

package/src/adminapi/models/inspection-threshold-direction.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * Direction used to interpret warnThreshold and critThreshold. asc means larger values are worse, desc means smaller values are worse, boolean means the check expression decides.
+ * @export
+ * @enum {string}
+ */
+
+export const InspectionThresholdDirection = {
+    asc: 'asc',
+    desc: 'desc',
+    boolean: 'boolean'
+} as const;
+
+export type InspectionThresholdDirection = typeof InspectionThresholdDirection[keyof typeof InspectionThresholdDirection];
+
+
+

package/src/adminapi/models/redis-data-capabilities.ts

@@ -35,6 +35,12 @@ export interface RedisDataCapabilities {
      * @memberof RedisDataCapabilities
      */
     'browser'?: RedisCapability;
+    /**
+     * 
+     * @type {RedisCapability}
+     * @memberof RedisDataCapabilities
+     */
+    'database'?: RedisCapability;
     /**
      * 
      * @type {RedisCapability}

package/src/adminapi/models/redis-data-context.ts

@@ -48,11 +48,17 @@ export interface RedisDataContext {
      */
     'acl'?: RedisACLContext;
     /**
-     * 
+     * Current logical Redis database index for this request context.
      * @type {number}
      * @memberof RedisDataContext
      */
     'dbIndex'?: number;
+    /**
+     * Available logical Redis database count. Non-cluster Redis defaults to 16 when the server does not expose a count; Redis Cluster is always 1.
+     * @type {number}
+     * @memberof RedisDataContext
+     */
+    'dbCount'?: number;
     /**
      * Redis architecture mode, such as standalone, replication, sentinel, or cluster
      * @type {string}

package/src/adminapi.yaml

@@ -5332,6 +5332,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Current logical Redis database index for this context. Omitted uses the datasource default; Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       responses:
         '200':
           description: A successful response.
@@ -5361,6 +5368,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
         - name: cursor
           in: query
           required: false
@@ -5490,6 +5504,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5525,6 +5546,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5561,6 +5589,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for this command. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5596,6 +5631,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for this Pub/Sub client. Redis Pub/Sub is server-level, but the client connection is still scoped to the selected DB for consistency.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5631,6 +5673,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for the polling client connection.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5742,6 +5791,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. SlowLog is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
         - name: limit
           in: query
           required: false
@@ -5782,6 +5838,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. SlowLog reset is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -5817,6 +5880,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. INFO is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
         - name: section
           in: query
           required: false
@@ -5856,6 +5926,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster topology only supports database 0.
+          schema:
+            type: integer
+            format: int64
       responses:
         '200':
           description: A successful response.
@@ -26272,6 +26349,8 @@ components:
           $ref: '#/components/schemas/RedisCapability'
         browser:
           $ref: '#/components/schemas/RedisCapability'
+        database:
+          $ref: '#/components/schemas/RedisCapability'
         workbench:
           $ref: '#/components/schemas/RedisCapability'
         pubsub:
@@ -26333,6 +26412,12 @@ components:
         dbIndex:
           type: integer
           format: int64
+          description: Current logical Redis database index for this request context.
+        dbCount:
+          type: integer
+          format: int64
+          description: Available logical Redis database count. Non-cluster Redis defaults to 16 when the server does not expose a count; Redis Cluster is always 1.
+          x-omitempty: false
         mode:
           type: string
           description: Redis architecture mode, such as standalone, replication, sentinel, or cluster
@@ -34848,13 +34933,31 @@ components:
       type: object
     inspectionScriptCategory:
       type: string
-      description: Specifies the category of the inspection script.
+      description: Current inspection category vocabulary. Existing legacy categories are normalized by the backend before they are returned.
       enum:
-        - performance
         - availability
-        - security
+        - performance
+        - connections
+        - resource
+        - capacity
+        - vacuumWraparound
         - backup
-        - other
+        - security
+    inspectionCriticality:
+      type: string
+      description: First-version criticality assumption for score weighting and red-item veto behavior. Missing legacy values are treated as medium.
+      enum:
+        - critical
+        - high
+        - medium
+        - low
+    inspectionThresholdDirection:
+      type: string
+      description: Direction used to interpret warnThreshold and critThreshold. asc means larger values are worse, desc means smaller values are worse, boolean means the check expression decides.
+      enum:
+        - asc
+        - desc
+        - boolean
     inspectionScript:
       required:
         - name
@@ -34886,6 +34989,24 @@ components:
           type: string
         checkExpr:
           type: string
+        criticality:
+          $ref: '#/components/schemas/inspectionCriticality'
+        warnThreshold:
+          type: number
+          format: double
+          x-nullable: true
+          description: First-version warning threshold assumption. It documents the script contract and is not a permanent product conclusion.
+        critThreshold:
+          type: number
+          format: double
+          x-nullable: true
+          description: First-version critical threshold assumption. It documents the script contract and is not a permanent product conclusion.
+        direction:
+          $ref: '#/components/schemas/inspectionThresholdDirection'
+        remediation:
+          $ref: '#/components/schemas/localizedDescription'
+        docLink:
+          type: string
         scopeType:
           description: scope type, such as "system"/"global"/"org"
           type: string
@@ -34961,6 +35082,10 @@ components:
           type: string
         enabled:
           type: boolean
+    inspectionTaskItemEvidence:
+      type: object
+      description: Structured evidence used to explain the item result. Prometheus/exporter no-data is reported here as no data or unknown instead of being converted into a healthy result.
+      additionalProperties: true
     inspectionTaskItem:
       properties:
         id:
@@ -34985,6 +35110,33 @@ components:
           type: string
         result:
           type: string
+        valueNum:
+          type: number
+          format: double
+          x-nullable: true
+          description: Numeric form of result when the result is parseable.
+        warnThreshold:
+          type: number
+          format: double
+          x-nullable: true
+        critThreshold:
+          type: number
+          format: double
+          x-nullable: true
+        direction:
+          $ref: '#/components/schemas/inspectionThresholdDirection'
+        criticality:
+          $ref: '#/components/schemas/inspectionCriticality'
+        evidence:
+          $ref: '#/components/schemas/inspectionTaskItemEvidence'
+        statusChangedAt:
+          format: date-time
+          type: string
+          description: Item-level timestamp for when this item's status was last evaluated or changed.
+        remediation:
+          $ref: '#/components/schemas/localizedDescription'
+        docLink:
+          type: string
         severity:
           type: string
         unit:
@@ -35024,6 +35176,21 @@ components:
           type: integer
         result:
           type: string
+          description: Backend truth derived from the worst item state and criticality-aware score caps. A red item makes the task red; a critical red item caps score at 40.
+        latestRunAt:
+          format: date-time
+          type: string
+          description: Last inspection execution timestamp used for freshness checks.
+        expectedInterval:
+          type: string
+          description: Expected first-version inspection interval assumption, for example 1h.
+        nextRunAt:
+          format: date-time
+          type: string
+          description: Expected next inspection time derived from latestRunAt and expectedInterval.
+        isStale:
+          type: boolean
+          description: True when the latest inspection is older than the expected interval. Stale or missing inspection data must not be displayed as healthy.
         items:
           type: array
           items:

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

@@ -486,11 +486,13 @@ models/index.ts
 models/init-option-item.ts
 models/init-option-object.ts
 models/init-option-type.ts
+models/inspection-criticality.ts
 models/inspection-script-category.ts
 models/inspection-script.ts
 models/inspection-task-format.ts
 models/inspection-task-item.ts
 models/inspection-task.ts
+models/inspection-threshold-direction.ts
 models/instance-disk-usage-item.ts
 models/instance-event-item.ts
 models/instance-event-list.ts