chore: update

sentioxyz · Oct 30, 2024 · 790ce34 · 790ce34
1 parent 4f38986
commit 790ce34
Show file tree

Hide file tree

Showing 217 changed files with 2,614 additions and 894 deletions.
diff --git a/doc/index.html b/doc/index.html
diff --git a/openapi.json b/openapi.json
@@ -1753,17 +1753,21 @@
       "properties": {
         "cacheTtlSecs": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "title": "how long the cache will be stored before it is evicted"
         },
         "cacheRefreshTtlSecs": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "title": "how long the cache will be refreshed in the background"
         },
         "forceRefresh": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "force refresh the cache now"
         },
         "noCache": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "do not use cache"
         }
       }
     },
@@ -1812,7 +1816,8 @@
         "pagerdutyConfig": {
           "type": "object"
         }
-      }
+      },
+      "title": "TODO, finish this"
     },
     "common.Channel.Type": {
       "type": "string",
@@ -1929,7 +1934,8 @@
       "type": "object",
       "properties": {
         "joinOperator": {
-          "$ref": "#/definitions/common.JoinOperator"
+          "$ref": "#/definitions/common.JoinOperator",
+          "title": "not support THEN"
         },
         "groups": {
           "type": "array",
@@ -2157,7 +2163,8 @@
           "type": "string"
         },
         "alias": {
-          "type": "string"
+          "type": "string",
+          "title": "bool enabled = 2;"
         },
         "id": {
           "type": "string"
@@ -2390,7 +2397,8 @@
           "format": "int64"
         },
         "slug": {
-          "type": "string"
+          "type": "string",
+          "title": "{ownerName}/{slug} is the unique name of the project"
         },
         "ownerId": {
           "type": "string"
@@ -2587,13 +2595,16 @@
       },
       "properties": {
         "query": {
-          "type": "string"
+          "type": "string",
+          "title": "the promql query or the metric name"
         },
         "alias": {
-          "type": "string"
+          "type": "string",
+          "title": "the alias of the query"
         },
         "id": {
-          "type": "string"
+          "type": "string",
+          "title": "the id of the query"
         },
         "labelSelector": {
           "type": "object",
@@ -2612,7 +2623,8 @@
           }
         },
         "disabled": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "hide the result, usually used for formula, default is false"
         }
       },
       "description": "the query to fetch metrics data, promql",
@@ -2678,7 +2690,8 @@
           "items": {
             "type": "object",
             "$ref": "#/definitions/common.RetentionQuery.Resource"
-          }
+          },
+          "title": "only support 2 resources"
         },
         "criteria": {
           "$ref": "#/definitions/common.RetentionQuery.Criteria"
@@ -3015,7 +3028,8 @@
           }
         },
         "operator": {
-          "$ref": "#/definitions/common.JoinOperator"
+          "$ref": "#/definitions/common.JoinOperator",
+          "title": "default is AND"
         }
       }
     },
@@ -3035,7 +3049,8 @@
             "$ref": "#/definitions/common.Any"
           }
         }
-      }
+      },
+      "title": "TODO maybe MetricQuery should use this as well"
     },
     "common.Selector.OperatorType": {
       "type": "string",
@@ -3055,7 +3070,9 @@
         "IN_COHORTS",
         "NOT_IN_COHORTS"
       ],
-      "default": "EQ"
+      "default": "EQ",
+      "description": "- GT: Numeric operators\n - CONTAINS: String operators",
+      "title": "TODO add Date Value and List Value and its data type"
     },
     "common.SelectorExpr": {
       "type": "object",
@@ -3066,7 +3083,8 @@
         "logicExpr": {
           "$ref": "#/definitions/common.SelectorExpr.LogicExpr"
         }
-      }
+      },
+      "title": "TODO migrate segmentationQuery to use this"
     },
     "common.SelectorExpr.LogicExpr": {
       "type": "object",
@@ -3079,7 +3097,8 @@
           }
         },
         "operator": {
-          "$ref": "#/definitions/common.JoinOperator"
+          "$ref": "#/definitions/common.JoinOperator",
+          "title": "default is AND"
         }
       }
     },
@@ -3090,7 +3109,8 @@
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "JoinOperator operator = 2; // this field should implement in the future"
         }
       }
     },
@@ -3160,7 +3180,8 @@
           "format": "int64"
         },
         "interval": {
-          "$ref": "#/definitions/common.Duration"
+          "$ref": "#/definitions/common.Duration",
+          "title": "TODO remove step in favor of interval"
         },
         "timezone": {
           "type": "string"
@@ -3211,7 +3232,8 @@
         },
         "step": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "title": "interval in seconds between each data point"
         },
         "timezone": {
           "type": "string"
@@ -3309,7 +3331,8 @@
         "username": {
           "type": "string"
         }
-      }
+      },
+      "description": "The same to user but with sensitive data removed."
     },
     "evm.AccessListItem": {
       "type": "object",
@@ -3395,7 +3418,8 @@
           "type": "string"
         },
         "status": {
-          "type": "string"
+          "type": "string",
+          "title": "0x0: failed, 0x1: succeed"
         },
         "error": {
           "type": "string"

diff --git a/src/models/AnalyticServiceAnalyticServiceExecuteSQLBody.ts b/src/models/AnalyticServiceAnalyticServiceExecuteSQLBody.ts
@@ -13,18 +13,20 @@
  */
 
 import { mapValues } from '../runtime.js';
-import type { AnalyticServiceSQLQuery } from './AnalyticServiceSQLQuery.js';
-import {
-    AnalyticServiceSQLQueryFromJSON,
-    AnalyticServiceSQLQueryFromJSONTyped,
-    AnalyticServiceSQLQueryToJSON,
-} from './AnalyticServiceSQLQuery.js';
 import type { CommonCachePolicy } from './CommonCachePolicy.js';
 import {
     CommonCachePolicyFromJSON,
     CommonCachePolicyFromJSONTyped,
     CommonCachePolicyToJSON,
+    CommonCachePolicyToJSONTyped,
 } from './CommonCachePolicy.js';
+import type { AnalyticServiceSQLQuery } from './AnalyticServiceSQLQuery.js';
+import {
+    AnalyticServiceSQLQueryFromJSON,
+    AnalyticServiceSQLQueryFromJSONTyped,
+    AnalyticServiceSQLQueryToJSON,
+    AnalyticServiceSQLQueryToJSONTyped,
+} from './AnalyticServiceSQLQuery.js';
 
 /**
  * 
@@ -73,7 +75,7 @@ export interface AnalyticServiceAnalyticServiceExecuteSQLBody {
 /**
  * Check if a given object implements the AnalyticServiceAnalyticServiceExecuteSQLBody interface.
  */
-export function instanceOfAnalyticServiceAnalyticServiceExecuteSQLBody(value: object): boolean {
+export function instanceOfAnalyticServiceAnalyticServiceExecuteSQLBody(value: object): value is AnalyticServiceAnalyticServiceExecuteSQLBody {
     return true;
 }
 
@@ -96,10 +98,15 @@ export function AnalyticServiceAnalyticServiceExecuteSQLBodyFromJSONTyped(json:
     };
 }
 
-export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSON(value?: AnalyticServiceAnalyticServiceExecuteSQLBody | null): any {
+  export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSON(json: any): AnalyticServiceAnalyticServiceExecuteSQLBody {
+      return AnalyticServiceAnalyticServiceExecuteSQLBodyToJSONTyped(json, false);
+  }
+
+  export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSONTyped(value?: AnalyticServiceAnalyticServiceExecuteSQLBody | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'projectId': value['projectId'],

diff --git a/src/models/AnalyticServiceLogQueryRequestFilter.ts b/src/models/AnalyticServiceLogQueryRequestFilter.ts
@@ -42,7 +42,7 @@ export interface AnalyticServiceLogQueryRequestFilter {
 /**
  * Check if a given object implements the AnalyticServiceLogQueryRequestFilter interface.
  */
-export function instanceOfAnalyticServiceLogQueryRequestFilter(value: object): boolean {
+export function instanceOfAnalyticServiceLogQueryRequestFilter(value: object): value is AnalyticServiceLogQueryRequestFilter {
     return true;
 }
 
@@ -62,10 +62,15 @@ export function AnalyticServiceLogQueryRequestFilterFromJSONTyped(json: any, ign
     };
 }
 
-export function AnalyticServiceLogQueryRequestFilterToJSON(value?: AnalyticServiceLogQueryRequestFilter | null): any {
+  export function AnalyticServiceLogQueryRequestFilterToJSON(json: any): AnalyticServiceLogQueryRequestFilter {
+      return AnalyticServiceLogQueryRequestFilterToJSONTyped(json, false);
+  }
+
+  export function AnalyticServiceLogQueryRequestFilterToJSONTyped(value?: AnalyticServiceLogQueryRequestFilter | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'field': value['field'],

diff --git a/src/models/AnalyticServiceLogQueryRequestSort.ts b/src/models/AnalyticServiceLogQueryRequestSort.ts
@@ -36,7 +36,7 @@ export interface AnalyticServiceLogQueryRequestSort {
 /**
  * Check if a given object implements the AnalyticServiceLogQueryRequestSort interface.
  */
-export function instanceOfAnalyticServiceLogQueryRequestSort(value: object): boolean {
+export function instanceOfAnalyticServiceLogQueryRequestSort(value: object): value is AnalyticServiceLogQueryRequestSort {
     return true;
 }
 
@@ -55,10 +55,15 @@ export function AnalyticServiceLogQueryRequestSortFromJSONTyped(json: any, ignor
     };
 }
 
-export function AnalyticServiceLogQueryRequestSortToJSON(value?: AnalyticServiceLogQueryRequestSort | null): any {
+  export function AnalyticServiceLogQueryRequestSortToJSON(json: any): AnalyticServiceLogQueryRequestSort {
+      return AnalyticServiceLogQueryRequestSortToJSONTyped(json, false);
+  }
+
+  export function AnalyticServiceLogQueryRequestSortToJSONTyped(value?: AnalyticServiceLogQueryRequestSort | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'field': value['field'],

diff --git a/src/models/AnalyticServiceLogQueryResponse.ts b/src/models/AnalyticServiceLogQueryResponse.ts
@@ -18,12 +18,14 @@ import {
     CommonAnyFromJSON,
     CommonAnyFromJSONTyped,
     CommonAnyToJSON,
+    CommonAnyToJSONTyped,
 } from './CommonAny.js';
 import type { CommonEventLogEntry } from './CommonEventLogEntry.js';
 import {
     CommonEventLogEntryFromJSON,
     CommonEventLogEntryFromJSONTyped,
     CommonEventLogEntryToJSON,
+    CommonEventLogEntryToJSONTyped,
 } from './CommonEventLogEntry.js';
 
 /**
@@ -55,7 +57,7 @@ export interface AnalyticServiceLogQueryResponse {
 /**
  * Check if a given object implements the AnalyticServiceLogQueryResponse interface.
  */
-export function instanceOfAnalyticServiceLogQueryResponse(value: object): boolean {
+export function instanceOfAnalyticServiceLogQueryResponse(value: object): value is AnalyticServiceLogQueryResponse {
     return true;
 }
 
@@ -75,10 +77,15 @@ export function AnalyticServiceLogQueryResponseFromJSONTyped(json: any, ignoreDi
     };
 }
 
-export function AnalyticServiceLogQueryResponseToJSON(value?: AnalyticServiceLogQueryResponse | null): any {
+  export function AnalyticServiceLogQueryResponseToJSON(json: any): AnalyticServiceLogQueryResponse {
+      return AnalyticServiceLogQueryResponseToJSONTyped(json, false);
+  }
+
+  export function AnalyticServiceLogQueryResponseToJSONTyped(value?: AnalyticServiceLogQueryResponse | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'entries': value['entries'] == null ? undefined : ((value['entries'] as Array<any>).map(CommonEventLogEntryToJSON)),

diff --git a/src/models/AnalyticServiceSQLQuery.ts b/src/models/AnalyticServiceSQLQuery.ts
@@ -18,6 +18,7 @@ import {
     CommonRichStructFromJSON,
     CommonRichStructFromJSONTyped,
     CommonRichStructToJSON,
+    CommonRichStructToJSONTyped,
 } from './CommonRichStruct.js';
 
 /**
@@ -55,7 +56,7 @@ export interface AnalyticServiceSQLQuery {
 /**
  * Check if a given object implements the AnalyticServiceSQLQuery interface.
  */
-export function instanceOfAnalyticServiceSQLQuery(value: object): boolean {
+export function instanceOfAnalyticServiceSQLQuery(value: object): value is AnalyticServiceSQLQuery {
     return true;
 }
 
@@ -76,10 +77,15 @@ export function AnalyticServiceSQLQueryFromJSONTyped(json: any, ignoreDiscrimina
     };
 }
 
-export function AnalyticServiceSQLQueryToJSON(value?: AnalyticServiceSQLQuery | null): any {
+  export function AnalyticServiceSQLQueryToJSON(json: any): AnalyticServiceSQLQuery {
+      return AnalyticServiceSQLQueryToJSONTyped(json, false);
+  }
+
+  export function AnalyticServiceSQLQueryToJSONTyped(value?: AnalyticServiceSQLQuery | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
+
     return {
 
         'sql': value['sql'],