@leaflow/sdk 0.33.0 → 0.34.0
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.
- package/dist/support/v1/index.d.ts +0 -10
- package/dist/support/v1/schema.d.ts +4 -260
- package/package.json +1 -1
|
@@ -38,16 +38,6 @@ export type UploadAttachmentResult = operations["upload-attachment"]["responses"
|
|
|
38
38
|
export type UploadAttachmentQuery = operations["upload-attachment"]["parameters"]["query"];
|
|
39
39
|
/** `GET /api/v1/attachments/{attachmentId}/download-url` 成功时的响应体。 */
|
|
40
40
|
export type DescribeAttachmentDownloadResult = operations["describe-attachment-download"]["responses"][200]["content"]["application/json"];
|
|
41
|
-
/** `GET /api/v1/announcements` 成功时的响应体。 */
|
|
42
|
-
export type ListAnnouncementsResult = operations["list-announcements"]["responses"][200]["content"]["application/json"];
|
|
43
|
-
/** `GET /api/v1/announcements` 的查询参数。 */
|
|
44
|
-
export type ListAnnouncementsQuery = operations["list-announcements"]["parameters"]["query"];
|
|
45
|
-
/** `GET /api/v1/announcements/unread-count` 成功时的响应体。 */
|
|
46
|
-
export type CountUnreadAnnouncementsResult = operations["count-unread-announcements"]["responses"][200]["content"]["application/json"];
|
|
47
|
-
/** `GET /api/v1/announcements/{announcementId}` 成功时的响应体。 */
|
|
48
|
-
export type GetAnnouncementResult = operations["get-announcement"]["responses"][200]["content"]["application/json"];
|
|
49
|
-
/** `POST /api/v1/announcements/{announcementId}/read` 成功时的响应体。 */
|
|
50
|
-
export type MarkAnnouncementReadResult = operations["mark-announcement-read"]["responses"][200]["content"]["application/json"];
|
|
51
41
|
/** `GET /api/v1/maintenances` 成功时的响应体。 */
|
|
52
42
|
export type ListMaintenancesResult = operations["list-maintenances"]["responses"][200]["content"]["application/json"];
|
|
53
43
|
/** `GET /api/v1/maintenances` 的查询参数。 */
|
|
@@ -11,16 +11,15 @@ export interface paths {
|
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
13
|
/**
|
|
14
|
-
* List
|
|
15
|
-
* @description Returns the
|
|
16
|
-
* have not finished yet.
|
|
14
|
+
* List the maintenance in effect right now
|
|
15
|
+
* @description Returns the maintenance windows that have not finished yet.
|
|
17
16
|
*
|
|
18
17
|
* **This operation requires no credentials.** It is intended for sign-in pages and status
|
|
19
18
|
* pages, which are reached before a project has been selected. It returns a narrower shape
|
|
20
19
|
* than the authenticated operations and is not paginated.
|
|
21
20
|
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
21
|
+
* Platform announcements are not served here. They belong to the notification service, which
|
|
22
|
+
* owns announcements for the whole platform.
|
|
24
23
|
*/
|
|
25
24
|
get: operations["list-notices"];
|
|
26
25
|
put?: never;
|
|
@@ -226,90 +225,6 @@ export interface paths {
|
|
|
226
225
|
patch?: never;
|
|
227
226
|
trace?: never;
|
|
228
227
|
};
|
|
229
|
-
"/api/v1/announcements": {
|
|
230
|
-
parameters: {
|
|
231
|
-
query?: never;
|
|
232
|
-
header?: never;
|
|
233
|
-
path?: never;
|
|
234
|
-
cookie?: never;
|
|
235
|
-
};
|
|
236
|
-
/**
|
|
237
|
-
* List announcements
|
|
238
|
-
* @description Returns the announcements in effect for the current user, most recently published first.
|
|
239
|
-
* Announcements that are scheduled but not yet published, and those that have expired, are
|
|
240
|
-
* omitted.
|
|
241
|
-
*
|
|
242
|
-
* `read_at` is null when this user has not marked the announcement as read.
|
|
243
|
-
*/
|
|
244
|
-
get: operations["list-announcements"];
|
|
245
|
-
put?: never;
|
|
246
|
-
post?: never;
|
|
247
|
-
delete?: never;
|
|
248
|
-
options?: never;
|
|
249
|
-
head?: never;
|
|
250
|
-
patch?: never;
|
|
251
|
-
trace?: never;
|
|
252
|
-
};
|
|
253
|
-
"/api/v1/announcements/unread-count": {
|
|
254
|
-
parameters: {
|
|
255
|
-
query?: never;
|
|
256
|
-
header?: never;
|
|
257
|
-
path?: never;
|
|
258
|
-
cookie?: never;
|
|
259
|
-
};
|
|
260
|
-
/** Count the announcements this user has not read */
|
|
261
|
-
get: operations["count-unread-announcements"];
|
|
262
|
-
put?: never;
|
|
263
|
-
post?: never;
|
|
264
|
-
delete?: never;
|
|
265
|
-
options?: never;
|
|
266
|
-
head?: never;
|
|
267
|
-
patch?: never;
|
|
268
|
-
trace?: never;
|
|
269
|
-
};
|
|
270
|
-
"/api/v1/announcements/{announcementId}": {
|
|
271
|
-
parameters: {
|
|
272
|
-
query?: never;
|
|
273
|
-
header?: never;
|
|
274
|
-
path?: never;
|
|
275
|
-
cookie?: never;
|
|
276
|
-
};
|
|
277
|
-
/**
|
|
278
|
-
* Get an announcement
|
|
279
|
-
* @description Returns 404 for an announcement that is not in effect for this user.
|
|
280
|
-
*/
|
|
281
|
-
get: operations["get-announcement"];
|
|
282
|
-
put?: never;
|
|
283
|
-
post?: never;
|
|
284
|
-
delete?: never;
|
|
285
|
-
options?: never;
|
|
286
|
-
head?: never;
|
|
287
|
-
patch?: never;
|
|
288
|
-
trace?: never;
|
|
289
|
-
};
|
|
290
|
-
"/api/v1/announcements/{announcementId}/read": {
|
|
291
|
-
parameters: {
|
|
292
|
-
query?: never;
|
|
293
|
-
header?: never;
|
|
294
|
-
path?: never;
|
|
295
|
-
cookie?: never;
|
|
296
|
-
};
|
|
297
|
-
get?: never;
|
|
298
|
-
put?: never;
|
|
299
|
-
/**
|
|
300
|
-
* Mark an announcement as read
|
|
301
|
-
* @description Marking an announcement that is already marked succeeds and changes nothing; `read_at` keeps
|
|
302
|
-
* its original value.
|
|
303
|
-
*
|
|
304
|
-
* Read state is per person, not per project.
|
|
305
|
-
*/
|
|
306
|
-
post: operations["mark-announcement-read"];
|
|
307
|
-
delete?: never;
|
|
308
|
-
options?: never;
|
|
309
|
-
head?: never;
|
|
310
|
-
patch?: never;
|
|
311
|
-
trace?: never;
|
|
312
|
-
};
|
|
313
228
|
"/api/v1/maintenances": {
|
|
314
229
|
parameters: {
|
|
315
230
|
query?: never;
|
|
@@ -403,11 +318,6 @@ export interface components {
|
|
|
403
318
|
* @enum {string}
|
|
404
319
|
*/
|
|
405
320
|
TicketAuthorType: "USER" | "OPERATOR";
|
|
406
|
-
/**
|
|
407
|
-
* @description How prominently an announcement should be presented.
|
|
408
|
-
* @enum {string}
|
|
409
|
-
*/
|
|
410
|
-
AnnouncementSeverity: "INFO" | "WARNING" | "CRITICAL";
|
|
411
321
|
/**
|
|
412
322
|
* @description `SCHEDULED` has been announced but has not started. `IN_PROGRESS` is under way. `COMPLETED`
|
|
413
323
|
* has finished. `CANCELLED` was announced and then called off, and never took place.
|
|
@@ -490,22 +400,6 @@ export interface components {
|
|
|
490
400
|
/** Format: int64 */
|
|
491
401
|
score: number;
|
|
492
402
|
};
|
|
493
|
-
/** @description A platform announcement. */
|
|
494
|
-
AnnouncementResource: {
|
|
495
|
-
/** @description Markdown */
|
|
496
|
-
body: string;
|
|
497
|
-
/** Format: uuid */
|
|
498
|
-
id: string;
|
|
499
|
-
/** Format: date-time */
|
|
500
|
-
published_at: string;
|
|
501
|
-
/**
|
|
502
|
-
* Format: date-time
|
|
503
|
-
* @description When this user marked the announcement as read; null when they have not
|
|
504
|
-
*/
|
|
505
|
-
read_at: string | null;
|
|
506
|
-
severity: components["schemas"]["AnnouncementSeverity"];
|
|
507
|
-
title: string;
|
|
508
|
-
};
|
|
509
403
|
/** @description A scheduled maintenance notice published by platform operators. */
|
|
510
404
|
MaintenanceResource: {
|
|
511
405
|
/** @description Markdown */
|
|
@@ -557,19 +451,8 @@ export interface components {
|
|
|
557
451
|
* state.
|
|
558
452
|
*/
|
|
559
453
|
NoticeResource: {
|
|
560
|
-
announcements: components["schemas"]["NoticeAnnouncementResource"][];
|
|
561
454
|
maintenances: components["schemas"]["NoticeMaintenanceResource"][];
|
|
562
455
|
};
|
|
563
|
-
NoticeAnnouncementResource: {
|
|
564
|
-
/** @description Markdown */
|
|
565
|
-
body: string;
|
|
566
|
-
/** Format: uuid */
|
|
567
|
-
id: string;
|
|
568
|
-
/** Format: date-time */
|
|
569
|
-
published_at: string;
|
|
570
|
-
severity: components["schemas"]["AnnouncementSeverity"];
|
|
571
|
-
title: string;
|
|
572
|
-
};
|
|
573
456
|
NoticeMaintenanceResource: {
|
|
574
457
|
/** @description Markdown */
|
|
575
458
|
body: string;
|
|
@@ -595,10 +478,6 @@ export interface components {
|
|
|
595
478
|
/** @description A temporary address serving the file */
|
|
596
479
|
url: string;
|
|
597
480
|
};
|
|
598
|
-
UnreadCountResource: {
|
|
599
|
-
/** Format: int64 */
|
|
600
|
-
count: number;
|
|
601
|
-
};
|
|
602
481
|
CreateTicketRequestBody: {
|
|
603
482
|
/** @description Attachments to reference from the first message. Each must have been uploaded in this project and not yet referenced */
|
|
604
483
|
attachment_ids?: string[];
|
|
@@ -659,16 +538,6 @@ export interface components {
|
|
|
659
538
|
/** Format: int64 */
|
|
660
539
|
total: number;
|
|
661
540
|
};
|
|
662
|
-
LengthAwarePageAnnouncementResource: {
|
|
663
|
-
/** @description The contents of this page */
|
|
664
|
-
items: components["schemas"]["AnnouncementResource"][];
|
|
665
|
-
/** Format: int64 */
|
|
666
|
-
limit: number;
|
|
667
|
-
/** Format: int64 */
|
|
668
|
-
offset: number;
|
|
669
|
-
/** Format: int64 */
|
|
670
|
-
total: number;
|
|
671
|
-
};
|
|
672
541
|
LengthAwarePageMaintenanceResource: {
|
|
673
542
|
/** @description The contents of this page */
|
|
674
543
|
items: components["schemas"]["MaintenanceResource"][];
|
|
@@ -1102,131 +971,6 @@ export interface operations {
|
|
|
1102
971
|
};
|
|
1103
972
|
};
|
|
1104
973
|
};
|
|
1105
|
-
"list-announcements": {
|
|
1106
|
-
parameters: {
|
|
1107
|
-
query?: {
|
|
1108
|
-
/** @description Maximum number of items to return in this page */
|
|
1109
|
-
limit?: number;
|
|
1110
|
-
/** @description Number of items to skip */
|
|
1111
|
-
offset?: number;
|
|
1112
|
-
};
|
|
1113
|
-
header?: never;
|
|
1114
|
-
path?: never;
|
|
1115
|
-
cookie?: never;
|
|
1116
|
-
};
|
|
1117
|
-
requestBody?: never;
|
|
1118
|
-
responses: {
|
|
1119
|
-
/** @description OK */
|
|
1120
|
-
200: {
|
|
1121
|
-
headers: {
|
|
1122
|
-
[name: string]: unknown;
|
|
1123
|
-
};
|
|
1124
|
-
content: {
|
|
1125
|
-
"application/json": components["schemas"]["LengthAwarePageAnnouncementResource"];
|
|
1126
|
-
};
|
|
1127
|
-
};
|
|
1128
|
-
/** @description Error */
|
|
1129
|
-
default: {
|
|
1130
|
-
headers: {
|
|
1131
|
-
[name: string]: unknown;
|
|
1132
|
-
};
|
|
1133
|
-
content: {
|
|
1134
|
-
"application/json": components["schemas"]["Error"];
|
|
1135
|
-
};
|
|
1136
|
-
};
|
|
1137
|
-
};
|
|
1138
|
-
};
|
|
1139
|
-
"count-unread-announcements": {
|
|
1140
|
-
parameters: {
|
|
1141
|
-
query?: never;
|
|
1142
|
-
header?: never;
|
|
1143
|
-
path?: never;
|
|
1144
|
-
cookie?: never;
|
|
1145
|
-
};
|
|
1146
|
-
requestBody?: never;
|
|
1147
|
-
responses: {
|
|
1148
|
-
/** @description OK */
|
|
1149
|
-
200: {
|
|
1150
|
-
headers: {
|
|
1151
|
-
[name: string]: unknown;
|
|
1152
|
-
};
|
|
1153
|
-
content: {
|
|
1154
|
-
"application/json": components["schemas"]["UnreadCountResource"];
|
|
1155
|
-
};
|
|
1156
|
-
};
|
|
1157
|
-
/** @description Error */
|
|
1158
|
-
default: {
|
|
1159
|
-
headers: {
|
|
1160
|
-
[name: string]: unknown;
|
|
1161
|
-
};
|
|
1162
|
-
content: {
|
|
1163
|
-
"application/json": components["schemas"]["Error"];
|
|
1164
|
-
};
|
|
1165
|
-
};
|
|
1166
|
-
};
|
|
1167
|
-
};
|
|
1168
|
-
"get-announcement": {
|
|
1169
|
-
parameters: {
|
|
1170
|
-
query?: never;
|
|
1171
|
-
header?: never;
|
|
1172
|
-
path: {
|
|
1173
|
-
announcementId: string;
|
|
1174
|
-
};
|
|
1175
|
-
cookie?: never;
|
|
1176
|
-
};
|
|
1177
|
-
requestBody?: never;
|
|
1178
|
-
responses: {
|
|
1179
|
-
/** @description OK */
|
|
1180
|
-
200: {
|
|
1181
|
-
headers: {
|
|
1182
|
-
[name: string]: unknown;
|
|
1183
|
-
};
|
|
1184
|
-
content: {
|
|
1185
|
-
"application/json": components["schemas"]["AnnouncementResource"];
|
|
1186
|
-
};
|
|
1187
|
-
};
|
|
1188
|
-
/** @description Error */
|
|
1189
|
-
default: {
|
|
1190
|
-
headers: {
|
|
1191
|
-
[name: string]: unknown;
|
|
1192
|
-
};
|
|
1193
|
-
content: {
|
|
1194
|
-
"application/json": components["schemas"]["Error"];
|
|
1195
|
-
};
|
|
1196
|
-
};
|
|
1197
|
-
};
|
|
1198
|
-
};
|
|
1199
|
-
"mark-announcement-read": {
|
|
1200
|
-
parameters: {
|
|
1201
|
-
query?: never;
|
|
1202
|
-
header?: never;
|
|
1203
|
-
path: {
|
|
1204
|
-
announcementId: string;
|
|
1205
|
-
};
|
|
1206
|
-
cookie?: never;
|
|
1207
|
-
};
|
|
1208
|
-
requestBody?: never;
|
|
1209
|
-
responses: {
|
|
1210
|
-
/** @description OK */
|
|
1211
|
-
200: {
|
|
1212
|
-
headers: {
|
|
1213
|
-
[name: string]: unknown;
|
|
1214
|
-
};
|
|
1215
|
-
content: {
|
|
1216
|
-
"application/json": components["schemas"]["AnnouncementResource"];
|
|
1217
|
-
};
|
|
1218
|
-
};
|
|
1219
|
-
/** @description Error */
|
|
1220
|
-
default: {
|
|
1221
|
-
headers: {
|
|
1222
|
-
[name: string]: unknown;
|
|
1223
|
-
};
|
|
1224
|
-
content: {
|
|
1225
|
-
"application/json": components["schemas"]["Error"];
|
|
1226
|
-
};
|
|
1227
|
-
};
|
|
1228
|
-
};
|
|
1229
|
-
};
|
|
1230
974
|
"list-maintenances": {
|
|
1231
975
|
parameters: {
|
|
1232
976
|
query?: {
|