@argos-ci/api-client 0.22.1 → 0.24.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/index.d.mts +1286 -27
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -15,6 +15,10 @@ interface paths {
|
|
|
15
15
|
};
|
|
16
16
|
get?: never;
|
|
17
17
|
put?: never;
|
|
18
|
+
/**
|
|
19
|
+
* Create a build
|
|
20
|
+
* @description Create a build and receive signed upload targets for its screenshots and Playwright traces. The response lists, for every file Argos doesn't already have, a secure `postUrl` with `fields` (or a legacy `putUrl`) to upload it to. Supports single and parallel builds.
|
|
21
|
+
*/
|
|
18
22
|
post: operations["createBuild"];
|
|
19
23
|
delete?: never;
|
|
20
24
|
options?: never;
|
|
@@ -31,6 +35,10 @@ interface paths {
|
|
|
31
35
|
};
|
|
32
36
|
get?: never;
|
|
33
37
|
put?: never;
|
|
38
|
+
/**
|
|
39
|
+
* Create a deployment
|
|
40
|
+
* @description Create a deployment and receive signed upload URLs for the files Argos doesn't already store. Files already present (matched by content hash) are reused and omitted from `uploadFiles`. The environment is inferred from the branch when omitted.
|
|
41
|
+
*/
|
|
34
42
|
post: operations["createDeployment"];
|
|
35
43
|
delete?: never;
|
|
36
44
|
options?: never;
|
|
@@ -45,6 +53,10 @@ interface paths {
|
|
|
45
53
|
path?: never;
|
|
46
54
|
cookie?: never;
|
|
47
55
|
};
|
|
56
|
+
/**
|
|
57
|
+
* Get a deployment
|
|
58
|
+
* @description Retrieve a single deployment by its ID.
|
|
59
|
+
*/
|
|
48
60
|
get: operations["getDeployment"];
|
|
49
61
|
put?: never;
|
|
50
62
|
post?: never;
|
|
@@ -63,6 +75,10 @@ interface paths {
|
|
|
63
75
|
};
|
|
64
76
|
get?: never;
|
|
65
77
|
put?: never;
|
|
78
|
+
/**
|
|
79
|
+
* Finalize a deployment
|
|
80
|
+
* @description Mark a deployment as ready once all of its files have been uploaded. Argos assigns the deployment's aliases and starts serving it.
|
|
81
|
+
*/
|
|
66
82
|
post: operations["finalizeDeployment"];
|
|
67
83
|
delete?: never;
|
|
68
84
|
options?: never;
|
|
@@ -77,6 +93,10 @@ interface paths {
|
|
|
77
93
|
path?: never;
|
|
78
94
|
cookie?: never;
|
|
79
95
|
};
|
|
96
|
+
/**
|
|
97
|
+
* Resolve a deployment domain
|
|
98
|
+
* @description Resolve a deployment domain or URL to the deployment it currently serves. This endpoint is public and does not require authentication.
|
|
99
|
+
*/
|
|
80
100
|
get: operations["resolveDeploymentDomain"];
|
|
81
101
|
put?: never;
|
|
82
102
|
post?: never;
|
|
@@ -95,6 +115,10 @@ interface paths {
|
|
|
95
115
|
};
|
|
96
116
|
get?: never;
|
|
97
117
|
put?: never;
|
|
118
|
+
/**
|
|
119
|
+
* Finalize parallel builds
|
|
120
|
+
* @description Mark every parallel shard sharing the given `parallelNonce` as complete. Once finalized, Argos compares the aggregated screenshots and starts processing the build.
|
|
121
|
+
*/
|
|
98
122
|
post: operations["finalizeBuilds"];
|
|
99
123
|
delete?: never;
|
|
100
124
|
options?: never;
|
|
@@ -102,6 +126,26 @@ interface paths {
|
|
|
102
126
|
patch?: never;
|
|
103
127
|
trace?: never;
|
|
104
128
|
};
|
|
129
|
+
"/baseline": {
|
|
130
|
+
parameters: {
|
|
131
|
+
query?: never;
|
|
132
|
+
header?: never;
|
|
133
|
+
path?: never;
|
|
134
|
+
cookie?: never;
|
|
135
|
+
};
|
|
136
|
+
get?: never;
|
|
137
|
+
put?: never;
|
|
138
|
+
/**
|
|
139
|
+
* Find an eligible baseline from a list of commits
|
|
140
|
+
* @description Find the build eligible to be used as a baseline among a list of commits. Useful when no Git provider is connected: the CLI can send the candidate ancestor commits and let Argos pick the closest one that has an eligible (complete, valid, approved and not rejected) baseline build.
|
|
141
|
+
*/
|
|
142
|
+
post: operations["findBaseline"];
|
|
143
|
+
delete?: never;
|
|
144
|
+
options?: never;
|
|
145
|
+
head?: never;
|
|
146
|
+
patch?: never;
|
|
147
|
+
trace?: never;
|
|
148
|
+
};
|
|
105
149
|
"/auth/cli/token": {
|
|
106
150
|
parameters: {
|
|
107
151
|
query?: never;
|
|
@@ -112,7 +156,7 @@ interface paths {
|
|
|
112
156
|
get?: never;
|
|
113
157
|
put?: never;
|
|
114
158
|
/**
|
|
115
|
-
* Exchange CLI authorization code for a token
|
|
159
|
+
* Exchange a CLI authorization code for a token
|
|
116
160
|
* @description Called by the CLI to exchange a PKCE authorization code for an API token.
|
|
117
161
|
*/
|
|
118
162
|
post: operations["exchangeCliToken"];
|
|
@@ -162,6 +206,26 @@ interface paths {
|
|
|
162
206
|
patch?: never;
|
|
163
207
|
trace?: never;
|
|
164
208
|
};
|
|
209
|
+
"/me": {
|
|
210
|
+
parameters: {
|
|
211
|
+
query?: never;
|
|
212
|
+
header?: never;
|
|
213
|
+
path?: never;
|
|
214
|
+
cookie?: never;
|
|
215
|
+
};
|
|
216
|
+
/**
|
|
217
|
+
* Get the current user
|
|
218
|
+
* @description Retrieve the user associated with the personal access token used to authenticate the request.
|
|
219
|
+
*/
|
|
220
|
+
get: operations["getMe"];
|
|
221
|
+
put?: never;
|
|
222
|
+
post?: never;
|
|
223
|
+
delete?: never;
|
|
224
|
+
options?: never;
|
|
225
|
+
head?: never;
|
|
226
|
+
patch?: never;
|
|
227
|
+
trace?: never;
|
|
228
|
+
};
|
|
165
229
|
"/project": {
|
|
166
230
|
parameters: {
|
|
167
231
|
query?: never;
|
|
@@ -169,6 +233,10 @@ interface paths {
|
|
|
169
233
|
path?: never;
|
|
170
234
|
cookie?: never;
|
|
171
235
|
};
|
|
236
|
+
/**
|
|
237
|
+
* Get the current project
|
|
238
|
+
* @description Retrieve the project associated with the project token used to authenticate the request.
|
|
239
|
+
*/
|
|
172
240
|
get: operations["getAuthProject"];
|
|
173
241
|
put?: never;
|
|
174
242
|
post?: never;
|
|
@@ -186,6 +254,10 @@ interface paths {
|
|
|
186
254
|
cookie?: never;
|
|
187
255
|
};
|
|
188
256
|
get?: never;
|
|
257
|
+
/**
|
|
258
|
+
* Update a build
|
|
259
|
+
* @description Add screenshots to an existing build and update its metadata. Used to push the screenshots of a parallel shard, identified by `parallelIndex` and `parallelTotal`.
|
|
260
|
+
*/
|
|
189
261
|
put: operations["updateBuild"];
|
|
190
262
|
post?: never;
|
|
191
263
|
delete?: never;
|
|
@@ -201,6 +273,10 @@ interface paths {
|
|
|
201
273
|
path?: never;
|
|
202
274
|
cookie?: never;
|
|
203
275
|
};
|
|
276
|
+
/**
|
|
277
|
+
* Get a project
|
|
278
|
+
* @description Retrieve a project by its owner (account slug) and project name.
|
|
279
|
+
*/
|
|
204
280
|
get: operations["getProject"];
|
|
205
281
|
put?: never;
|
|
206
282
|
post?: never;
|
|
@@ -217,6 +293,10 @@ interface paths {
|
|
|
217
293
|
path?: never;
|
|
218
294
|
cookie?: never;
|
|
219
295
|
};
|
|
296
|
+
/**
|
|
297
|
+
* List a project's builds
|
|
298
|
+
* @description List the builds of a project, most recent first. Results are paginated. Use `distinctName` to return only the latest build per name and commit.
|
|
299
|
+
*/
|
|
220
300
|
get: operations["getProjectBuilds"];
|
|
221
301
|
put?: never;
|
|
222
302
|
post?: never;
|
|
@@ -233,6 +313,10 @@ interface paths {
|
|
|
233
313
|
path?: never;
|
|
234
314
|
cookie?: never;
|
|
235
315
|
};
|
|
316
|
+
/**
|
|
317
|
+
* Get a build
|
|
318
|
+
* @description Retrieve a single build by its number within a project, including its status and metadata.
|
|
319
|
+
*/
|
|
236
320
|
get: operations["getBuild"];
|
|
237
321
|
put?: never;
|
|
238
322
|
post?: never;
|
|
@@ -249,6 +333,10 @@ interface paths {
|
|
|
249
333
|
path?: never;
|
|
250
334
|
cookie?: never;
|
|
251
335
|
};
|
|
336
|
+
/**
|
|
337
|
+
* List a build's screenshot diffs
|
|
338
|
+
* @description List the screenshot diffs of a build, with pagination. Each diff compares a baseline screenshot to the one captured by the build. Use `onlyChanged` to return only the diffs that require review.
|
|
339
|
+
*/
|
|
252
340
|
get: operations["getBuildDiffs"];
|
|
253
341
|
put?: never;
|
|
254
342
|
post?: never;
|
|
@@ -265,8 +353,16 @@ interface paths {
|
|
|
265
353
|
path?: never;
|
|
266
354
|
cookie?: never;
|
|
267
355
|
};
|
|
268
|
-
|
|
269
|
-
|
|
356
|
+
/**
|
|
357
|
+
* List the reviews submitted on a build
|
|
358
|
+
* @description List the reviews submitted on a build, with pagination.
|
|
359
|
+
*/
|
|
360
|
+
get: operations["listReviews"];
|
|
361
|
+
put?: never;
|
|
362
|
+
/**
|
|
363
|
+
* Create a review on a build
|
|
364
|
+
* @description Submit a review on a build to approve or reject the changes it captured.
|
|
365
|
+
*/
|
|
270
366
|
post: operations["createReview"];
|
|
271
367
|
delete?: never;
|
|
272
368
|
options?: never;
|
|
@@ -274,6 +370,166 @@ interface paths {
|
|
|
274
370
|
patch?: never;
|
|
275
371
|
trace?: never;
|
|
276
372
|
};
|
|
373
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/reviews/{reviewId}/dismiss": {
|
|
374
|
+
parameters: {
|
|
375
|
+
query?: never;
|
|
376
|
+
header?: never;
|
|
377
|
+
path?: never;
|
|
378
|
+
cookie?: never;
|
|
379
|
+
};
|
|
380
|
+
get?: never;
|
|
381
|
+
put?: never;
|
|
382
|
+
/**
|
|
383
|
+
* Dismiss a submitted review on a build
|
|
384
|
+
* @description Dismiss a previously submitted review on a build, clearing its effect on the build's review status.
|
|
385
|
+
*/
|
|
386
|
+
post: operations["dismissReview"];
|
|
387
|
+
delete?: never;
|
|
388
|
+
options?: never;
|
|
389
|
+
head?: never;
|
|
390
|
+
patch?: never;
|
|
391
|
+
trace?: never;
|
|
392
|
+
};
|
|
393
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments": {
|
|
394
|
+
parameters: {
|
|
395
|
+
query?: never;
|
|
396
|
+
header?: never;
|
|
397
|
+
path?: never;
|
|
398
|
+
cookie?: never;
|
|
399
|
+
};
|
|
400
|
+
/**
|
|
401
|
+
* List the comments on a build
|
|
402
|
+
* @description List the comments on a build, with pagination.
|
|
403
|
+
*/
|
|
404
|
+
get: operations["listComments"];
|
|
405
|
+
put?: never;
|
|
406
|
+
/**
|
|
407
|
+
* Post a comment (or reply) on a build
|
|
408
|
+
* @description Post a comment on a build. Start a new thread, reply to an existing one with `threadId`, optionally anchor the comment to a screenshot diff, or attach it to your pending review with `addToReview`.
|
|
409
|
+
*/
|
|
410
|
+
post: operations["createComment"];
|
|
411
|
+
delete?: never;
|
|
412
|
+
options?: never;
|
|
413
|
+
head?: never;
|
|
414
|
+
patch?: never;
|
|
415
|
+
trace?: never;
|
|
416
|
+
};
|
|
417
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}": {
|
|
418
|
+
parameters: {
|
|
419
|
+
query?: never;
|
|
420
|
+
header?: never;
|
|
421
|
+
path?: never;
|
|
422
|
+
cookie?: never;
|
|
423
|
+
};
|
|
424
|
+
/**
|
|
425
|
+
* Get a single comment on a build
|
|
426
|
+
* @description Retrieve a single comment on a build by its ID.
|
|
427
|
+
*/
|
|
428
|
+
get: operations["getComment"];
|
|
429
|
+
put?: never;
|
|
430
|
+
post?: never;
|
|
431
|
+
/**
|
|
432
|
+
* Delete a comment on a build
|
|
433
|
+
* @description Delete a comment on a build. Only the comment's author can delete it.
|
|
434
|
+
*/
|
|
435
|
+
delete: operations["deleteComment"];
|
|
436
|
+
options?: never;
|
|
437
|
+
head?: never;
|
|
438
|
+
/**
|
|
439
|
+
* Update a comment on a build
|
|
440
|
+
* @description Update the body of a comment on a build. Only the comment's author can edit it.
|
|
441
|
+
*/
|
|
442
|
+
patch: operations["updateComment"];
|
|
443
|
+
trace?: never;
|
|
444
|
+
};
|
|
445
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions": {
|
|
446
|
+
parameters: {
|
|
447
|
+
query?: never;
|
|
448
|
+
header?: never;
|
|
449
|
+
path?: never;
|
|
450
|
+
cookie?: never;
|
|
451
|
+
};
|
|
452
|
+
get?: never;
|
|
453
|
+
put?: never;
|
|
454
|
+
/**
|
|
455
|
+
* Add an emoji reaction to a comment
|
|
456
|
+
* @description Add an emoji reaction to a comment on behalf of the authenticated user.
|
|
457
|
+
*/
|
|
458
|
+
post: operations["addCommentReaction"];
|
|
459
|
+
/**
|
|
460
|
+
* Remove an emoji reaction from a comment
|
|
461
|
+
* @description Remove an emoji reaction previously added by the authenticated user from a comment.
|
|
462
|
+
*/
|
|
463
|
+
delete: operations["removeCommentReaction"];
|
|
464
|
+
options?: never;
|
|
465
|
+
head?: never;
|
|
466
|
+
patch?: never;
|
|
467
|
+
trace?: never;
|
|
468
|
+
};
|
|
469
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/resolve": {
|
|
470
|
+
parameters: {
|
|
471
|
+
query?: never;
|
|
472
|
+
header?: never;
|
|
473
|
+
path?: never;
|
|
474
|
+
cookie?: never;
|
|
475
|
+
};
|
|
476
|
+
get?: never;
|
|
477
|
+
put?: never;
|
|
478
|
+
/**
|
|
479
|
+
* Mark a comment thread as resolved
|
|
480
|
+
* @description Mark a comment thread as resolved.
|
|
481
|
+
*/
|
|
482
|
+
post: operations["resolveCommentThread"];
|
|
483
|
+
delete?: never;
|
|
484
|
+
options?: never;
|
|
485
|
+
head?: never;
|
|
486
|
+
patch?: never;
|
|
487
|
+
trace?: never;
|
|
488
|
+
};
|
|
489
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/unresolve": {
|
|
490
|
+
parameters: {
|
|
491
|
+
query?: never;
|
|
492
|
+
header?: never;
|
|
493
|
+
path?: never;
|
|
494
|
+
cookie?: never;
|
|
495
|
+
};
|
|
496
|
+
get?: never;
|
|
497
|
+
put?: never;
|
|
498
|
+
/**
|
|
499
|
+
* Reopen a resolved comment thread
|
|
500
|
+
* @description Reopen a previously resolved comment thread.
|
|
501
|
+
*/
|
|
502
|
+
post: operations["unresolveCommentThread"];
|
|
503
|
+
delete?: never;
|
|
504
|
+
options?: never;
|
|
505
|
+
head?: never;
|
|
506
|
+
patch?: never;
|
|
507
|
+
trace?: never;
|
|
508
|
+
};
|
|
509
|
+
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/subscription": {
|
|
510
|
+
parameters: {
|
|
511
|
+
query?: never;
|
|
512
|
+
header?: never;
|
|
513
|
+
path?: never;
|
|
514
|
+
cookie?: never;
|
|
515
|
+
};
|
|
516
|
+
get?: never;
|
|
517
|
+
put?: never;
|
|
518
|
+
/**
|
|
519
|
+
* Subscribe to a comment thread's notifications
|
|
520
|
+
* @description Subscribe the authenticated user to a comment thread to receive notifications about new replies.
|
|
521
|
+
*/
|
|
522
|
+
post: operations["subscribeCommentThread"];
|
|
523
|
+
/**
|
|
524
|
+
* Unsubscribe from a comment thread's notifications
|
|
525
|
+
* @description Unsubscribe the authenticated user from a comment thread's notifications.
|
|
526
|
+
*/
|
|
527
|
+
delete: operations["unsubscribeCommentThread"];
|
|
528
|
+
options?: never;
|
|
529
|
+
head?: never;
|
|
530
|
+
patch?: never;
|
|
531
|
+
trace?: never;
|
|
532
|
+
};
|
|
277
533
|
}
|
|
278
534
|
type webhooks = Record<string, never>;
|
|
279
535
|
interface components {
|
|
@@ -430,6 +686,11 @@ interface components {
|
|
|
430
686
|
details?: {
|
|
431
687
|
message: string;
|
|
432
688
|
}[];
|
|
689
|
+
}; /** @description A user. */
|
|
690
|
+
User: {
|
|
691
|
+
id: string;
|
|
692
|
+
slug: string;
|
|
693
|
+
name: string | null;
|
|
433
694
|
}; /** @description Project */
|
|
434
695
|
Project: {
|
|
435
696
|
id: string;
|
|
@@ -597,6 +858,46 @@ interface components {
|
|
|
597
858
|
url: string; /** @description Content type of the snapshot file */
|
|
598
859
|
contentType: string;
|
|
599
860
|
} | null;
|
|
861
|
+
}; /** @description Build review */
|
|
862
|
+
BuildReview: {
|
|
863
|
+
id: string;
|
|
864
|
+
buildId: string;
|
|
865
|
+
/**
|
|
866
|
+
* @description State of a build review: approved, rejected, commented (neutral) or pending (an unsubmitted draft).
|
|
867
|
+
* @enum {string}
|
|
868
|
+
*/
|
|
869
|
+
state: "approved" | "rejected" | "commented" | "pending"; /** @description The user who submitted the review. */
|
|
870
|
+
user: components["schemas"]["User"] | null; /** @description Date the review was dismissed, null if not dismissed. */
|
|
871
|
+
dismissedAt: string | null; /** @description The user who dismissed the review, if any. */
|
|
872
|
+
dismissedBy: components["schemas"]["User"] | null; /** @description Date the review was created. */
|
|
873
|
+
date: string;
|
|
874
|
+
}; /** @description A comment posted on a build. */
|
|
875
|
+
Comment: {
|
|
876
|
+
id: string;
|
|
877
|
+
buildId: string; /** @description Root comment ID when this comment is a reply. */
|
|
878
|
+
threadId: string | null; /** @description Rich-text JSON content of the comment. */
|
|
879
|
+
body: unknown; /** @description Plain-text rendering of the comment content. */
|
|
880
|
+
text: string;
|
|
881
|
+
author: components["schemas"]["User"] | null; /** @description Screenshot diff this comment is anchored to, if any. */
|
|
882
|
+
screenshotDiffId: string | null; /** @description Where the comment points on its screenshot diff. Null means the whole diff. */
|
|
883
|
+
anchor: ({
|
|
884
|
+
/** @constant */type: "point";
|
|
885
|
+
x: number;
|
|
886
|
+
y: number;
|
|
887
|
+
} | {
|
|
888
|
+
/** @constant */type: "lines";
|
|
889
|
+
from: number;
|
|
890
|
+
to: number;
|
|
891
|
+
}) | null; /** @description Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author. */
|
|
892
|
+
pending: boolean; /** @description Date the thread was resolved, null if not resolved. Only set on a root comment. */
|
|
893
|
+
resolvedAt: string | null; /** @description Date the comment was last edited, null if never edited. */
|
|
894
|
+
editedAt: string | null; /** @description Date the comment was posted. */
|
|
895
|
+
createdAt: string;
|
|
896
|
+
reactions: {
|
|
897
|
+
/** @description The emoji used for the reaction. */emoji: string; /** @description Number of users who reacted with this emoji. */
|
|
898
|
+
count: number; /** @description The users who reacted with this emoji. */
|
|
899
|
+
users: components["schemas"]["User"][];
|
|
900
|
+
}[];
|
|
600
901
|
};
|
|
601
902
|
/**
|
|
602
903
|
* @description The build number
|
|
@@ -1050,6 +1351,68 @@ interface operations {
|
|
|
1050
1351
|
};
|
|
1051
1352
|
};
|
|
1052
1353
|
};
|
|
1354
|
+
findBaseline: {
|
|
1355
|
+
parameters: {
|
|
1356
|
+
query?: never;
|
|
1357
|
+
header?: never;
|
|
1358
|
+
path?: never;
|
|
1359
|
+
cookie?: never;
|
|
1360
|
+
};
|
|
1361
|
+
requestBody?: {
|
|
1362
|
+
content: {
|
|
1363
|
+
"application/json": {
|
|
1364
|
+
/** @description The commits to look for an eligible baseline, ordered from the closest to the furthest ancestor. The first commit with an eligible baseline wins. */commits: components["schemas"]["Sha1Hash"][];
|
|
1365
|
+
/**
|
|
1366
|
+
* @description The name of the build to find a baseline for.
|
|
1367
|
+
* @default default
|
|
1368
|
+
*/
|
|
1369
|
+
name?: string;
|
|
1370
|
+
/**
|
|
1371
|
+
* @description The mode of the build to find a baseline for.
|
|
1372
|
+
* @default ci
|
|
1373
|
+
* @enum {string}
|
|
1374
|
+
*/
|
|
1375
|
+
mode?: "ci" | "monitoring";
|
|
1376
|
+
};
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
responses: {
|
|
1380
|
+
/** @description The eligible baseline build, or null when none is found */200: {
|
|
1381
|
+
headers: {
|
|
1382
|
+
[name: string]: unknown;
|
|
1383
|
+
};
|
|
1384
|
+
content: {
|
|
1385
|
+
"application/json": {
|
|
1386
|
+
/** @description The eligible baseline build found among the commits, or null when none is found. */baseline: components["schemas"]["Build"] | null;
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
}; /** @description Invalid parameters */
|
|
1390
|
+
400: {
|
|
1391
|
+
headers: {
|
|
1392
|
+
[name: string]: unknown;
|
|
1393
|
+
};
|
|
1394
|
+
content: {
|
|
1395
|
+
"application/json": components["schemas"]["Error"];
|
|
1396
|
+
};
|
|
1397
|
+
}; /** @description Unauthorized */
|
|
1398
|
+
401: {
|
|
1399
|
+
headers: {
|
|
1400
|
+
[name: string]: unknown;
|
|
1401
|
+
};
|
|
1402
|
+
content: {
|
|
1403
|
+
"application/json": components["schemas"]["Error"];
|
|
1404
|
+
};
|
|
1405
|
+
}; /** @description Server error */
|
|
1406
|
+
500: {
|
|
1407
|
+
headers: {
|
|
1408
|
+
[name: string]: unknown;
|
|
1409
|
+
};
|
|
1410
|
+
content: {
|
|
1411
|
+
"application/json": components["schemas"]["Error"];
|
|
1412
|
+
};
|
|
1413
|
+
};
|
|
1414
|
+
};
|
|
1415
|
+
};
|
|
1053
1416
|
exchangeCliToken: {
|
|
1054
1417
|
parameters: {
|
|
1055
1418
|
query?: never;
|
|
@@ -1114,9 +1477,7 @@ interface operations {
|
|
|
1114
1477
|
"application/json": {
|
|
1115
1478
|
/** @description GitHub Actions OIDC token */oidcToken: string; /** @description GitHub repository in owner/name format */
|
|
1116
1479
|
repository?: string; /** @description Expected commit SHA */
|
|
1117
|
-
commit?: components["schemas"]["Sha1Hash"];
|
|
1118
|
-
branch?: string; /** @description Expected pull request number */
|
|
1119
|
-
pullRequestNumber?: number;
|
|
1480
|
+
commit?: components["schemas"]["Sha1Hash"];
|
|
1120
1481
|
};
|
|
1121
1482
|
};
|
|
1122
1483
|
};
|
|
@@ -1244,7 +1605,7 @@ interface operations {
|
|
|
1244
1605
|
};
|
|
1245
1606
|
};
|
|
1246
1607
|
};
|
|
1247
|
-
|
|
1608
|
+
getMe: {
|
|
1248
1609
|
parameters: {
|
|
1249
1610
|
query?: never;
|
|
1250
1611
|
header?: never;
|
|
@@ -1253,12 +1614,12 @@ interface operations {
|
|
|
1253
1614
|
};
|
|
1254
1615
|
requestBody?: never;
|
|
1255
1616
|
responses: {
|
|
1256
|
-
/** @description
|
|
1617
|
+
/** @description The authenticated user */200: {
|
|
1257
1618
|
headers: {
|
|
1258
1619
|
[name: string]: unknown;
|
|
1259
1620
|
};
|
|
1260
1621
|
content: {
|
|
1261
|
-
"application/json": components["schemas"]["
|
|
1622
|
+
"application/json": components["schemas"]["User"];
|
|
1262
1623
|
};
|
|
1263
1624
|
}; /** @description Unauthorized */
|
|
1264
1625
|
401: {
|
|
@@ -1279,24 +1640,60 @@ interface operations {
|
|
|
1279
1640
|
};
|
|
1280
1641
|
};
|
|
1281
1642
|
};
|
|
1282
|
-
|
|
1643
|
+
getAuthProject: {
|
|
1283
1644
|
parameters: {
|
|
1284
1645
|
query?: never;
|
|
1285
1646
|
header?: never;
|
|
1286
|
-
path
|
|
1287
|
-
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
1288
|
-
};
|
|
1647
|
+
path?: never;
|
|
1289
1648
|
cookie?: never;
|
|
1290
1649
|
};
|
|
1291
|
-
requestBody?:
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
};
|
|
1650
|
+
requestBody?: never;
|
|
1651
|
+
responses: {
|
|
1652
|
+
/** @description Project */200: {
|
|
1653
|
+
headers: {
|
|
1654
|
+
[name: string]: unknown;
|
|
1655
|
+
};
|
|
1656
|
+
content: {
|
|
1657
|
+
"application/json": components["schemas"]["Project"];
|
|
1658
|
+
};
|
|
1659
|
+
}; /** @description Unauthorized */
|
|
1660
|
+
401: {
|
|
1661
|
+
headers: {
|
|
1662
|
+
[name: string]: unknown;
|
|
1663
|
+
};
|
|
1664
|
+
content: {
|
|
1665
|
+
"application/json": components["schemas"]["Error"];
|
|
1666
|
+
};
|
|
1667
|
+
}; /** @description Server error */
|
|
1668
|
+
500: {
|
|
1669
|
+
headers: {
|
|
1670
|
+
[name: string]: unknown;
|
|
1671
|
+
};
|
|
1672
|
+
content: {
|
|
1673
|
+
"application/json": components["schemas"]["Error"];
|
|
1674
|
+
};
|
|
1675
|
+
};
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
updateBuild: {
|
|
1679
|
+
parameters: {
|
|
1680
|
+
query?: never;
|
|
1681
|
+
header?: never;
|
|
1682
|
+
path: {
|
|
1683
|
+
/** @description A unique identifier for the build */buildId: components["schemas"]["BuildId"];
|
|
1684
|
+
};
|
|
1685
|
+
cookie?: never;
|
|
1686
|
+
};
|
|
1687
|
+
requestBody?: {
|
|
1688
|
+
content: {
|
|
1689
|
+
"application/json": {
|
|
1690
|
+
screenshots: components["schemas"]["ScreenshotInput"][];
|
|
1691
|
+
parallel?: boolean | null;
|
|
1692
|
+
parallelTotal?: number | null;
|
|
1693
|
+
parallelIndex?: number | null; /** @description Only used for non-parallel builds. Indicates that this is the last request of the build, so Argos can finalize it. A build whose screenshots are too large to fit in a single request can split them across several sequential requests, leaving `final` falsy on every request but the last. Defaults to `true`. */
|
|
1694
|
+
final?: boolean | null;
|
|
1695
|
+
metadata?: components["schemas"]["BuildMetadata"];
|
|
1696
|
+
};
|
|
1300
1697
|
};
|
|
1301
1698
|
};
|
|
1302
1699
|
responses: {
|
|
@@ -1610,6 +2007,69 @@ interface operations {
|
|
|
1610
2007
|
};
|
|
1611
2008
|
};
|
|
1612
2009
|
};
|
|
2010
|
+
listReviews: {
|
|
2011
|
+
parameters: {
|
|
2012
|
+
query?: never;
|
|
2013
|
+
header?: never;
|
|
2014
|
+
path: {
|
|
2015
|
+
owner: string;
|
|
2016
|
+
project: string; /** @description The build number */
|
|
2017
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2018
|
+
};
|
|
2019
|
+
cookie?: never;
|
|
2020
|
+
};
|
|
2021
|
+
requestBody?: never;
|
|
2022
|
+
responses: {
|
|
2023
|
+
/** @description Build reviews */200: {
|
|
2024
|
+
headers: {
|
|
2025
|
+
[name: string]: unknown;
|
|
2026
|
+
};
|
|
2027
|
+
content: {
|
|
2028
|
+
"application/json": components["schemas"]["BuildReview"][];
|
|
2029
|
+
};
|
|
2030
|
+
}; /** @description Invalid parameters */
|
|
2031
|
+
400: {
|
|
2032
|
+
headers: {
|
|
2033
|
+
[name: string]: unknown;
|
|
2034
|
+
};
|
|
2035
|
+
content: {
|
|
2036
|
+
"application/json": components["schemas"]["Error"];
|
|
2037
|
+
};
|
|
2038
|
+
}; /** @description Unauthorized */
|
|
2039
|
+
401: {
|
|
2040
|
+
headers: {
|
|
2041
|
+
[name: string]: unknown;
|
|
2042
|
+
};
|
|
2043
|
+
content: {
|
|
2044
|
+
"application/json": components["schemas"]["Error"];
|
|
2045
|
+
};
|
|
2046
|
+
}; /** @description Forbidden */
|
|
2047
|
+
403: {
|
|
2048
|
+
headers: {
|
|
2049
|
+
[name: string]: unknown;
|
|
2050
|
+
};
|
|
2051
|
+
content: {
|
|
2052
|
+
"application/json": components["schemas"]["Error"];
|
|
2053
|
+
};
|
|
2054
|
+
}; /** @description Not found */
|
|
2055
|
+
404: {
|
|
2056
|
+
headers: {
|
|
2057
|
+
[name: string]: unknown;
|
|
2058
|
+
};
|
|
2059
|
+
content: {
|
|
2060
|
+
"application/json": components["schemas"]["Error"];
|
|
2061
|
+
};
|
|
2062
|
+
}; /** @description Server error */
|
|
2063
|
+
500: {
|
|
2064
|
+
headers: {
|
|
2065
|
+
[name: string]: unknown;
|
|
2066
|
+
};
|
|
2067
|
+
content: {
|
|
2068
|
+
"application/json": components["schemas"]["Error"];
|
|
2069
|
+
};
|
|
2070
|
+
};
|
|
2071
|
+
};
|
|
2072
|
+
};
|
|
1613
2073
|
createReview: {
|
|
1614
2074
|
parameters: {
|
|
1615
2075
|
query?: never;
|
|
@@ -1634,7 +2094,7 @@ interface operations {
|
|
|
1634
2094
|
* @description Deprecated: use `event` instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".
|
|
1635
2095
|
* @enum {string}
|
|
1636
2096
|
*/
|
|
1637
|
-
conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review.
|
|
2097
|
+
conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document. */
|
|
1638
2098
|
body?: unknown;
|
|
1639
2099
|
/**
|
|
1640
2100
|
* @description Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.
|
|
@@ -1657,10 +2117,809 @@ interface operations {
|
|
|
1657
2117
|
[name: string]: unknown;
|
|
1658
2118
|
};
|
|
1659
2119
|
content: {
|
|
1660
|
-
"application/json":
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
2120
|
+
"application/json": components["schemas"]["BuildReview"];
|
|
2121
|
+
};
|
|
2122
|
+
}; /** @description Invalid parameters */
|
|
2123
|
+
400: {
|
|
2124
|
+
headers: {
|
|
2125
|
+
[name: string]: unknown;
|
|
2126
|
+
};
|
|
2127
|
+
content: {
|
|
2128
|
+
"application/json": components["schemas"]["Error"];
|
|
2129
|
+
};
|
|
2130
|
+
}; /** @description Unauthorized */
|
|
2131
|
+
401: {
|
|
2132
|
+
headers: {
|
|
2133
|
+
[name: string]: unknown;
|
|
2134
|
+
};
|
|
2135
|
+
content: {
|
|
2136
|
+
"application/json": components["schemas"]["Error"];
|
|
2137
|
+
};
|
|
2138
|
+
}; /** @description Forbidden */
|
|
2139
|
+
403: {
|
|
2140
|
+
headers: {
|
|
2141
|
+
[name: string]: unknown;
|
|
2142
|
+
};
|
|
2143
|
+
content: {
|
|
2144
|
+
"application/json": components["schemas"]["Error"];
|
|
2145
|
+
};
|
|
2146
|
+
}; /** @description Not found */
|
|
2147
|
+
404: {
|
|
2148
|
+
headers: {
|
|
2149
|
+
[name: string]: unknown;
|
|
2150
|
+
};
|
|
2151
|
+
content: {
|
|
2152
|
+
"application/json": components["schemas"]["Error"];
|
|
2153
|
+
};
|
|
2154
|
+
}; /** @description Server error */
|
|
2155
|
+
500: {
|
|
2156
|
+
headers: {
|
|
2157
|
+
[name: string]: unknown;
|
|
2158
|
+
};
|
|
2159
|
+
content: {
|
|
2160
|
+
"application/json": components["schemas"]["Error"];
|
|
2161
|
+
};
|
|
2162
|
+
};
|
|
2163
|
+
};
|
|
2164
|
+
};
|
|
2165
|
+
dismissReview: {
|
|
2166
|
+
parameters: {
|
|
2167
|
+
query?: never;
|
|
2168
|
+
header?: never;
|
|
2169
|
+
path: {
|
|
2170
|
+
owner: string;
|
|
2171
|
+
project: string; /** @description The build number */
|
|
2172
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the review */
|
|
2173
|
+
reviewId: string;
|
|
2174
|
+
};
|
|
2175
|
+
cookie?: never;
|
|
2176
|
+
};
|
|
2177
|
+
requestBody?: never;
|
|
2178
|
+
responses: {
|
|
2179
|
+
/** @description Review dismissed successfully — returns the review */200: {
|
|
2180
|
+
headers: {
|
|
2181
|
+
[name: string]: unknown;
|
|
2182
|
+
};
|
|
2183
|
+
content: {
|
|
2184
|
+
"application/json": components["schemas"]["BuildReview"];
|
|
2185
|
+
};
|
|
2186
|
+
}; /** @description Invalid parameters */
|
|
2187
|
+
400: {
|
|
2188
|
+
headers: {
|
|
2189
|
+
[name: string]: unknown;
|
|
2190
|
+
};
|
|
2191
|
+
content: {
|
|
2192
|
+
"application/json": components["schemas"]["Error"];
|
|
2193
|
+
};
|
|
2194
|
+
}; /** @description Unauthorized */
|
|
2195
|
+
401: {
|
|
2196
|
+
headers: {
|
|
2197
|
+
[name: string]: unknown;
|
|
2198
|
+
};
|
|
2199
|
+
content: {
|
|
2200
|
+
"application/json": components["schemas"]["Error"];
|
|
2201
|
+
};
|
|
2202
|
+
}; /** @description Forbidden */
|
|
2203
|
+
403: {
|
|
2204
|
+
headers: {
|
|
2205
|
+
[name: string]: unknown;
|
|
2206
|
+
};
|
|
2207
|
+
content: {
|
|
2208
|
+
"application/json": components["schemas"]["Error"];
|
|
2209
|
+
};
|
|
2210
|
+
}; /** @description Not found */
|
|
2211
|
+
404: {
|
|
2212
|
+
headers: {
|
|
2213
|
+
[name: string]: unknown;
|
|
2214
|
+
};
|
|
2215
|
+
content: {
|
|
2216
|
+
"application/json": components["schemas"]["Error"];
|
|
2217
|
+
};
|
|
2218
|
+
}; /** @description Server error */
|
|
2219
|
+
500: {
|
|
2220
|
+
headers: {
|
|
2221
|
+
[name: string]: unknown;
|
|
2222
|
+
};
|
|
2223
|
+
content: {
|
|
2224
|
+
"application/json": components["schemas"]["Error"];
|
|
2225
|
+
};
|
|
2226
|
+
};
|
|
2227
|
+
};
|
|
2228
|
+
};
|
|
2229
|
+
listComments: {
|
|
2230
|
+
parameters: {
|
|
2231
|
+
query?: never;
|
|
2232
|
+
header?: never;
|
|
2233
|
+
path: {
|
|
2234
|
+
owner: string;
|
|
2235
|
+
project: string; /** @description The build number */
|
|
2236
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2237
|
+
};
|
|
2238
|
+
cookie?: never;
|
|
2239
|
+
};
|
|
2240
|
+
requestBody?: never;
|
|
2241
|
+
responses: {
|
|
2242
|
+
/** @description Build comments, oldest first. Replies carry a threadId pointing at their root comment. */200: {
|
|
2243
|
+
headers: {
|
|
2244
|
+
[name: string]: unknown;
|
|
2245
|
+
};
|
|
2246
|
+
content: {
|
|
2247
|
+
"application/json": components["schemas"]["Comment"][];
|
|
2248
|
+
};
|
|
2249
|
+
}; /** @description Invalid parameters */
|
|
2250
|
+
400: {
|
|
2251
|
+
headers: {
|
|
2252
|
+
[name: string]: unknown;
|
|
2253
|
+
};
|
|
2254
|
+
content: {
|
|
2255
|
+
"application/json": components["schemas"]["Error"];
|
|
2256
|
+
};
|
|
2257
|
+
}; /** @description Unauthorized */
|
|
2258
|
+
401: {
|
|
2259
|
+
headers: {
|
|
2260
|
+
[name: string]: unknown;
|
|
2261
|
+
};
|
|
2262
|
+
content: {
|
|
2263
|
+
"application/json": components["schemas"]["Error"];
|
|
2264
|
+
};
|
|
2265
|
+
}; /** @description Forbidden */
|
|
2266
|
+
403: {
|
|
2267
|
+
headers: {
|
|
2268
|
+
[name: string]: unknown;
|
|
2269
|
+
};
|
|
2270
|
+
content: {
|
|
2271
|
+
"application/json": components["schemas"]["Error"];
|
|
2272
|
+
};
|
|
2273
|
+
}; /** @description Not found */
|
|
2274
|
+
404: {
|
|
2275
|
+
headers: {
|
|
2276
|
+
[name: string]: unknown;
|
|
2277
|
+
};
|
|
2278
|
+
content: {
|
|
2279
|
+
"application/json": components["schemas"]["Error"];
|
|
2280
|
+
};
|
|
2281
|
+
}; /** @description Server error */
|
|
2282
|
+
500: {
|
|
2283
|
+
headers: {
|
|
2284
|
+
[name: string]: unknown;
|
|
2285
|
+
};
|
|
2286
|
+
content: {
|
|
2287
|
+
"application/json": components["schemas"]["Error"];
|
|
2288
|
+
};
|
|
2289
|
+
};
|
|
2290
|
+
};
|
|
2291
|
+
};
|
|
2292
|
+
createComment: {
|
|
2293
|
+
parameters: {
|
|
2294
|
+
query?: never;
|
|
2295
|
+
header?: never;
|
|
2296
|
+
path: {
|
|
2297
|
+
owner: string;
|
|
2298
|
+
project: string; /** @description The build number */
|
|
2299
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2300
|
+
};
|
|
2301
|
+
cookie?: never;
|
|
2302
|
+
};
|
|
2303
|
+
requestBody: {
|
|
2304
|
+
content: {
|
|
2305
|
+
"application/json": {
|
|
2306
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
2307
|
+
[key: string]: unknown;
|
|
2308
|
+
}; /** @description Root comment ID to reply to. */
|
|
2309
|
+
threadId?: string; /** @description Screenshot diff to anchor the comment to. Required when anchor is set. */
|
|
2310
|
+
screenshotDiffId?: string; /** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0–1) coordinates; lines is a 1-based inclusive range. */
|
|
2311
|
+
anchor?: {
|
|
2312
|
+
/** @constant */type: "point";
|
|
2313
|
+
x: number;
|
|
2314
|
+
y: number;
|
|
2315
|
+
} | {
|
|
2316
|
+
/** @constant */type: "lines";
|
|
2317
|
+
from: number;
|
|
2318
|
+
to: number;
|
|
2319
|
+
}; /** @description Attach the comment to your pending review (created if needed) instead of posting it immediately. Ignored for replies, which inherit their thread's review. */
|
|
2320
|
+
addToReview?: boolean;
|
|
2321
|
+
};
|
|
2322
|
+
};
|
|
2323
|
+
};
|
|
2324
|
+
responses: {
|
|
2325
|
+
/** @description Comment created successfully — returns the comment */201: {
|
|
2326
|
+
headers: {
|
|
2327
|
+
[name: string]: unknown;
|
|
2328
|
+
};
|
|
2329
|
+
content: {
|
|
2330
|
+
"application/json": components["schemas"]["Comment"];
|
|
2331
|
+
};
|
|
2332
|
+
}; /** @description Invalid parameters */
|
|
2333
|
+
400: {
|
|
2334
|
+
headers: {
|
|
2335
|
+
[name: string]: unknown;
|
|
2336
|
+
};
|
|
2337
|
+
content: {
|
|
2338
|
+
"application/json": components["schemas"]["Error"];
|
|
2339
|
+
};
|
|
2340
|
+
}; /** @description Unauthorized */
|
|
2341
|
+
401: {
|
|
2342
|
+
headers: {
|
|
2343
|
+
[name: string]: unknown;
|
|
2344
|
+
};
|
|
2345
|
+
content: {
|
|
2346
|
+
"application/json": components["schemas"]["Error"];
|
|
2347
|
+
};
|
|
2348
|
+
}; /** @description Forbidden */
|
|
2349
|
+
403: {
|
|
2350
|
+
headers: {
|
|
2351
|
+
[name: string]: unknown;
|
|
2352
|
+
};
|
|
2353
|
+
content: {
|
|
2354
|
+
"application/json": components["schemas"]["Error"];
|
|
2355
|
+
};
|
|
2356
|
+
}; /** @description Not found */
|
|
2357
|
+
404: {
|
|
2358
|
+
headers: {
|
|
2359
|
+
[name: string]: unknown;
|
|
2360
|
+
};
|
|
2361
|
+
content: {
|
|
2362
|
+
"application/json": components["schemas"]["Error"];
|
|
2363
|
+
};
|
|
2364
|
+
}; /** @description Server error */
|
|
2365
|
+
500: {
|
|
2366
|
+
headers: {
|
|
2367
|
+
[name: string]: unknown;
|
|
2368
|
+
};
|
|
2369
|
+
content: {
|
|
2370
|
+
"application/json": components["schemas"]["Error"];
|
|
2371
|
+
};
|
|
2372
|
+
};
|
|
2373
|
+
};
|
|
2374
|
+
};
|
|
2375
|
+
getComment: {
|
|
2376
|
+
parameters: {
|
|
2377
|
+
query?: never;
|
|
2378
|
+
header?: never;
|
|
2379
|
+
path: {
|
|
2380
|
+
owner: string;
|
|
2381
|
+
project: string; /** @description The build number */
|
|
2382
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
2383
|
+
commentId: string;
|
|
2384
|
+
};
|
|
2385
|
+
cookie?: never;
|
|
2386
|
+
};
|
|
2387
|
+
requestBody?: never;
|
|
2388
|
+
responses: {
|
|
2389
|
+
/** @description Comment */200: {
|
|
2390
|
+
headers: {
|
|
2391
|
+
[name: string]: unknown;
|
|
2392
|
+
};
|
|
2393
|
+
content: {
|
|
2394
|
+
"application/json": components["schemas"]["Comment"];
|
|
2395
|
+
};
|
|
2396
|
+
}; /** @description Invalid parameters */
|
|
2397
|
+
400: {
|
|
2398
|
+
headers: {
|
|
2399
|
+
[name: string]: unknown;
|
|
2400
|
+
};
|
|
2401
|
+
content: {
|
|
2402
|
+
"application/json": components["schemas"]["Error"];
|
|
2403
|
+
};
|
|
2404
|
+
}; /** @description Unauthorized */
|
|
2405
|
+
401: {
|
|
2406
|
+
headers: {
|
|
2407
|
+
[name: string]: unknown;
|
|
2408
|
+
};
|
|
2409
|
+
content: {
|
|
2410
|
+
"application/json": components["schemas"]["Error"];
|
|
2411
|
+
};
|
|
2412
|
+
}; /** @description Forbidden */
|
|
2413
|
+
403: {
|
|
2414
|
+
headers: {
|
|
2415
|
+
[name: string]: unknown;
|
|
2416
|
+
};
|
|
2417
|
+
content: {
|
|
2418
|
+
"application/json": components["schemas"]["Error"];
|
|
2419
|
+
};
|
|
2420
|
+
}; /** @description Not found */
|
|
2421
|
+
404: {
|
|
2422
|
+
headers: {
|
|
2423
|
+
[name: string]: unknown;
|
|
2424
|
+
};
|
|
2425
|
+
content: {
|
|
2426
|
+
"application/json": components["schemas"]["Error"];
|
|
2427
|
+
};
|
|
2428
|
+
}; /** @description Server error */
|
|
2429
|
+
500: {
|
|
2430
|
+
headers: {
|
|
2431
|
+
[name: string]: unknown;
|
|
2432
|
+
};
|
|
2433
|
+
content: {
|
|
2434
|
+
"application/json": components["schemas"]["Error"];
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
};
|
|
2439
|
+
deleteComment: {
|
|
2440
|
+
parameters: {
|
|
2441
|
+
query?: never;
|
|
2442
|
+
header?: never;
|
|
2443
|
+
path: {
|
|
2444
|
+
owner: string;
|
|
2445
|
+
project: string; /** @description The build number */
|
|
2446
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
2447
|
+
commentId: string;
|
|
2448
|
+
};
|
|
2449
|
+
cookie?: never;
|
|
2450
|
+
};
|
|
2451
|
+
requestBody?: never;
|
|
2452
|
+
responses: {
|
|
2453
|
+
/** @description Comment deleted successfully — returns the comment */200: {
|
|
2454
|
+
headers: {
|
|
2455
|
+
[name: string]: unknown;
|
|
2456
|
+
};
|
|
2457
|
+
content: {
|
|
2458
|
+
"application/json": components["schemas"]["Comment"];
|
|
2459
|
+
};
|
|
2460
|
+
}; /** @description Invalid parameters */
|
|
2461
|
+
400: {
|
|
2462
|
+
headers: {
|
|
2463
|
+
[name: string]: unknown;
|
|
2464
|
+
};
|
|
2465
|
+
content: {
|
|
2466
|
+
"application/json": components["schemas"]["Error"];
|
|
2467
|
+
};
|
|
2468
|
+
}; /** @description Unauthorized */
|
|
2469
|
+
401: {
|
|
2470
|
+
headers: {
|
|
2471
|
+
[name: string]: unknown;
|
|
2472
|
+
};
|
|
2473
|
+
content: {
|
|
2474
|
+
"application/json": components["schemas"]["Error"];
|
|
2475
|
+
};
|
|
2476
|
+
}; /** @description Forbidden */
|
|
2477
|
+
403: {
|
|
2478
|
+
headers: {
|
|
2479
|
+
[name: string]: unknown;
|
|
2480
|
+
};
|
|
2481
|
+
content: {
|
|
2482
|
+
"application/json": components["schemas"]["Error"];
|
|
2483
|
+
};
|
|
2484
|
+
}; /** @description Not found */
|
|
2485
|
+
404: {
|
|
2486
|
+
headers: {
|
|
2487
|
+
[name: string]: unknown;
|
|
2488
|
+
};
|
|
2489
|
+
content: {
|
|
2490
|
+
"application/json": components["schemas"]["Error"];
|
|
2491
|
+
};
|
|
2492
|
+
}; /** @description Server error */
|
|
2493
|
+
500: {
|
|
2494
|
+
headers: {
|
|
2495
|
+
[name: string]: unknown;
|
|
2496
|
+
};
|
|
2497
|
+
content: {
|
|
2498
|
+
"application/json": components["schemas"]["Error"];
|
|
2499
|
+
};
|
|
2500
|
+
};
|
|
2501
|
+
};
|
|
2502
|
+
};
|
|
2503
|
+
updateComment: {
|
|
2504
|
+
parameters: {
|
|
2505
|
+
query?: never;
|
|
2506
|
+
header?: never;
|
|
2507
|
+
path: {
|
|
2508
|
+
owner: string;
|
|
2509
|
+
project: string; /** @description The build number */
|
|
2510
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
2511
|
+
commentId: string;
|
|
2512
|
+
};
|
|
2513
|
+
cookie?: never;
|
|
2514
|
+
};
|
|
2515
|
+
requestBody: {
|
|
2516
|
+
content: {
|
|
2517
|
+
"application/json": {
|
|
2518
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
2519
|
+
[key: string]: unknown;
|
|
2520
|
+
};
|
|
2521
|
+
};
|
|
2522
|
+
};
|
|
2523
|
+
};
|
|
2524
|
+
responses: {
|
|
2525
|
+
/** @description Comment updated successfully — returns the comment */200: {
|
|
2526
|
+
headers: {
|
|
2527
|
+
[name: string]: unknown;
|
|
2528
|
+
};
|
|
2529
|
+
content: {
|
|
2530
|
+
"application/json": components["schemas"]["Comment"];
|
|
2531
|
+
};
|
|
2532
|
+
}; /** @description Invalid parameters */
|
|
2533
|
+
400: {
|
|
2534
|
+
headers: {
|
|
2535
|
+
[name: string]: unknown;
|
|
2536
|
+
};
|
|
2537
|
+
content: {
|
|
2538
|
+
"application/json": components["schemas"]["Error"];
|
|
2539
|
+
};
|
|
2540
|
+
}; /** @description Unauthorized */
|
|
2541
|
+
401: {
|
|
2542
|
+
headers: {
|
|
2543
|
+
[name: string]: unknown;
|
|
2544
|
+
};
|
|
2545
|
+
content: {
|
|
2546
|
+
"application/json": components["schemas"]["Error"];
|
|
2547
|
+
};
|
|
2548
|
+
}; /** @description Forbidden */
|
|
2549
|
+
403: {
|
|
2550
|
+
headers: {
|
|
2551
|
+
[name: string]: unknown;
|
|
2552
|
+
};
|
|
2553
|
+
content: {
|
|
2554
|
+
"application/json": components["schemas"]["Error"];
|
|
2555
|
+
};
|
|
2556
|
+
}; /** @description Not found */
|
|
2557
|
+
404: {
|
|
2558
|
+
headers: {
|
|
2559
|
+
[name: string]: unknown;
|
|
2560
|
+
};
|
|
2561
|
+
content: {
|
|
2562
|
+
"application/json": components["schemas"]["Error"];
|
|
2563
|
+
};
|
|
2564
|
+
}; /** @description Server error */
|
|
2565
|
+
500: {
|
|
2566
|
+
headers: {
|
|
2567
|
+
[name: string]: unknown;
|
|
2568
|
+
};
|
|
2569
|
+
content: {
|
|
2570
|
+
"application/json": components["schemas"]["Error"];
|
|
2571
|
+
};
|
|
2572
|
+
};
|
|
2573
|
+
};
|
|
2574
|
+
};
|
|
2575
|
+
addCommentReaction: {
|
|
2576
|
+
parameters: {
|
|
2577
|
+
query?: never;
|
|
2578
|
+
header?: never;
|
|
2579
|
+
path: {
|
|
2580
|
+
owner: string;
|
|
2581
|
+
project: string; /** @description The build number */
|
|
2582
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
2583
|
+
commentId: string;
|
|
2584
|
+
};
|
|
2585
|
+
cookie?: never;
|
|
2586
|
+
};
|
|
2587
|
+
requestBody: {
|
|
2588
|
+
content: {
|
|
2589
|
+
"application/json": {
|
|
2590
|
+
/** @description The emoji to react with. */emoji: string;
|
|
2591
|
+
};
|
|
2592
|
+
};
|
|
2593
|
+
};
|
|
2594
|
+
responses: {
|
|
2595
|
+
/** @description Reaction added — returns the comment */200: {
|
|
2596
|
+
headers: {
|
|
2597
|
+
[name: string]: unknown;
|
|
2598
|
+
};
|
|
2599
|
+
content: {
|
|
2600
|
+
"application/json": components["schemas"]["Comment"];
|
|
2601
|
+
};
|
|
2602
|
+
}; /** @description Invalid parameters */
|
|
2603
|
+
400: {
|
|
2604
|
+
headers: {
|
|
2605
|
+
[name: string]: unknown;
|
|
2606
|
+
};
|
|
2607
|
+
content: {
|
|
2608
|
+
"application/json": components["schemas"]["Error"];
|
|
2609
|
+
};
|
|
2610
|
+
}; /** @description Unauthorized */
|
|
2611
|
+
401: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
"application/json": components["schemas"]["Error"];
|
|
2617
|
+
};
|
|
2618
|
+
}; /** @description Forbidden */
|
|
2619
|
+
403: {
|
|
2620
|
+
headers: {
|
|
2621
|
+
[name: string]: unknown;
|
|
2622
|
+
};
|
|
2623
|
+
content: {
|
|
2624
|
+
"application/json": components["schemas"]["Error"];
|
|
2625
|
+
};
|
|
2626
|
+
}; /** @description Not found */
|
|
2627
|
+
404: {
|
|
2628
|
+
headers: {
|
|
2629
|
+
[name: string]: unknown;
|
|
2630
|
+
};
|
|
2631
|
+
content: {
|
|
2632
|
+
"application/json": components["schemas"]["Error"];
|
|
2633
|
+
};
|
|
2634
|
+
}; /** @description Server error */
|
|
2635
|
+
500: {
|
|
2636
|
+
headers: {
|
|
2637
|
+
[name: string]: unknown;
|
|
2638
|
+
};
|
|
2639
|
+
content: {
|
|
2640
|
+
"application/json": components["schemas"]["Error"];
|
|
2641
|
+
};
|
|
2642
|
+
};
|
|
2643
|
+
};
|
|
2644
|
+
};
|
|
2645
|
+
removeCommentReaction: {
|
|
2646
|
+
parameters: {
|
|
2647
|
+
query: {
|
|
2648
|
+
/** @description The emoji reaction to remove. */emoji: string;
|
|
2649
|
+
};
|
|
2650
|
+
header?: never;
|
|
2651
|
+
path: {
|
|
2652
|
+
owner: string;
|
|
2653
|
+
project: string; /** @description The build number */
|
|
2654
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
2655
|
+
commentId: string;
|
|
2656
|
+
};
|
|
2657
|
+
cookie?: never;
|
|
2658
|
+
};
|
|
2659
|
+
requestBody?: never;
|
|
2660
|
+
responses: {
|
|
2661
|
+
/** @description Reaction removed — returns the comment */200: {
|
|
2662
|
+
headers: {
|
|
2663
|
+
[name: string]: unknown;
|
|
2664
|
+
};
|
|
2665
|
+
content: {
|
|
2666
|
+
"application/json": components["schemas"]["Comment"];
|
|
2667
|
+
};
|
|
2668
|
+
}; /** @description Invalid parameters */
|
|
2669
|
+
400: {
|
|
2670
|
+
headers: {
|
|
2671
|
+
[name: string]: unknown;
|
|
2672
|
+
};
|
|
2673
|
+
content: {
|
|
2674
|
+
"application/json": components["schemas"]["Error"];
|
|
2675
|
+
};
|
|
2676
|
+
}; /** @description Unauthorized */
|
|
2677
|
+
401: {
|
|
2678
|
+
headers: {
|
|
2679
|
+
[name: string]: unknown;
|
|
2680
|
+
};
|
|
2681
|
+
content: {
|
|
2682
|
+
"application/json": components["schemas"]["Error"];
|
|
2683
|
+
};
|
|
2684
|
+
}; /** @description Forbidden */
|
|
2685
|
+
403: {
|
|
2686
|
+
headers: {
|
|
2687
|
+
[name: string]: unknown;
|
|
2688
|
+
};
|
|
2689
|
+
content: {
|
|
2690
|
+
"application/json": components["schemas"]["Error"];
|
|
2691
|
+
};
|
|
2692
|
+
}; /** @description Not found */
|
|
2693
|
+
404: {
|
|
2694
|
+
headers: {
|
|
2695
|
+
[name: string]: unknown;
|
|
2696
|
+
};
|
|
2697
|
+
content: {
|
|
2698
|
+
"application/json": components["schemas"]["Error"];
|
|
2699
|
+
};
|
|
2700
|
+
}; /** @description Server error */
|
|
2701
|
+
500: {
|
|
2702
|
+
headers: {
|
|
2703
|
+
[name: string]: unknown;
|
|
2704
|
+
};
|
|
2705
|
+
content: {
|
|
2706
|
+
"application/json": components["schemas"]["Error"];
|
|
2707
|
+
};
|
|
2708
|
+
};
|
|
2709
|
+
};
|
|
2710
|
+
};
|
|
2711
|
+
resolveCommentThread: {
|
|
2712
|
+
parameters: {
|
|
2713
|
+
query?: never;
|
|
2714
|
+
header?: never;
|
|
2715
|
+
path: {
|
|
2716
|
+
owner: string;
|
|
2717
|
+
project: string; /** @description The build number */
|
|
2718
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
2719
|
+
commentId: string;
|
|
2720
|
+
};
|
|
2721
|
+
cookie?: never;
|
|
2722
|
+
};
|
|
2723
|
+
requestBody?: never;
|
|
2724
|
+
responses: {
|
|
2725
|
+
/** @description Thread resolved — returns the root comment */200: {
|
|
2726
|
+
headers: {
|
|
2727
|
+
[name: string]: unknown;
|
|
2728
|
+
};
|
|
2729
|
+
content: {
|
|
2730
|
+
"application/json": components["schemas"]["Comment"];
|
|
2731
|
+
};
|
|
2732
|
+
}; /** @description Invalid parameters */
|
|
2733
|
+
400: {
|
|
2734
|
+
headers: {
|
|
2735
|
+
[name: string]: unknown;
|
|
2736
|
+
};
|
|
2737
|
+
content: {
|
|
2738
|
+
"application/json": components["schemas"]["Error"];
|
|
2739
|
+
};
|
|
2740
|
+
}; /** @description Unauthorized */
|
|
2741
|
+
401: {
|
|
2742
|
+
headers: {
|
|
2743
|
+
[name: string]: unknown;
|
|
2744
|
+
};
|
|
2745
|
+
content: {
|
|
2746
|
+
"application/json": components["schemas"]["Error"];
|
|
2747
|
+
};
|
|
2748
|
+
}; /** @description Forbidden */
|
|
2749
|
+
403: {
|
|
2750
|
+
headers: {
|
|
2751
|
+
[name: string]: unknown;
|
|
2752
|
+
};
|
|
2753
|
+
content: {
|
|
2754
|
+
"application/json": components["schemas"]["Error"];
|
|
2755
|
+
};
|
|
2756
|
+
}; /** @description Not found */
|
|
2757
|
+
404: {
|
|
2758
|
+
headers: {
|
|
2759
|
+
[name: string]: unknown;
|
|
2760
|
+
};
|
|
2761
|
+
content: {
|
|
2762
|
+
"application/json": components["schemas"]["Error"];
|
|
2763
|
+
};
|
|
2764
|
+
}; /** @description Server error */
|
|
2765
|
+
500: {
|
|
2766
|
+
headers: {
|
|
2767
|
+
[name: string]: unknown;
|
|
2768
|
+
};
|
|
2769
|
+
content: {
|
|
2770
|
+
"application/json": components["schemas"]["Error"];
|
|
2771
|
+
};
|
|
2772
|
+
};
|
|
2773
|
+
};
|
|
2774
|
+
};
|
|
2775
|
+
unresolveCommentThread: {
|
|
2776
|
+
parameters: {
|
|
2777
|
+
query?: never;
|
|
2778
|
+
header?: never;
|
|
2779
|
+
path: {
|
|
2780
|
+
owner: string;
|
|
2781
|
+
project: string; /** @description The build number */
|
|
2782
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
2783
|
+
commentId: string;
|
|
2784
|
+
};
|
|
2785
|
+
cookie?: never;
|
|
2786
|
+
};
|
|
2787
|
+
requestBody?: never;
|
|
2788
|
+
responses: {
|
|
2789
|
+
/** @description Thread reopened — returns the root comment */200: {
|
|
2790
|
+
headers: {
|
|
2791
|
+
[name: string]: unknown;
|
|
2792
|
+
};
|
|
2793
|
+
content: {
|
|
2794
|
+
"application/json": components["schemas"]["Comment"];
|
|
2795
|
+
};
|
|
2796
|
+
}; /** @description Invalid parameters */
|
|
2797
|
+
400: {
|
|
2798
|
+
headers: {
|
|
2799
|
+
[name: string]: unknown;
|
|
2800
|
+
};
|
|
2801
|
+
content: {
|
|
2802
|
+
"application/json": components["schemas"]["Error"];
|
|
2803
|
+
};
|
|
2804
|
+
}; /** @description Unauthorized */
|
|
2805
|
+
401: {
|
|
2806
|
+
headers: {
|
|
2807
|
+
[name: string]: unknown;
|
|
2808
|
+
};
|
|
2809
|
+
content: {
|
|
2810
|
+
"application/json": components["schemas"]["Error"];
|
|
2811
|
+
};
|
|
2812
|
+
}; /** @description Forbidden */
|
|
2813
|
+
403: {
|
|
2814
|
+
headers: {
|
|
2815
|
+
[name: string]: unknown;
|
|
2816
|
+
};
|
|
2817
|
+
content: {
|
|
2818
|
+
"application/json": components["schemas"]["Error"];
|
|
2819
|
+
};
|
|
2820
|
+
}; /** @description Not found */
|
|
2821
|
+
404: {
|
|
2822
|
+
headers: {
|
|
2823
|
+
[name: string]: unknown;
|
|
2824
|
+
};
|
|
2825
|
+
content: {
|
|
2826
|
+
"application/json": components["schemas"]["Error"];
|
|
2827
|
+
};
|
|
2828
|
+
}; /** @description Server error */
|
|
2829
|
+
500: {
|
|
2830
|
+
headers: {
|
|
2831
|
+
[name: string]: unknown;
|
|
2832
|
+
};
|
|
2833
|
+
content: {
|
|
2834
|
+
"application/json": components["schemas"]["Error"];
|
|
2835
|
+
};
|
|
2836
|
+
};
|
|
2837
|
+
};
|
|
2838
|
+
};
|
|
2839
|
+
subscribeCommentThread: {
|
|
2840
|
+
parameters: {
|
|
2841
|
+
query?: never;
|
|
2842
|
+
header?: never;
|
|
2843
|
+
path: {
|
|
2844
|
+
owner: string;
|
|
2845
|
+
project: string; /** @description The build number */
|
|
2846
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
2847
|
+
commentId: string;
|
|
2848
|
+
};
|
|
2849
|
+
cookie?: never;
|
|
2850
|
+
};
|
|
2851
|
+
requestBody?: never;
|
|
2852
|
+
responses: {
|
|
2853
|
+
/** @description Subscribed — returns the root comment */200: {
|
|
2854
|
+
headers: {
|
|
2855
|
+
[name: string]: unknown;
|
|
2856
|
+
};
|
|
2857
|
+
content: {
|
|
2858
|
+
"application/json": components["schemas"]["Comment"];
|
|
2859
|
+
};
|
|
2860
|
+
}; /** @description Invalid parameters */
|
|
2861
|
+
400: {
|
|
2862
|
+
headers: {
|
|
2863
|
+
[name: string]: unknown;
|
|
2864
|
+
};
|
|
2865
|
+
content: {
|
|
2866
|
+
"application/json": components["schemas"]["Error"];
|
|
2867
|
+
};
|
|
2868
|
+
}; /** @description Unauthorized */
|
|
2869
|
+
401: {
|
|
2870
|
+
headers: {
|
|
2871
|
+
[name: string]: unknown;
|
|
2872
|
+
};
|
|
2873
|
+
content: {
|
|
2874
|
+
"application/json": components["schemas"]["Error"];
|
|
2875
|
+
};
|
|
2876
|
+
}; /** @description Forbidden */
|
|
2877
|
+
403: {
|
|
2878
|
+
headers: {
|
|
2879
|
+
[name: string]: unknown;
|
|
2880
|
+
};
|
|
2881
|
+
content: {
|
|
2882
|
+
"application/json": components["schemas"]["Error"];
|
|
2883
|
+
};
|
|
2884
|
+
}; /** @description Not found */
|
|
2885
|
+
404: {
|
|
2886
|
+
headers: {
|
|
2887
|
+
[name: string]: unknown;
|
|
2888
|
+
};
|
|
2889
|
+
content: {
|
|
2890
|
+
"application/json": components["schemas"]["Error"];
|
|
2891
|
+
};
|
|
2892
|
+
}; /** @description Server error */
|
|
2893
|
+
500: {
|
|
2894
|
+
headers: {
|
|
2895
|
+
[name: string]: unknown;
|
|
2896
|
+
};
|
|
2897
|
+
content: {
|
|
2898
|
+
"application/json": components["schemas"]["Error"];
|
|
2899
|
+
};
|
|
2900
|
+
};
|
|
2901
|
+
};
|
|
2902
|
+
};
|
|
2903
|
+
unsubscribeCommentThread: {
|
|
2904
|
+
parameters: {
|
|
2905
|
+
query?: never;
|
|
2906
|
+
header?: never;
|
|
2907
|
+
path: {
|
|
2908
|
+
owner: string;
|
|
2909
|
+
project: string; /** @description The build number */
|
|
2910
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
2911
|
+
commentId: string;
|
|
2912
|
+
};
|
|
2913
|
+
cookie?: never;
|
|
2914
|
+
};
|
|
2915
|
+
requestBody?: never;
|
|
2916
|
+
responses: {
|
|
2917
|
+
/** @description Unsubscribed — returns the root comment */200: {
|
|
2918
|
+
headers: {
|
|
2919
|
+
[name: string]: unknown;
|
|
2920
|
+
};
|
|
2921
|
+
content: {
|
|
2922
|
+
"application/json": components["schemas"]["Comment"];
|
|
1664
2923
|
};
|
|
1665
2924
|
}; /** @description Invalid parameters */
|
|
1666
2925
|
400: {
|