Skip to content

Commit 790ce34

Browse files
author
Sentio Bot
committed
chore: update
1 parent 4f38986 commit 790ce34

File tree

217 files changed

+2614
-894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

217 files changed

+2614
-894
lines changed

‎doc/index.html

Lines changed: 260 additions & 157 deletions
Large diffs are not rendered by default.

‎openapi.json

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1753,17 +1753,21 @@
17531753
"properties": {
17541754
"cacheTtlSecs": {
17551755
"type": "integer",
1756-
"format": "int32"
1756+
"format": "int32",
1757+
"title": "how long the cache will be stored before it is evicted"
17571758
},
17581759
"cacheRefreshTtlSecs": {
17591760
"type": "integer",
1760-
"format": "int32"
1761+
"format": "int32",
1762+
"title": "how long the cache will be refreshed in the background"
17611763
},
17621764
"forceRefresh": {
1763-
"type": "boolean"
1765+
"type": "boolean",
1766+
"title": "force refresh the cache now"
17641767
},
17651768
"noCache": {
1766-
"type": "boolean"
1769+
"type": "boolean",
1770+
"title": "do not use cache"
17671771
}
17681772
}
17691773
},
@@ -1812,7 +1816,8 @@
18121816
"pagerdutyConfig": {
18131817
"type": "object"
18141818
}
1815-
}
1819+
},
1820+
"title": "TODO, finish this"
18161821
},
18171822
"common.Channel.Type": {
18181823
"type": "string",
@@ -1929,7 +1934,8 @@
19291934
"type": "object",
19301935
"properties": {
19311936
"joinOperator": {
1932-
"$ref": "#/definitions/common.JoinOperator"
1937+
"$ref": "#/definitions/common.JoinOperator",
1938+
"title": "not support THEN"
19331939
},
19341940
"groups": {
19351941
"type": "array",
@@ -2157,7 +2163,8 @@
21572163
"type": "string"
21582164
},
21592165
"alias": {
2160-
"type": "string"
2166+
"type": "string",
2167+
"title": "bool enabled = 2;"
21612168
},
21622169
"id": {
21632170
"type": "string"
@@ -2390,7 +2397,8 @@
23902397
"format": "int64"
23912398
},
23922399
"slug": {
2393-
"type": "string"
2400+
"type": "string",
2401+
"title": "{ownerName}/{slug} is the unique name of the project"
23942402
},
23952403
"ownerId": {
23962404
"type": "string"
@@ -2587,13 +2595,16 @@
25872595
},
25882596
"properties": {
25892597
"query": {
2590-
"type": "string"
2598+
"type": "string",
2599+
"title": "the promql query or the metric name"
25912600
},
25922601
"alias": {
2593-
"type": "string"
2602+
"type": "string",
2603+
"title": "the alias of the query"
25942604
},
25952605
"id": {
2596-
"type": "string"
2606+
"type": "string",
2607+
"title": "the id of the query"
25972608
},
25982609
"labelSelector": {
25992610
"type": "object",
@@ -2612,7 +2623,8 @@
26122623
}
26132624
},
26142625
"disabled": {
2615-
"type": "boolean"
2626+
"type": "boolean",
2627+
"title": "hide the result, usually used for formula, default is false"
26162628
}
26172629
},
26182630
"description": "the query to fetch metrics data, promql",
@@ -2678,7 +2690,8 @@
26782690
"items": {
26792691
"type": "object",
26802692
"$ref": "#/definitions/common.RetentionQuery.Resource"
2681-
}
2693+
},
2694+
"title": "only support 2 resources"
26822695
},
26832696
"criteria": {
26842697
"$ref": "#/definitions/common.RetentionQuery.Criteria"
@@ -3015,7 +3028,8 @@
30153028
}
30163029
},
30173030
"operator": {
3018-
"$ref": "#/definitions/common.JoinOperator"
3031+
"$ref": "#/definitions/common.JoinOperator",
3032+
"title": "default is AND"
30193033
}
30203034
}
30213035
},
@@ -3035,7 +3049,8 @@
30353049
"$ref": "#/definitions/common.Any"
30363050
}
30373051
}
3038-
}
3052+
},
3053+
"title": "TODO maybe MetricQuery should use this as well"
30393054
},
30403055
"common.Selector.OperatorType": {
30413056
"type": "string",
@@ -3055,7 +3070,9 @@
30553070
"IN_COHORTS",
30563071
"NOT_IN_COHORTS"
30573072
],
3058-
"default": "EQ"
3073+
"default": "EQ",
3074+
"description": "- GT: Numeric operators\n - CONTAINS: String operators",
3075+
"title": "TODO add Date Value and List Value and its data type"
30593076
},
30603077
"common.SelectorExpr": {
30613078
"type": "object",
@@ -3066,7 +3083,8 @@
30663083
"logicExpr": {
30673084
"$ref": "#/definitions/common.SelectorExpr.LogicExpr"
30683085
}
3069-
}
3086+
},
3087+
"title": "TODO migrate segmentationQuery to use this"
30703088
},
30713089
"common.SelectorExpr.LogicExpr": {
30723090
"type": "object",
@@ -3079,7 +3097,8 @@
30793097
}
30803098
},
30813099
"operator": {
3082-
"$ref": "#/definitions/common.JoinOperator"
3100+
"$ref": "#/definitions/common.JoinOperator",
3101+
"title": "default is AND"
30833102
}
30843103
}
30853104
},
@@ -3090,7 +3109,8 @@
30903109
"type": "array",
30913110
"items": {
30923111
"type": "string"
3093-
}
3112+
},
3113+
"title": "JoinOperator operator = 2; // this field should implement in the future"
30943114
}
30953115
}
30963116
},
@@ -3160,7 +3180,8 @@
31603180
"format": "int64"
31613181
},
31623182
"interval": {
3163-
"$ref": "#/definitions/common.Duration"
3183+
"$ref": "#/definitions/common.Duration",
3184+
"title": "TODO remove step in favor of interval"
31643185
},
31653186
"timezone": {
31663187
"type": "string"
@@ -3211,7 +3232,8 @@
32113232
},
32123233
"step": {
32133234
"type": "integer",
3214-
"format": "int32"
3235+
"format": "int32",
3236+
"title": "interval in seconds between each data point"
32153237
},
32163238
"timezone": {
32173239
"type": "string"
@@ -3309,7 +3331,8 @@
33093331
"username": {
33103332
"type": "string"
33113333
}
3312-
}
3334+
},
3335+
"description": "The same to user but with sensitive data removed."
33133336
},
33143337
"evm.AccessListItem": {
33153338
"type": "object",
@@ -3395,7 +3418,8 @@
33953418
"type": "string"
33963419
},
33973420
"status": {
3398-
"type": "string"
3421+
"type": "string",
3422+
"title": "0x0: failed, 0x1: succeed"
33993423
},
34003424
"error": {
34013425
"type": "string"

‎src/models/AnalyticServiceAnalyticServiceExecuteSQLBody.ts

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,20 @@
1313
*/
1414

1515
import { mapValues } from '../runtime.js';
16-
import type { AnalyticServiceSQLQuery } from './AnalyticServiceSQLQuery.js';
17-
import {
18-
AnalyticServiceSQLQueryFromJSON,
19-
AnalyticServiceSQLQueryFromJSONTyped,
20-
AnalyticServiceSQLQueryToJSON,
21-
} from './AnalyticServiceSQLQuery.js';
2216
import type { CommonCachePolicy } from './CommonCachePolicy.js';
2317
import {
2418
CommonCachePolicyFromJSON,
2519
CommonCachePolicyFromJSONTyped,
2620
CommonCachePolicyToJSON,
21+
CommonCachePolicyToJSONTyped,
2722
} from './CommonCachePolicy.js';
23+
import type { AnalyticServiceSQLQuery } from './AnalyticServiceSQLQuery.js';
24+
import {
25+
AnalyticServiceSQLQueryFromJSON,
26+
AnalyticServiceSQLQueryFromJSONTyped,
27+
AnalyticServiceSQLQueryToJSON,
28+
AnalyticServiceSQLQueryToJSONTyped,
29+
} from './AnalyticServiceSQLQuery.js';
2830

2931
/**
3032
*
@@ -73,7 +75,7 @@ export interface AnalyticServiceAnalyticServiceExecuteSQLBody {
7375
/**
7476
* Check if a given object implements the AnalyticServiceAnalyticServiceExecuteSQLBody interface.
7577
*/
76-
export function instanceOfAnalyticServiceAnalyticServiceExecuteSQLBody(value: object): boolean {
78+
export function instanceOfAnalyticServiceAnalyticServiceExecuteSQLBody(value: object): value is AnalyticServiceAnalyticServiceExecuteSQLBody {
7779
return true;
7880
}
7981

@@ -96,10 +98,15 @@ export function AnalyticServiceAnalyticServiceExecuteSQLBodyFromJSONTyped(json:
9698
};
9799
}
98100

99-
export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSON(value?: AnalyticServiceAnalyticServiceExecuteSQLBody | null): any {
101+
export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSON(json: any): AnalyticServiceAnalyticServiceExecuteSQLBody {
102+
return AnalyticServiceAnalyticServiceExecuteSQLBodyToJSONTyped(json, false);
103+
}
104+
105+
export function AnalyticServiceAnalyticServiceExecuteSQLBodyToJSONTyped(value?: AnalyticServiceAnalyticServiceExecuteSQLBody | null, ignoreDiscriminator: boolean = false): any {
100106
if (value == null) {
101107
return value;
102108
}
109+
103110
return {
104111

105112
'projectId': value['projectId'],

‎src/models/AnalyticServiceLogQueryRequestFilter.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface AnalyticServiceLogQueryRequestFilter {
4242
/**
4343
* Check if a given object implements the AnalyticServiceLogQueryRequestFilter interface.
4444
*/
45-
export function instanceOfAnalyticServiceLogQueryRequestFilter(value: object): boolean {
45+
export function instanceOfAnalyticServiceLogQueryRequestFilter(value: object): value is AnalyticServiceLogQueryRequestFilter {
4646
return true;
4747
}
4848

@@ -62,10 +62,15 @@ export function AnalyticServiceLogQueryRequestFilterFromJSONTyped(json: any, ign
6262
};
6363
}
6464

65-
export function AnalyticServiceLogQueryRequestFilterToJSON(value?: AnalyticServiceLogQueryRequestFilter | null): any {
65+
export function AnalyticServiceLogQueryRequestFilterToJSON(json: any): AnalyticServiceLogQueryRequestFilter {
66+
return AnalyticServiceLogQueryRequestFilterToJSONTyped(json, false);
67+
}
68+
69+
export function AnalyticServiceLogQueryRequestFilterToJSONTyped(value?: AnalyticServiceLogQueryRequestFilter | null, ignoreDiscriminator: boolean = false): any {
6670
if (value == null) {
6771
return value;
6872
}
73+
6974
return {
7075

7176
'field': value['field'],

‎src/models/AnalyticServiceLogQueryRequestSort.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface AnalyticServiceLogQueryRequestSort {
3636
/**
3737
* Check if a given object implements the AnalyticServiceLogQueryRequestSort interface.
3838
*/
39-
export function instanceOfAnalyticServiceLogQueryRequestSort(value: object): boolean {
39+
export function instanceOfAnalyticServiceLogQueryRequestSort(value: object): value is AnalyticServiceLogQueryRequestSort {
4040
return true;
4141
}
4242

@@ -55,10 +55,15 @@ export function AnalyticServiceLogQueryRequestSortFromJSONTyped(json: any, ignor
5555
};
5656
}
5757

58-
export function AnalyticServiceLogQueryRequestSortToJSON(value?: AnalyticServiceLogQueryRequestSort | null): any {
58+
export function AnalyticServiceLogQueryRequestSortToJSON(json: any): AnalyticServiceLogQueryRequestSort {
59+
return AnalyticServiceLogQueryRequestSortToJSONTyped(json, false);
60+
}
61+
62+
export function AnalyticServiceLogQueryRequestSortToJSONTyped(value?: AnalyticServiceLogQueryRequestSort | null, ignoreDiscriminator: boolean = false): any {
5963
if (value == null) {
6064
return value;
6165
}
66+
6267
return {
6368

6469
'field': value['field'],

‎src/models/AnalyticServiceLogQueryResponse.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ import {
1818
CommonAnyFromJSON,
1919
CommonAnyFromJSONTyped,
2020
CommonAnyToJSON,
21+
CommonAnyToJSONTyped,
2122
} from './CommonAny.js';
2223
import type { CommonEventLogEntry } from './CommonEventLogEntry.js';
2324
import {
2425
CommonEventLogEntryFromJSON,
2526
CommonEventLogEntryFromJSONTyped,
2627
CommonEventLogEntryToJSON,
28+
CommonEventLogEntryToJSONTyped,
2729
} from './CommonEventLogEntry.js';
2830

2931
/**
@@ -55,7 +57,7 @@ export interface AnalyticServiceLogQueryResponse {
5557
/**
5658
* Check if a given object implements the AnalyticServiceLogQueryResponse interface.
5759
*/
58-
export function instanceOfAnalyticServiceLogQueryResponse(value: object): boolean {
60+
export function instanceOfAnalyticServiceLogQueryResponse(value: object): value is AnalyticServiceLogQueryResponse {
5961
return true;
6062
}
6163

@@ -75,10 +77,15 @@ export function AnalyticServiceLogQueryResponseFromJSONTyped(json: any, ignoreDi
7577
};
7678
}
7779

78-
export function AnalyticServiceLogQueryResponseToJSON(value?: AnalyticServiceLogQueryResponse | null): any {
80+
export function AnalyticServiceLogQueryResponseToJSON(json: any): AnalyticServiceLogQueryResponse {
81+
return AnalyticServiceLogQueryResponseToJSONTyped(json, false);
82+
}
83+
84+
export function AnalyticServiceLogQueryResponseToJSONTyped(value?: AnalyticServiceLogQueryResponse | null, ignoreDiscriminator: boolean = false): any {
7985
if (value == null) {
8086
return value;
8187
}
88+
8289
return {
8390

8491
'entries': value['entries'] == null ? undefined : ((value['entries'] as Array<any>).map(CommonEventLogEntryToJSON)),

‎src/models/AnalyticServiceSQLQuery.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import {
1818
CommonRichStructFromJSON,
1919
CommonRichStructFromJSONTyped,
2020
CommonRichStructToJSON,
21+
CommonRichStructToJSONTyped,
2122
} from './CommonRichStruct.js';
2223

2324
/**
@@ -55,7 +56,7 @@ export interface AnalyticServiceSQLQuery {
5556
/**
5657
* Check if a given object implements the AnalyticServiceSQLQuery interface.
5758
*/
58-
export function instanceOfAnalyticServiceSQLQuery(value: object): boolean {
59+
export function instanceOfAnalyticServiceSQLQuery(value: object): value is AnalyticServiceSQLQuery {
5960
return true;
6061
}
6162

@@ -76,10 +77,15 @@ export function AnalyticServiceSQLQueryFromJSONTyped(json: any, ignoreDiscrimina
7677
};
7778
}
7879

79-
export function AnalyticServiceSQLQueryToJSON(value?: AnalyticServiceSQLQuery | null): any {
80+
export function AnalyticServiceSQLQueryToJSON(json: any): AnalyticServiceSQLQuery {
81+
return AnalyticServiceSQLQueryToJSONTyped(json, false);
82+
}
83+
84+
export function AnalyticServiceSQLQueryToJSONTyped(value?: AnalyticServiceSQLQuery | null, ignoreDiscriminator: boolean = false): any {
8085
if (value == null) {
8186
return value;
8287
}
88+
8389
return {
8490

8591
'sql': value['sql'],

0 commit comments

Comments
 (0)