@argos-ci/api-client 0.27.0 → 0.28.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 +1459 -272
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -26,6 +26,26 @@ interface paths {
|
|
|
26
26
|
patch?: never;
|
|
27
27
|
trace?: never;
|
|
28
28
|
};
|
|
29
|
+
"/accounts/{accountSlug}/projects": {
|
|
30
|
+
parameters: {
|
|
31
|
+
query?: never;
|
|
32
|
+
header?: never;
|
|
33
|
+
path?: never;
|
|
34
|
+
cookie?: never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* List an account's projects
|
|
38
|
+
* @description List the projects of an account that are visible to the authenticated user, most recently active first. Results are paginated. The token must be scoped to the account.
|
|
39
|
+
*/
|
|
40
|
+
get: operations["listProjects"];
|
|
41
|
+
put?: never;
|
|
42
|
+
post?: never;
|
|
43
|
+
delete?: never;
|
|
44
|
+
options?: never;
|
|
45
|
+
head?: never;
|
|
46
|
+
patch?: never;
|
|
47
|
+
trace?: never;
|
|
48
|
+
};
|
|
29
49
|
"/builds": {
|
|
30
50
|
parameters: {
|
|
31
51
|
query?: never;
|
|
@@ -235,7 +255,7 @@ interface paths {
|
|
|
235
255
|
};
|
|
236
256
|
/**
|
|
237
257
|
* Get the current user
|
|
238
|
-
* @description Retrieve the user associated with the
|
|
258
|
+
* @description Retrieve the user associated with the token used to authenticate the request, with the accounts (personal and teams) the token can access. Account slugs are the `owner` used in other API paths.
|
|
239
259
|
*/
|
|
240
260
|
get: operations["getMe"];
|
|
241
261
|
put?: never;
|
|
@@ -335,9 +355,9 @@ interface paths {
|
|
|
335
355
|
};
|
|
336
356
|
/**
|
|
337
357
|
* List a project's builds
|
|
338
|
-
* @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.
|
|
358
|
+
* @description List the builds of a project, most recent first. Results are paginated. Use `search` to match builds by name, branch or commit, and `distinctName` to return only the latest build per name and commit.
|
|
339
359
|
*/
|
|
340
|
-
get: operations["
|
|
360
|
+
get: operations["listBuilds"];
|
|
341
361
|
put?: never;
|
|
342
362
|
post?: never;
|
|
343
363
|
delete?: never;
|
|
@@ -479,15 +499,15 @@ interface paths {
|
|
|
479
499
|
};
|
|
480
500
|
/**
|
|
481
501
|
* List the comments on a build
|
|
482
|
-
* @description List the comments on a build
|
|
502
|
+
* @description List the comments on a build.
|
|
483
503
|
*/
|
|
484
|
-
get: operations["
|
|
504
|
+
get: operations["listBuildComments"];
|
|
485
505
|
put?: never;
|
|
486
506
|
/**
|
|
487
507
|
* Post a comment (or reply) on a build
|
|
488
508
|
* @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`.
|
|
489
509
|
*/
|
|
490
|
-
post: operations["
|
|
510
|
+
post: operations["createBuildComment"];
|
|
491
511
|
delete?: never;
|
|
492
512
|
options?: never;
|
|
493
513
|
head?: never;
|
|
@@ -505,21 +525,21 @@ interface paths {
|
|
|
505
525
|
* Get a single comment on a build
|
|
506
526
|
* @description Retrieve a single comment on a build by its ID.
|
|
507
527
|
*/
|
|
508
|
-
get: operations["
|
|
528
|
+
get: operations["getBuildComment"];
|
|
509
529
|
put?: never;
|
|
510
530
|
post?: never;
|
|
511
531
|
/**
|
|
512
532
|
* Delete a comment on a build
|
|
513
533
|
* @description Delete a comment on a build. Only the comment's author can delete it.
|
|
514
534
|
*/
|
|
515
|
-
delete: operations["
|
|
535
|
+
delete: operations["deleteBuildComment"];
|
|
516
536
|
options?: never;
|
|
517
537
|
head?: never;
|
|
518
538
|
/**
|
|
519
539
|
* Update a comment on a build
|
|
520
540
|
* @description Update the body of a comment on a build. Only the comment's author can edit it.
|
|
521
541
|
*/
|
|
522
|
-
patch: operations["
|
|
542
|
+
patch: operations["updateBuildComment"];
|
|
523
543
|
trace?: never;
|
|
524
544
|
};
|
|
525
545
|
"/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions": {
|
|
@@ -532,15 +552,15 @@ interface paths {
|
|
|
532
552
|
get?: never;
|
|
533
553
|
put?: never;
|
|
534
554
|
/**
|
|
535
|
-
* Add an emoji reaction to a comment
|
|
536
|
-
* @description Add an emoji reaction to a comment on behalf of the authenticated user.
|
|
555
|
+
* Add an emoji reaction to a comment on a build
|
|
556
|
+
* @description Add an emoji reaction to a comment on a build, on behalf of the authenticated user.
|
|
537
557
|
*/
|
|
538
|
-
post: operations["
|
|
558
|
+
post: operations["addBuildCommentReaction"];
|
|
539
559
|
/**
|
|
540
|
-
* Remove an emoji reaction from a comment
|
|
541
|
-
* @description Remove an emoji reaction previously added by the authenticated user from a comment.
|
|
560
|
+
* Remove an emoji reaction from a comment on a build
|
|
561
|
+
* @description Remove an emoji reaction previously added by the authenticated user from a comment on a build.
|
|
542
562
|
*/
|
|
543
|
-
delete: operations["
|
|
563
|
+
delete: operations["removeBuildCommentReaction"];
|
|
544
564
|
options?: never;
|
|
545
565
|
head?: never;
|
|
546
566
|
patch?: never;
|
|
@@ -556,10 +576,10 @@ interface paths {
|
|
|
556
576
|
get?: never;
|
|
557
577
|
put?: never;
|
|
558
578
|
/**
|
|
559
|
-
* Mark a comment thread as resolved
|
|
560
|
-
* @description Mark a comment thread as resolved.
|
|
579
|
+
* Mark a build comment thread as resolved
|
|
580
|
+
* @description Mark a comment thread on a build as resolved.
|
|
561
581
|
*/
|
|
562
|
-
post: operations["
|
|
582
|
+
post: operations["resolveBuildCommentThread"];
|
|
563
583
|
delete?: never;
|
|
564
584
|
options?: never;
|
|
565
585
|
head?: never;
|
|
@@ -576,10 +596,10 @@ interface paths {
|
|
|
576
596
|
get?: never;
|
|
577
597
|
put?: never;
|
|
578
598
|
/**
|
|
579
|
-
* Reopen a resolved comment thread
|
|
580
|
-
* @description Reopen a previously resolved comment thread.
|
|
599
|
+
* Reopen a resolved build comment thread
|
|
600
|
+
* @description Reopen a previously resolved comment thread on a build.
|
|
581
601
|
*/
|
|
582
|
-
post: operations["
|
|
602
|
+
post: operations["unresolveBuildCommentThread"];
|
|
583
603
|
delete?: never;
|
|
584
604
|
options?: never;
|
|
585
605
|
head?: never;
|
|
@@ -596,15 +616,195 @@ interface paths {
|
|
|
596
616
|
get?: never;
|
|
597
617
|
put?: never;
|
|
598
618
|
/**
|
|
599
|
-
* Subscribe to a comment thread's notifications
|
|
600
|
-
* @description Subscribe the authenticated user to a comment thread to receive notifications about new replies.
|
|
619
|
+
* Subscribe to a build comment thread's notifications
|
|
620
|
+
* @description Subscribe the authenticated user to a comment thread on a build to receive notifications about new replies.
|
|
621
|
+
*/
|
|
622
|
+
post: operations["subscribeBuildCommentThread"];
|
|
623
|
+
/**
|
|
624
|
+
* Unsubscribe from a build comment thread's notifications
|
|
625
|
+
* @description Unsubscribe the authenticated user from a build comment thread's notifications.
|
|
626
|
+
*/
|
|
627
|
+
delete: operations["unsubscribeBuildCommentThread"];
|
|
628
|
+
options?: never;
|
|
629
|
+
head?: never;
|
|
630
|
+
patch?: never;
|
|
631
|
+
trace?: never;
|
|
632
|
+
};
|
|
633
|
+
"/projects/{owner}/{project}/tests/{testId}": {
|
|
634
|
+
parameters: {
|
|
635
|
+
query?: never;
|
|
636
|
+
header?: never;
|
|
637
|
+
path?: never;
|
|
638
|
+
cookie?: never;
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* Get a test and its flakiness metrics
|
|
642
|
+
* @description Get a test with its flakiness metrics over a period: how many builds ran it, how many times it changed, and how stable and consistent those changes were. The metrics also come bucketed over time, so you can tell a test that has always been flaky from one that started recently. Pair it with `listTestChanges` to see what actually keeps changing.
|
|
643
|
+
*/
|
|
644
|
+
get: operations["getTest"];
|
|
645
|
+
put?: never;
|
|
646
|
+
post?: never;
|
|
647
|
+
delete?: never;
|
|
648
|
+
options?: never;
|
|
649
|
+
head?: never;
|
|
650
|
+
patch?: never;
|
|
651
|
+
trace?: never;
|
|
652
|
+
};
|
|
653
|
+
"/projects/{owner}/{project}/tests/{testId}/changes": {
|
|
654
|
+
parameters: {
|
|
655
|
+
query?: never;
|
|
656
|
+
header?: never;
|
|
657
|
+
path?: never;
|
|
658
|
+
cookie?: never;
|
|
659
|
+
};
|
|
660
|
+
/**
|
|
661
|
+
* List a test's changes
|
|
662
|
+
* @description List the distinct changes a test produced over a period, the ones that came back most often first. Each change is one exact visual difference, with how many times it reappeared, whether it is ignored, and the diff of its latest occurrence — so you can look at what moved. A change that keeps reappearing while nothing in the UI changed is a flaky one: fix what makes it unstable, or silence it with `ignoreChange`.
|
|
663
|
+
*/
|
|
664
|
+
get: operations["listTestChanges"];
|
|
665
|
+
put?: never;
|
|
666
|
+
post?: never;
|
|
667
|
+
delete?: never;
|
|
668
|
+
options?: never;
|
|
669
|
+
head?: never;
|
|
670
|
+
patch?: never;
|
|
671
|
+
trace?: never;
|
|
672
|
+
};
|
|
673
|
+
"/projects/{owner}/{project}/tests/{testId}/comments": {
|
|
674
|
+
parameters: {
|
|
675
|
+
query?: never;
|
|
676
|
+
header?: never;
|
|
677
|
+
path?: never;
|
|
678
|
+
cookie?: never;
|
|
679
|
+
};
|
|
680
|
+
/**
|
|
681
|
+
* List the comments on a test
|
|
682
|
+
* @description List the comments on a test.
|
|
683
|
+
*/
|
|
684
|
+
get: operations["listTestComments"];
|
|
685
|
+
put?: never;
|
|
686
|
+
/**
|
|
687
|
+
* Post a comment (or reply) on a test
|
|
688
|
+
* @description Post a comment on a test. Start a new thread, or reply to an existing one with `threadId`.
|
|
689
|
+
*/
|
|
690
|
+
post: operations["createTestComment"];
|
|
691
|
+
delete?: never;
|
|
692
|
+
options?: never;
|
|
693
|
+
head?: never;
|
|
694
|
+
patch?: never;
|
|
695
|
+
trace?: never;
|
|
696
|
+
};
|
|
697
|
+
"/projects/{owner}/{project}/tests/{testId}/comments/{commentId}": {
|
|
698
|
+
parameters: {
|
|
699
|
+
query?: never;
|
|
700
|
+
header?: never;
|
|
701
|
+
path?: never;
|
|
702
|
+
cookie?: never;
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* Get a single comment on a test
|
|
706
|
+
* @description Retrieve a single comment on a test by its ID.
|
|
707
|
+
*/
|
|
708
|
+
get: operations["getTestComment"];
|
|
709
|
+
put?: never;
|
|
710
|
+
post?: never;
|
|
711
|
+
/**
|
|
712
|
+
* Delete a comment on a test
|
|
713
|
+
* @description Delete a comment on a test. Only the comment's author can delete it.
|
|
714
|
+
*/
|
|
715
|
+
delete: operations["deleteTestComment"];
|
|
716
|
+
options?: never;
|
|
717
|
+
head?: never;
|
|
718
|
+
/**
|
|
719
|
+
* Update a comment on a test
|
|
720
|
+
* @description Update the body of a comment on a test. Only the comment's author can edit it.
|
|
721
|
+
*/
|
|
722
|
+
patch: operations["updateTestComment"];
|
|
723
|
+
trace?: never;
|
|
724
|
+
};
|
|
725
|
+
"/projects/{owner}/{project}/tests/{testId}/comments/{commentId}/reactions": {
|
|
726
|
+
parameters: {
|
|
727
|
+
query?: never;
|
|
728
|
+
header?: never;
|
|
729
|
+
path?: never;
|
|
730
|
+
cookie?: never;
|
|
731
|
+
};
|
|
732
|
+
get?: never;
|
|
733
|
+
put?: never;
|
|
734
|
+
/**
|
|
735
|
+
* Add an emoji reaction to a comment on a test
|
|
736
|
+
* @description Add an emoji reaction to a comment on a test, on behalf of the authenticated user.
|
|
737
|
+
*/
|
|
738
|
+
post: operations["addTestCommentReaction"];
|
|
739
|
+
/**
|
|
740
|
+
* Remove an emoji reaction from a comment on a test
|
|
741
|
+
* @description Remove an emoji reaction previously added by the authenticated user from a comment on a test.
|
|
742
|
+
*/
|
|
743
|
+
delete: operations["removeTestCommentReaction"];
|
|
744
|
+
options?: never;
|
|
745
|
+
head?: never;
|
|
746
|
+
patch?: never;
|
|
747
|
+
trace?: never;
|
|
748
|
+
};
|
|
749
|
+
"/projects/{owner}/{project}/tests/{testId}/comments/{commentId}/resolve": {
|
|
750
|
+
parameters: {
|
|
751
|
+
query?: never;
|
|
752
|
+
header?: never;
|
|
753
|
+
path?: never;
|
|
754
|
+
cookie?: never;
|
|
755
|
+
};
|
|
756
|
+
get?: never;
|
|
757
|
+
put?: never;
|
|
758
|
+
/**
|
|
759
|
+
* Mark a test comment thread as resolved
|
|
760
|
+
* @description Mark a comment thread on a test as resolved.
|
|
761
|
+
*/
|
|
762
|
+
post: operations["resolveTestCommentThread"];
|
|
763
|
+
delete?: never;
|
|
764
|
+
options?: never;
|
|
765
|
+
head?: never;
|
|
766
|
+
patch?: never;
|
|
767
|
+
trace?: never;
|
|
768
|
+
};
|
|
769
|
+
"/projects/{owner}/{project}/tests/{testId}/comments/{commentId}/unresolve": {
|
|
770
|
+
parameters: {
|
|
771
|
+
query?: never;
|
|
772
|
+
header?: never;
|
|
773
|
+
path?: never;
|
|
774
|
+
cookie?: never;
|
|
775
|
+
};
|
|
776
|
+
get?: never;
|
|
777
|
+
put?: never;
|
|
778
|
+
/**
|
|
779
|
+
* Reopen a resolved test comment thread
|
|
780
|
+
* @description Reopen a previously resolved comment thread on a test.
|
|
781
|
+
*/
|
|
782
|
+
post: operations["unresolveTestCommentThread"];
|
|
783
|
+
delete?: never;
|
|
784
|
+
options?: never;
|
|
785
|
+
head?: never;
|
|
786
|
+
patch?: never;
|
|
787
|
+
trace?: never;
|
|
788
|
+
};
|
|
789
|
+
"/projects/{owner}/{project}/tests/{testId}/comments/{commentId}/subscription": {
|
|
790
|
+
parameters: {
|
|
791
|
+
query?: never;
|
|
792
|
+
header?: never;
|
|
793
|
+
path?: never;
|
|
794
|
+
cookie?: never;
|
|
795
|
+
};
|
|
796
|
+
get?: never;
|
|
797
|
+
put?: never;
|
|
798
|
+
/**
|
|
799
|
+
* Subscribe to a test comment thread's notifications
|
|
800
|
+
* @description Subscribe the authenticated user to a comment thread on a test to receive notifications about new replies.
|
|
601
801
|
*/
|
|
602
|
-
post: operations["
|
|
802
|
+
post: operations["subscribeTestCommentThread"];
|
|
603
803
|
/**
|
|
604
|
-
* Unsubscribe from a comment thread's notifications
|
|
605
|
-
* @description Unsubscribe the authenticated user from a comment thread's notifications.
|
|
804
|
+
* Unsubscribe from a test comment thread's notifications
|
|
805
|
+
* @description Unsubscribe the authenticated user from a test comment thread's notifications.
|
|
606
806
|
*/
|
|
607
|
-
delete: operations["
|
|
807
|
+
delete: operations["unsubscribeTestCommentThread"];
|
|
608
808
|
options?: never;
|
|
609
809
|
head?: never;
|
|
610
810
|
patch?: never;
|
|
@@ -717,7 +917,14 @@ interface components {
|
|
|
717
917
|
* @description The build number
|
|
718
918
|
* @example 42
|
|
719
919
|
*/
|
|
720
|
-
BuildNumber: string;
|
|
920
|
+
BuildNumber: string; /** @description The ID of the comment */
|
|
921
|
+
CommentId: string; /** @description ID of any comment in the thread */
|
|
922
|
+
ThreadCommentId: string;
|
|
923
|
+
/**
|
|
924
|
+
* @description The test identifier, as returned in a diff's `test.id`
|
|
925
|
+
* @example WEB-xf23d
|
|
926
|
+
*/
|
|
927
|
+
TestId: string;
|
|
721
928
|
AccountAnalytics: {
|
|
722
929
|
screenshots: {
|
|
723
930
|
series: {
|
|
@@ -771,10 +978,30 @@ interface components {
|
|
|
771
978
|
details?: {
|
|
772
979
|
message: string;
|
|
773
980
|
}[];
|
|
981
|
+
}; /** @description Page information */
|
|
982
|
+
PageInfo: {
|
|
983
|
+
/** @description Total number of items */total: number; /** @description Current page number */
|
|
984
|
+
page: number; /** @description Number of items per page */
|
|
985
|
+
perPage: number;
|
|
986
|
+
}; /** @description Project */
|
|
987
|
+
Project: {
|
|
988
|
+
id: string;
|
|
989
|
+
account: components["schemas"]["Account"];
|
|
990
|
+
name: string;
|
|
991
|
+
defaultBaseBranch: string;
|
|
992
|
+
hasRemoteContentAccess: boolean;
|
|
993
|
+
}; /** @description Account */
|
|
994
|
+
Account: {
|
|
995
|
+
id: string;
|
|
996
|
+
slug: string;
|
|
774
997
|
}; /** @description Build */
|
|
775
998
|
Build: {
|
|
776
999
|
id: components["schemas"]["BuildId"];
|
|
777
|
-
|
|
1000
|
+
/**
|
|
1001
|
+
* @description The build number
|
|
1002
|
+
* @example 42
|
|
1003
|
+
*/
|
|
1004
|
+
number: number; /** @description The head reference of the build */
|
|
778
1005
|
head: components["schemas"]["BuildGitReference"]; /** @description The base reference of the build */
|
|
779
1006
|
base: components["schemas"]["BuildGitReference"] | null; /** @description The status of the build */
|
|
780
1007
|
status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted"); /** @description The conclusion of the build */
|
|
@@ -822,27 +1049,18 @@ interface components {
|
|
|
822
1049
|
BuildGitReference: {
|
|
823
1050
|
/** @description The commit SHA */sha: components["schemas"]["Sha1Hash"]; /** @description The branch name */
|
|
824
1051
|
branch: string;
|
|
825
|
-
}; /** @description
|
|
826
|
-
|
|
1052
|
+
}; /** @description The authenticated user. */
|
|
1053
|
+
Me: {
|
|
827
1054
|
id: string;
|
|
828
1055
|
slug: string;
|
|
829
|
-
name: string | null;
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
name: string;
|
|
835
|
-
defaultBaseBranch: string;
|
|
836
|
-
hasRemoteContentAccess: boolean;
|
|
837
|
-
}; /** @description Account */
|
|
838
|
-
Account: {
|
|
839
|
-
id: string;
|
|
1056
|
+
name: string | null; /** @description The accounts this token can access: the personal account and the teams selected when the token was created or authorized. */
|
|
1057
|
+
accounts: components["schemas"]["MeAccount"][];
|
|
1058
|
+
}; /** @description An account (personal or team) accessible to the token. */
|
|
1059
|
+
MeAccount: {
|
|
1060
|
+
id: string; /** @description Account slug, used as the `owner` in API paths. */
|
|
840
1061
|
slug: string;
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
/** @description Total number of items */total: number; /** @description Current page number */
|
|
844
|
-
page: number; /** @description Number of items per page */
|
|
845
|
-
perPage: number;
|
|
1062
|
+
name: string | null; /** @enum {string} */
|
|
1063
|
+
type: "user" | "team";
|
|
846
1064
|
}; /** @description Snapshot diff */
|
|
847
1065
|
SnapshotDiff: {
|
|
848
1066
|
/** @description Unique identifier of the snapshot diff */id: string; /** @description Name of the snapshot diff */
|
|
@@ -1028,10 +1246,16 @@ interface components {
|
|
|
1028
1246
|
dismissedAt: string | null; /** @description The user who dismissed the review, if any. */
|
|
1029
1247
|
dismissedBy: components["schemas"]["User"] | null; /** @description Date the review was created. */
|
|
1030
1248
|
date: string;
|
|
1031
|
-
}; /** @description A
|
|
1032
|
-
|
|
1249
|
+
}; /** @description A user. */
|
|
1250
|
+
User: {
|
|
1033
1251
|
id: string;
|
|
1034
|
-
|
|
1252
|
+
slug: string;
|
|
1253
|
+
name: string | null;
|
|
1254
|
+
}; /** @description A comment posted on a build or on a test. */
|
|
1255
|
+
Comment: {
|
|
1256
|
+
id: string; /** @description Build this comment is posted on, null when it is posted on a test. */
|
|
1257
|
+
buildId: string | null; /** @description Test this comment is posted on, null when it is posted on a build. */
|
|
1258
|
+
testId: string | null; /** @description Root comment ID when this comment is a reply. */
|
|
1035
1259
|
threadId: string | null; /** @description Rich-text JSON content of the comment. */
|
|
1036
1260
|
body: unknown; /** @description Plain-text rendering of the comment content. */
|
|
1037
1261
|
text: string;
|
|
@@ -1055,12 +1279,68 @@ interface components {
|
|
|
1055
1279
|
count: number; /** @description The users who reacted with this emoji. */
|
|
1056
1280
|
users: components["schemas"]["User"][];
|
|
1057
1281
|
}[];
|
|
1282
|
+
}; /** @description A test with its flakiness metrics, both aggregated and over time, and when it first and last changed. */
|
|
1283
|
+
TestDetails: {
|
|
1284
|
+
/** @description Unique identifier of the test */id: string; /** @description Name of the test */
|
|
1285
|
+
name: string; /** @description Name of the build the test belongs to */
|
|
1286
|
+
buildName: string;
|
|
1287
|
+
metrics: components["schemas"]["TestMetrics"];
|
|
1288
|
+
status: components["schemas"]["TestStatus"];
|
|
1289
|
+
/**
|
|
1290
|
+
* Format: date-time
|
|
1291
|
+
* @description When Argos first saw this test.
|
|
1292
|
+
*/
|
|
1293
|
+
createdAt: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* Format: uri
|
|
1296
|
+
* @description URL of the test in Argos.
|
|
1297
|
+
*/
|
|
1298
|
+
url: string; /** @description The test's metrics bucketed over the requested period, oldest first. Use it to tell a test that has always been flaky from one that only started recently. */
|
|
1299
|
+
series: components["schemas"]["TestMetricsDataPoint"][]; /** @description The first time this test ever changed, whatever the period. Null when it never changed. */
|
|
1300
|
+
firstSeenChange: components["schemas"]["TestChangeOccurrence"] | null; /** @description The last time this test changed, whatever the period. Null when it never changed. */
|
|
1301
|
+
lastSeenChange: components["schemas"]["TestChangeOccurrence"] | null;
|
|
1058
1302
|
};
|
|
1059
1303
|
/**
|
|
1060
|
-
* @description
|
|
1061
|
-
* @
|
|
1304
|
+
* @description `ongoing` when the test still runs — it showed up in the latest build of its build name. `removed` when it did not, so it was deleted, renamed or skipped.
|
|
1305
|
+
* @enum {string}
|
|
1062
1306
|
*/
|
|
1063
|
-
|
|
1307
|
+
TestStatus: "ongoing" | "removed"; /** @description One bucket of a test's metrics over time. The bucket size is derived from the requested period. */
|
|
1308
|
+
TestMetricsDataPoint: {
|
|
1309
|
+
/**
|
|
1310
|
+
* Format: date-time
|
|
1311
|
+
* @description Start of the time bucket.
|
|
1312
|
+
*/
|
|
1313
|
+
date: string; /** @description Number of builds in which the test ran in this bucket. */
|
|
1314
|
+
total: number; /** @description Number of times the test changed in this bucket. */
|
|
1315
|
+
changes: number; /** @description Number of those changes that were seen only once. */
|
|
1316
|
+
uniqueChanges: number;
|
|
1317
|
+
}; /** @description A single appearance of a change, in the build that saw it. */
|
|
1318
|
+
TestChangeOccurrence: {
|
|
1319
|
+
/**
|
|
1320
|
+
* Format: date-time
|
|
1321
|
+
* @description When the diff was captured.
|
|
1322
|
+
*/
|
|
1323
|
+
date: string; /** @description Public URL of the diff image. Null when the image is no longer available. */
|
|
1324
|
+
url: string | null;
|
|
1325
|
+
/**
|
|
1326
|
+
* @description Number of the build that captured the diff.
|
|
1327
|
+
* @example 42
|
|
1328
|
+
*/
|
|
1329
|
+
buildNumber: number;
|
|
1330
|
+
/**
|
|
1331
|
+
* Format: uri
|
|
1332
|
+
* @description URL of that build in Argos.
|
|
1333
|
+
*/
|
|
1334
|
+
buildUrl: string;
|
|
1335
|
+
}; /** @description One distinct change of a test: an exact visual difference, with how often it came back over the period. A change that keeps reappearing while nothing in the UI changed is a flaky one. */
|
|
1336
|
+
TestChange: {
|
|
1337
|
+
/** @description Unique identifier of the change (a test + fingerprint pair). Use it with the ignore/unignore endpoints. */id: string; /** @description Whether this change is currently ignored. Ignored changes no longer require review and are automatically approved. */
|
|
1338
|
+
ignored: boolean; /** @description Number of times this change has been seen over the metrics period. A high count for a recurring change is a strong flakiness signal. */
|
|
1339
|
+
occurrences: number; /** @description The first time this change was seen over the period. */
|
|
1340
|
+
firstSeen: components["schemas"]["TestChangeOccurrence"]; /** @description The last time this change was seen over the period. */
|
|
1341
|
+
lastSeen: components["schemas"]["TestChangeOccurrence"]; /** @description The diff captured the last time the change was seen, with the baseline and the captured snapshot, so you can look at what moved. */
|
|
1342
|
+
diff: components["schemas"]["SnapshotDiff"];
|
|
1343
|
+
};
|
|
1064
1344
|
};
|
|
1065
1345
|
responses: never;
|
|
1066
1346
|
parameters: never;
|
|
@@ -1120,42 +1400,101 @@ interface operations {
|
|
|
1120
1400
|
};
|
|
1121
1401
|
};
|
|
1122
1402
|
};
|
|
1123
|
-
|
|
1403
|
+
listProjects: {
|
|
1124
1404
|
parameters: {
|
|
1125
|
-
query?:
|
|
1405
|
+
query?: {
|
|
1406
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
1407
|
+
page?: string;
|
|
1408
|
+
};
|
|
1126
1409
|
header?: never;
|
|
1127
|
-
path
|
|
1410
|
+
path: {
|
|
1411
|
+
/** @description Slug of the account to list projects for. */accountSlug: string;
|
|
1412
|
+
};
|
|
1128
1413
|
cookie?: never;
|
|
1129
1414
|
};
|
|
1130
|
-
requestBody?:
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
}
|
|
1158
|
-
|
|
1415
|
+
requestBody?: never;
|
|
1416
|
+
responses: {
|
|
1417
|
+
/** @description List of projects */200: {
|
|
1418
|
+
headers: {
|
|
1419
|
+
[name: string]: unknown;
|
|
1420
|
+
};
|
|
1421
|
+
content: {
|
|
1422
|
+
"application/json": {
|
|
1423
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
1424
|
+
results: components["schemas"]["Project"][];
|
|
1425
|
+
};
|
|
1426
|
+
};
|
|
1427
|
+
}; /** @description Invalid parameters */
|
|
1428
|
+
400: {
|
|
1429
|
+
headers: {
|
|
1430
|
+
[name: string]: unknown;
|
|
1431
|
+
};
|
|
1432
|
+
content: {
|
|
1433
|
+
"application/json": components["schemas"]["Error"];
|
|
1434
|
+
};
|
|
1435
|
+
}; /** @description Unauthorized */
|
|
1436
|
+
401: {
|
|
1437
|
+
headers: {
|
|
1438
|
+
[name: string]: unknown;
|
|
1439
|
+
};
|
|
1440
|
+
content: {
|
|
1441
|
+
"application/json": components["schemas"]["Error"];
|
|
1442
|
+
};
|
|
1443
|
+
}; /** @description Forbidden */
|
|
1444
|
+
403: {
|
|
1445
|
+
headers: {
|
|
1446
|
+
[name: string]: unknown;
|
|
1447
|
+
};
|
|
1448
|
+
content: {
|
|
1449
|
+
"application/json": components["schemas"]["Error"];
|
|
1450
|
+
};
|
|
1451
|
+
}; /** @description Server error */
|
|
1452
|
+
500: {
|
|
1453
|
+
headers: {
|
|
1454
|
+
[name: string]: unknown;
|
|
1455
|
+
};
|
|
1456
|
+
content: {
|
|
1457
|
+
"application/json": components["schemas"]["Error"];
|
|
1458
|
+
};
|
|
1459
|
+
};
|
|
1460
|
+
};
|
|
1461
|
+
};
|
|
1462
|
+
createBuild: {
|
|
1463
|
+
parameters: {
|
|
1464
|
+
query?: never;
|
|
1465
|
+
header?: never;
|
|
1466
|
+
path?: never;
|
|
1467
|
+
cookie?: never;
|
|
1468
|
+
};
|
|
1469
|
+
requestBody?: {
|
|
1470
|
+
content: {
|
|
1471
|
+
"application/json": {
|
|
1472
|
+
/** @description The commit the build is running on */commit: components["schemas"]["Sha1Hash"]; /** @description The branch the build is running on */
|
|
1473
|
+
branch: components["schemas"]["GitBranch"]; /** @description Keys of Playwright trace files */
|
|
1474
|
+
pwTraceKeys?: components["schemas"]["Sha256Hash"][]; /** @description The name of the build (for multi-build setups) */
|
|
1475
|
+
name?: string | null; /** @description Whether to run the build in parallel */
|
|
1476
|
+
parallel?: boolean | null; /** @description A unique nonce for the parallel build */
|
|
1477
|
+
parallelNonce?: string | null; /** @description The pull request number */
|
|
1478
|
+
prNumber?: number | null; /** @description The head commit of the pull request */
|
|
1479
|
+
prHeadCommit?: components["schemas"]["Sha1Hash"] | null; /** @description The commit to use as a reference for the build */
|
|
1480
|
+
referenceCommit?: components["schemas"]["Sha1Hash"] | null; /** @description The branch to use as a reference for the build */
|
|
1481
|
+
referenceBranch?: string | null; /** @description The parent commits of the build */
|
|
1482
|
+
parentCommits?: components["schemas"]["Sha1Hash"][] | null; /** @description The mode in which the build is running */
|
|
1483
|
+
mode?: ("ci" | "monitoring") | null; /** @description The CI provider being used */
|
|
1484
|
+
ciProvider?: string | null; /** @description The version of the Argos SDK being used */
|
|
1485
|
+
argosSdk?: string | null; /** @description The ID of the current run */
|
|
1486
|
+
runId?: string | null; /** @description The attempt number of the current run */
|
|
1487
|
+
runAttempt?: number | null; /** @description Whether the build was skipped, not comparing anything and always succeeding */
|
|
1488
|
+
skipped?: boolean | null; /** @description Whether the build has been created in a merge queue */
|
|
1489
|
+
mergeQueue?: boolean | null; /** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
|
|
1490
|
+
mergeQueuePrNumbers?: number[] | null;
|
|
1491
|
+
/**
|
|
1492
|
+
* @description Indicates whether this build contains only a subset of screenshots.
|
|
1493
|
+
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
1494
|
+
*/
|
|
1495
|
+
subset?: boolean | null;
|
|
1496
|
+
} & ({
|
|
1497
|
+
/**
|
|
1159
1498
|
* @deprecated
|
|
1160
1499
|
* @description Keys of screenshot files
|
|
1161
1500
|
*/
|
|
@@ -1826,7 +2165,7 @@ interface operations {
|
|
|
1826
2165
|
[name: string]: unknown;
|
|
1827
2166
|
};
|
|
1828
2167
|
content: {
|
|
1829
|
-
"application/json": components["schemas"]["
|
|
2168
|
+
"application/json": components["schemas"]["Me"];
|
|
1830
2169
|
};
|
|
1831
2170
|
}; /** @description Unauthorized */
|
|
1832
2171
|
401: {
|
|
@@ -1945,8 +2284,877 @@ interface operations {
|
|
|
1945
2284
|
content: {
|
|
1946
2285
|
"application/json": components["schemas"]["Error"];
|
|
1947
2286
|
};
|
|
1948
|
-
}; /** @description Conflict */
|
|
1949
|
-
409: {
|
|
2287
|
+
}; /** @description Conflict */
|
|
2288
|
+
409: {
|
|
2289
|
+
headers: {
|
|
2290
|
+
[name: string]: unknown;
|
|
2291
|
+
};
|
|
2292
|
+
content: {
|
|
2293
|
+
"application/json": components["schemas"]["Error"];
|
|
2294
|
+
};
|
|
2295
|
+
}; /** @description Server error */
|
|
2296
|
+
500: {
|
|
2297
|
+
headers: {
|
|
2298
|
+
[name: string]: unknown;
|
|
2299
|
+
};
|
|
2300
|
+
content: {
|
|
2301
|
+
"application/json": components["schemas"]["Error"];
|
|
2302
|
+
};
|
|
2303
|
+
};
|
|
2304
|
+
};
|
|
2305
|
+
};
|
|
2306
|
+
createProject: {
|
|
2307
|
+
parameters: {
|
|
2308
|
+
query?: never;
|
|
2309
|
+
header?: never;
|
|
2310
|
+
path?: never;
|
|
2311
|
+
cookie?: never;
|
|
2312
|
+
};
|
|
2313
|
+
requestBody: {
|
|
2314
|
+
content: {
|
|
2315
|
+
"application/json": {
|
|
2316
|
+
/** @description Name of the project to create. Must be unique within the account (case-insensitive) and cannot be a reserved name. */name: string; /** @description Slug of the account (personal or team) that will own the project. The personal access token must be scoped to this account and the acting user must be one of its administrators. */
|
|
2317
|
+
accountSlug: string;
|
|
2318
|
+
};
|
|
2319
|
+
};
|
|
2320
|
+
};
|
|
2321
|
+
responses: {
|
|
2322
|
+
/** @description Project created successfully — returns the project */201: {
|
|
2323
|
+
headers: {
|
|
2324
|
+
[name: string]: unknown;
|
|
2325
|
+
};
|
|
2326
|
+
content: {
|
|
2327
|
+
"application/json": components["schemas"]["Project"];
|
|
2328
|
+
};
|
|
2329
|
+
}; /** @description Invalid parameters */
|
|
2330
|
+
400: {
|
|
2331
|
+
headers: {
|
|
2332
|
+
[name: string]: unknown;
|
|
2333
|
+
};
|
|
2334
|
+
content: {
|
|
2335
|
+
"application/json": components["schemas"]["Error"];
|
|
2336
|
+
};
|
|
2337
|
+
}; /** @description Unauthorized */
|
|
2338
|
+
401: {
|
|
2339
|
+
headers: {
|
|
2340
|
+
[name: string]: unknown;
|
|
2341
|
+
};
|
|
2342
|
+
content: {
|
|
2343
|
+
"application/json": components["schemas"]["Error"];
|
|
2344
|
+
};
|
|
2345
|
+
}; /** @description Forbidden */
|
|
2346
|
+
403: {
|
|
2347
|
+
headers: {
|
|
2348
|
+
[name: string]: unknown;
|
|
2349
|
+
};
|
|
2350
|
+
content: {
|
|
2351
|
+
"application/json": components["schemas"]["Error"];
|
|
2352
|
+
};
|
|
2353
|
+
}; /** @description Server error */
|
|
2354
|
+
500: {
|
|
2355
|
+
headers: {
|
|
2356
|
+
[name: string]: unknown;
|
|
2357
|
+
};
|
|
2358
|
+
content: {
|
|
2359
|
+
"application/json": components["schemas"]["Error"];
|
|
2360
|
+
};
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
};
|
|
2364
|
+
getProject: {
|
|
2365
|
+
parameters: {
|
|
2366
|
+
query?: never;
|
|
2367
|
+
header?: never;
|
|
2368
|
+
path: {
|
|
2369
|
+
owner: string;
|
|
2370
|
+
project: string;
|
|
2371
|
+
};
|
|
2372
|
+
cookie?: never;
|
|
2373
|
+
};
|
|
2374
|
+
requestBody?: never;
|
|
2375
|
+
responses: {
|
|
2376
|
+
/** @description Project */200: {
|
|
2377
|
+
headers: {
|
|
2378
|
+
[name: string]: unknown;
|
|
2379
|
+
};
|
|
2380
|
+
content: {
|
|
2381
|
+
"application/json": components["schemas"]["Project"];
|
|
2382
|
+
};
|
|
2383
|
+
}; /** @description Unauthorized */
|
|
2384
|
+
401: {
|
|
2385
|
+
headers: {
|
|
2386
|
+
[name: string]: unknown;
|
|
2387
|
+
};
|
|
2388
|
+
content: {
|
|
2389
|
+
"application/json": components["schemas"]["Error"];
|
|
2390
|
+
};
|
|
2391
|
+
}; /** @description Forbidden */
|
|
2392
|
+
403: {
|
|
2393
|
+
headers: {
|
|
2394
|
+
[name: string]: unknown;
|
|
2395
|
+
};
|
|
2396
|
+
content: {
|
|
2397
|
+
"application/json": components["schemas"]["Error"];
|
|
2398
|
+
};
|
|
2399
|
+
}; /** @description Not found */
|
|
2400
|
+
404: {
|
|
2401
|
+
headers: {
|
|
2402
|
+
[name: string]: unknown;
|
|
2403
|
+
};
|
|
2404
|
+
content: {
|
|
2405
|
+
"application/json": components["schemas"]["Error"];
|
|
2406
|
+
};
|
|
2407
|
+
}; /** @description Server error */
|
|
2408
|
+
500: {
|
|
2409
|
+
headers: {
|
|
2410
|
+
[name: string]: unknown;
|
|
2411
|
+
};
|
|
2412
|
+
content: {
|
|
2413
|
+
"application/json": components["schemas"]["Error"];
|
|
2414
|
+
};
|
|
2415
|
+
};
|
|
2416
|
+
};
|
|
2417
|
+
};
|
|
2418
|
+
listBuilds: {
|
|
2419
|
+
parameters: {
|
|
2420
|
+
query?: {
|
|
2421
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2422
|
+
page?: string;
|
|
2423
|
+
head?: string;
|
|
2424
|
+
headSha?: components["schemas"]["Sha1Hash"]; /** @description Search builds by name, branch (substring) or commit (prefix). */
|
|
2425
|
+
search?: string; /** @description Only return the latest builds created, unique by name and commit. */
|
|
2426
|
+
distinctName?: string;
|
|
2427
|
+
};
|
|
2428
|
+
header?: never;
|
|
2429
|
+
path: {
|
|
2430
|
+
owner: string;
|
|
2431
|
+
project: string;
|
|
2432
|
+
};
|
|
2433
|
+
cookie?: never;
|
|
2434
|
+
};
|
|
2435
|
+
requestBody?: never;
|
|
2436
|
+
responses: {
|
|
2437
|
+
/** @description List of builds */200: {
|
|
2438
|
+
headers: {
|
|
2439
|
+
[name: string]: unknown;
|
|
2440
|
+
};
|
|
2441
|
+
content: {
|
|
2442
|
+
"application/json": {
|
|
2443
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
2444
|
+
results: components["schemas"]["Build"][];
|
|
2445
|
+
};
|
|
2446
|
+
};
|
|
2447
|
+
}; /** @description Invalid parameters */
|
|
2448
|
+
400: {
|
|
2449
|
+
headers: {
|
|
2450
|
+
[name: string]: unknown;
|
|
2451
|
+
};
|
|
2452
|
+
content: {
|
|
2453
|
+
"application/json": components["schemas"]["Error"];
|
|
2454
|
+
};
|
|
2455
|
+
}; /** @description Unauthorized */
|
|
2456
|
+
401: {
|
|
2457
|
+
headers: {
|
|
2458
|
+
[name: string]: unknown;
|
|
2459
|
+
};
|
|
2460
|
+
content: {
|
|
2461
|
+
"application/json": components["schemas"]["Error"];
|
|
2462
|
+
};
|
|
2463
|
+
}; /** @description Forbidden */
|
|
2464
|
+
403: {
|
|
2465
|
+
headers: {
|
|
2466
|
+
[name: string]: unknown;
|
|
2467
|
+
};
|
|
2468
|
+
content: {
|
|
2469
|
+
"application/json": components["schemas"]["Error"];
|
|
2470
|
+
};
|
|
2471
|
+
}; /** @description Not found */
|
|
2472
|
+
404: {
|
|
2473
|
+
headers: {
|
|
2474
|
+
[name: string]: unknown;
|
|
2475
|
+
};
|
|
2476
|
+
content: {
|
|
2477
|
+
"application/json": components["schemas"]["Error"];
|
|
2478
|
+
};
|
|
2479
|
+
}; /** @description Server error */
|
|
2480
|
+
500: {
|
|
2481
|
+
headers: {
|
|
2482
|
+
[name: string]: unknown;
|
|
2483
|
+
};
|
|
2484
|
+
content: {
|
|
2485
|
+
"application/json": components["schemas"]["Error"];
|
|
2486
|
+
};
|
|
2487
|
+
};
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
getBuild: {
|
|
2491
|
+
parameters: {
|
|
2492
|
+
query?: never;
|
|
2493
|
+
header?: never;
|
|
2494
|
+
path: {
|
|
2495
|
+
owner: string;
|
|
2496
|
+
project: string; /** @description The build number */
|
|
2497
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2498
|
+
};
|
|
2499
|
+
cookie?: never;
|
|
2500
|
+
};
|
|
2501
|
+
requestBody?: never;
|
|
2502
|
+
responses: {
|
|
2503
|
+
/** @description Build */200: {
|
|
2504
|
+
headers: {
|
|
2505
|
+
[name: string]: unknown;
|
|
2506
|
+
};
|
|
2507
|
+
content: {
|
|
2508
|
+
"application/json": components["schemas"]["Build"];
|
|
2509
|
+
};
|
|
2510
|
+
}; /** @description Invalid parameters */
|
|
2511
|
+
400: {
|
|
2512
|
+
headers: {
|
|
2513
|
+
[name: string]: unknown;
|
|
2514
|
+
};
|
|
2515
|
+
content: {
|
|
2516
|
+
"application/json": components["schemas"]["Error"];
|
|
2517
|
+
};
|
|
2518
|
+
}; /** @description Unauthorized */
|
|
2519
|
+
401: {
|
|
2520
|
+
headers: {
|
|
2521
|
+
[name: string]: unknown;
|
|
2522
|
+
};
|
|
2523
|
+
content: {
|
|
2524
|
+
"application/json": components["schemas"]["Error"];
|
|
2525
|
+
};
|
|
2526
|
+
}; /** @description Forbidden */
|
|
2527
|
+
403: {
|
|
2528
|
+
headers: {
|
|
2529
|
+
[name: string]: unknown;
|
|
2530
|
+
};
|
|
2531
|
+
content: {
|
|
2532
|
+
"application/json": components["schemas"]["Error"];
|
|
2533
|
+
};
|
|
2534
|
+
}; /** @description Not found */
|
|
2535
|
+
404: {
|
|
2536
|
+
headers: {
|
|
2537
|
+
[name: string]: unknown;
|
|
2538
|
+
};
|
|
2539
|
+
content: {
|
|
2540
|
+
"application/json": components["schemas"]["Error"];
|
|
2541
|
+
};
|
|
2542
|
+
}; /** @description Server error */
|
|
2543
|
+
500: {
|
|
2544
|
+
headers: {
|
|
2545
|
+
[name: string]: unknown;
|
|
2546
|
+
};
|
|
2547
|
+
content: {
|
|
2548
|
+
"application/json": components["schemas"]["Error"];
|
|
2549
|
+
};
|
|
2550
|
+
};
|
|
2551
|
+
};
|
|
2552
|
+
};
|
|
2553
|
+
listBuildDiffs: {
|
|
2554
|
+
parameters: {
|
|
2555
|
+
query?: {
|
|
2556
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2557
|
+
page?: string; /** @description Only return diffs that require review. Matches `changed`, `added`, and `removed`, except `removed` is excluded for subset builds. */
|
|
2558
|
+
needsReview?: string; /** @description Period over which the test flakiness metrics are computed. */
|
|
2559
|
+
metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2560
|
+
};
|
|
2561
|
+
header?: never;
|
|
2562
|
+
path: {
|
|
2563
|
+
owner: string;
|
|
2564
|
+
project: string; /** @description The build number */
|
|
2565
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2566
|
+
};
|
|
2567
|
+
cookie?: never;
|
|
2568
|
+
};
|
|
2569
|
+
requestBody?: never;
|
|
2570
|
+
responses: {
|
|
2571
|
+
/** @description List of screenshot diffs */200: {
|
|
2572
|
+
headers: {
|
|
2573
|
+
[name: string]: unknown;
|
|
2574
|
+
};
|
|
2575
|
+
content: {
|
|
2576
|
+
"application/json": {
|
|
2577
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
2578
|
+
results: components["schemas"]["SnapshotDiff"][];
|
|
2579
|
+
};
|
|
2580
|
+
};
|
|
2581
|
+
}; /** @description Invalid parameters */
|
|
2582
|
+
400: {
|
|
2583
|
+
headers: {
|
|
2584
|
+
[name: string]: unknown;
|
|
2585
|
+
};
|
|
2586
|
+
content: {
|
|
2587
|
+
"application/json": components["schemas"]["Error"];
|
|
2588
|
+
};
|
|
2589
|
+
}; /** @description Unauthorized */
|
|
2590
|
+
401: {
|
|
2591
|
+
headers: {
|
|
2592
|
+
[name: string]: unknown;
|
|
2593
|
+
};
|
|
2594
|
+
content: {
|
|
2595
|
+
"application/json": components["schemas"]["Error"];
|
|
2596
|
+
};
|
|
2597
|
+
}; /** @description Not found */
|
|
2598
|
+
404: {
|
|
2599
|
+
headers: {
|
|
2600
|
+
[name: string]: unknown;
|
|
2601
|
+
};
|
|
2602
|
+
content: {
|
|
2603
|
+
"application/json": components["schemas"]["Error"];
|
|
2604
|
+
};
|
|
2605
|
+
}; /** @description Server error */
|
|
2606
|
+
500: {
|
|
2607
|
+
headers: {
|
|
2608
|
+
[name: string]: unknown;
|
|
2609
|
+
};
|
|
2610
|
+
content: {
|
|
2611
|
+
"application/json": components["schemas"]["Error"];
|
|
2612
|
+
};
|
|
2613
|
+
};
|
|
2614
|
+
};
|
|
2615
|
+
};
|
|
2616
|
+
ignoreChange: {
|
|
2617
|
+
parameters: {
|
|
2618
|
+
query?: {
|
|
2619
|
+
/** @description Period over which the test flakiness metrics are computed. */metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2620
|
+
};
|
|
2621
|
+
header?: never;
|
|
2622
|
+
path: {
|
|
2623
|
+
owner: string;
|
|
2624
|
+
project: string; /** @description Identifier of the change to update, as returned in a diff's `change.id`. */
|
|
2625
|
+
changeId: string;
|
|
2626
|
+
};
|
|
2627
|
+
cookie?: never;
|
|
2628
|
+
};
|
|
2629
|
+
requestBody?: never;
|
|
2630
|
+
responses: {
|
|
2631
|
+
/** @description Change ignored — returns the updated change */200: {
|
|
2632
|
+
headers: {
|
|
2633
|
+
[name: string]: unknown;
|
|
2634
|
+
};
|
|
2635
|
+
content: {
|
|
2636
|
+
"application/json": components["schemas"]["Change"];
|
|
2637
|
+
};
|
|
2638
|
+
}; /** @description Invalid parameters */
|
|
2639
|
+
400: {
|
|
2640
|
+
headers: {
|
|
2641
|
+
[name: string]: unknown;
|
|
2642
|
+
};
|
|
2643
|
+
content: {
|
|
2644
|
+
"application/json": components["schemas"]["Error"];
|
|
2645
|
+
};
|
|
2646
|
+
}; /** @description Unauthorized */
|
|
2647
|
+
401: {
|
|
2648
|
+
headers: {
|
|
2649
|
+
[name: string]: unknown;
|
|
2650
|
+
};
|
|
2651
|
+
content: {
|
|
2652
|
+
"application/json": components["schemas"]["Error"];
|
|
2653
|
+
};
|
|
2654
|
+
}; /** @description Forbidden */
|
|
2655
|
+
403: {
|
|
2656
|
+
headers: {
|
|
2657
|
+
[name: string]: unknown;
|
|
2658
|
+
};
|
|
2659
|
+
content: {
|
|
2660
|
+
"application/json": components["schemas"]["Error"];
|
|
2661
|
+
};
|
|
2662
|
+
}; /** @description Not found */
|
|
2663
|
+
404: {
|
|
2664
|
+
headers: {
|
|
2665
|
+
[name: string]: unknown;
|
|
2666
|
+
};
|
|
2667
|
+
content: {
|
|
2668
|
+
"application/json": components["schemas"]["Error"];
|
|
2669
|
+
};
|
|
2670
|
+
}; /** @description Server error */
|
|
2671
|
+
500: {
|
|
2672
|
+
headers: {
|
|
2673
|
+
[name: string]: unknown;
|
|
2674
|
+
};
|
|
2675
|
+
content: {
|
|
2676
|
+
"application/json": components["schemas"]["Error"];
|
|
2677
|
+
};
|
|
2678
|
+
};
|
|
2679
|
+
};
|
|
2680
|
+
};
|
|
2681
|
+
unignoreChange: {
|
|
2682
|
+
parameters: {
|
|
2683
|
+
query?: {
|
|
2684
|
+
/** @description Period over which the test flakiness metrics are computed. */metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2685
|
+
};
|
|
2686
|
+
header?: never;
|
|
2687
|
+
path: {
|
|
2688
|
+
owner: string;
|
|
2689
|
+
project: string; /** @description Identifier of the change to update, as returned in a diff's `change.id`. */
|
|
2690
|
+
changeId: string;
|
|
2691
|
+
};
|
|
2692
|
+
cookie?: never;
|
|
2693
|
+
};
|
|
2694
|
+
requestBody?: never;
|
|
2695
|
+
responses: {
|
|
2696
|
+
/** @description Change unignored — returns the updated change */200: {
|
|
2697
|
+
headers: {
|
|
2698
|
+
[name: string]: unknown;
|
|
2699
|
+
};
|
|
2700
|
+
content: {
|
|
2701
|
+
"application/json": components["schemas"]["Change"];
|
|
2702
|
+
};
|
|
2703
|
+
}; /** @description Invalid parameters */
|
|
2704
|
+
400: {
|
|
2705
|
+
headers: {
|
|
2706
|
+
[name: string]: unknown;
|
|
2707
|
+
};
|
|
2708
|
+
content: {
|
|
2709
|
+
"application/json": components["schemas"]["Error"];
|
|
2710
|
+
};
|
|
2711
|
+
}; /** @description Unauthorized */
|
|
2712
|
+
401: {
|
|
2713
|
+
headers: {
|
|
2714
|
+
[name: string]: unknown;
|
|
2715
|
+
};
|
|
2716
|
+
content: {
|
|
2717
|
+
"application/json": components["schemas"]["Error"];
|
|
2718
|
+
};
|
|
2719
|
+
}; /** @description Forbidden */
|
|
2720
|
+
403: {
|
|
2721
|
+
headers: {
|
|
2722
|
+
[name: string]: unknown;
|
|
2723
|
+
};
|
|
2724
|
+
content: {
|
|
2725
|
+
"application/json": components["schemas"]["Error"];
|
|
2726
|
+
};
|
|
2727
|
+
}; /** @description Not found */
|
|
2728
|
+
404: {
|
|
2729
|
+
headers: {
|
|
2730
|
+
[name: string]: unknown;
|
|
2731
|
+
};
|
|
2732
|
+
content: {
|
|
2733
|
+
"application/json": components["schemas"]["Error"];
|
|
2734
|
+
};
|
|
2735
|
+
}; /** @description Server error */
|
|
2736
|
+
500: {
|
|
2737
|
+
headers: {
|
|
2738
|
+
[name: string]: unknown;
|
|
2739
|
+
};
|
|
2740
|
+
content: {
|
|
2741
|
+
"application/json": components["schemas"]["Error"];
|
|
2742
|
+
};
|
|
2743
|
+
};
|
|
2744
|
+
};
|
|
2745
|
+
};
|
|
2746
|
+
listReviews: {
|
|
2747
|
+
parameters: {
|
|
2748
|
+
query?: never;
|
|
2749
|
+
header?: never;
|
|
2750
|
+
path: {
|
|
2751
|
+
owner: string;
|
|
2752
|
+
project: string; /** @description The build number */
|
|
2753
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2754
|
+
};
|
|
2755
|
+
cookie?: never;
|
|
2756
|
+
};
|
|
2757
|
+
requestBody?: never;
|
|
2758
|
+
responses: {
|
|
2759
|
+
/** @description Build reviews */200: {
|
|
2760
|
+
headers: {
|
|
2761
|
+
[name: string]: unknown;
|
|
2762
|
+
};
|
|
2763
|
+
content: {
|
|
2764
|
+
"application/json": components["schemas"]["BuildReview"][];
|
|
2765
|
+
};
|
|
2766
|
+
}; /** @description Invalid parameters */
|
|
2767
|
+
400: {
|
|
2768
|
+
headers: {
|
|
2769
|
+
[name: string]: unknown;
|
|
2770
|
+
};
|
|
2771
|
+
content: {
|
|
2772
|
+
"application/json": components["schemas"]["Error"];
|
|
2773
|
+
};
|
|
2774
|
+
}; /** @description Unauthorized */
|
|
2775
|
+
401: {
|
|
2776
|
+
headers: {
|
|
2777
|
+
[name: string]: unknown;
|
|
2778
|
+
};
|
|
2779
|
+
content: {
|
|
2780
|
+
"application/json": components["schemas"]["Error"];
|
|
2781
|
+
};
|
|
2782
|
+
}; /** @description Forbidden */
|
|
2783
|
+
403: {
|
|
2784
|
+
headers: {
|
|
2785
|
+
[name: string]: unknown;
|
|
2786
|
+
};
|
|
2787
|
+
content: {
|
|
2788
|
+
"application/json": components["schemas"]["Error"];
|
|
2789
|
+
};
|
|
2790
|
+
}; /** @description Not found */
|
|
2791
|
+
404: {
|
|
2792
|
+
headers: {
|
|
2793
|
+
[name: string]: unknown;
|
|
2794
|
+
};
|
|
2795
|
+
content: {
|
|
2796
|
+
"application/json": components["schemas"]["Error"];
|
|
2797
|
+
};
|
|
2798
|
+
}; /** @description Server error */
|
|
2799
|
+
500: {
|
|
2800
|
+
headers: {
|
|
2801
|
+
[name: string]: unknown;
|
|
2802
|
+
};
|
|
2803
|
+
content: {
|
|
2804
|
+
"application/json": components["schemas"]["Error"];
|
|
2805
|
+
};
|
|
2806
|
+
};
|
|
2807
|
+
};
|
|
2808
|
+
};
|
|
2809
|
+
createReview: {
|
|
2810
|
+
parameters: {
|
|
2811
|
+
query?: never;
|
|
2812
|
+
header?: never;
|
|
2813
|
+
path: {
|
|
2814
|
+
owner: string;
|
|
2815
|
+
project: string; /** @description The build number */
|
|
2816
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2817
|
+
};
|
|
2818
|
+
cookie?: never;
|
|
2819
|
+
};
|
|
2820
|
+
requestBody: {
|
|
2821
|
+
content: {
|
|
2822
|
+
"application/json": {
|
|
2823
|
+
/**
|
|
2824
|
+
* @description Review event to apply to the build: "APPROVE", "REJECT" or "COMMENT". Required when `conclusion` is not provided.
|
|
2825
|
+
* @enum {string}
|
|
2826
|
+
*/
|
|
2827
|
+
event?: "APPROVE" | "REJECT" | "COMMENT";
|
|
2828
|
+
/**
|
|
2829
|
+
* @deprecated
|
|
2830
|
+
* @description Deprecated: use `event` instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".
|
|
2831
|
+
* @enum {string}
|
|
2832
|
+
*/
|
|
2833
|
+
conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document. */
|
|
2834
|
+
body?: unknown;
|
|
2835
|
+
/**
|
|
2836
|
+
* @description Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.
|
|
2837
|
+
* @default []
|
|
2838
|
+
*/
|
|
2839
|
+
snapshots?: {
|
|
2840
|
+
/** @description The ID of the snapshot to review */id: string;
|
|
2841
|
+
/**
|
|
2842
|
+
* @description Review conclusion for this individual snapshot: "APPROVE" or "REQUEST_CHANGES"
|
|
2843
|
+
* @enum {string}
|
|
2844
|
+
*/
|
|
2845
|
+
conclusion: "APPROVE" | "REQUEST_CHANGES";
|
|
2846
|
+
}[];
|
|
2847
|
+
};
|
|
2848
|
+
};
|
|
2849
|
+
};
|
|
2850
|
+
responses: {
|
|
2851
|
+
/** @description Review submitted successfully — returns the review */200: {
|
|
2852
|
+
headers: {
|
|
2853
|
+
[name: string]: unknown;
|
|
2854
|
+
};
|
|
2855
|
+
content: {
|
|
2856
|
+
"application/json": components["schemas"]["BuildReview"];
|
|
2857
|
+
};
|
|
2858
|
+
}; /** @description Invalid parameters */
|
|
2859
|
+
400: {
|
|
2860
|
+
headers: {
|
|
2861
|
+
[name: string]: unknown;
|
|
2862
|
+
};
|
|
2863
|
+
content: {
|
|
2864
|
+
"application/json": components["schemas"]["Error"];
|
|
2865
|
+
};
|
|
2866
|
+
}; /** @description Unauthorized */
|
|
2867
|
+
401: {
|
|
2868
|
+
headers: {
|
|
2869
|
+
[name: string]: unknown;
|
|
2870
|
+
};
|
|
2871
|
+
content: {
|
|
2872
|
+
"application/json": components["schemas"]["Error"];
|
|
2873
|
+
};
|
|
2874
|
+
}; /** @description Forbidden */
|
|
2875
|
+
403: {
|
|
2876
|
+
headers: {
|
|
2877
|
+
[name: string]: unknown;
|
|
2878
|
+
};
|
|
2879
|
+
content: {
|
|
2880
|
+
"application/json": components["schemas"]["Error"];
|
|
2881
|
+
};
|
|
2882
|
+
}; /** @description Not found */
|
|
2883
|
+
404: {
|
|
2884
|
+
headers: {
|
|
2885
|
+
[name: string]: unknown;
|
|
2886
|
+
};
|
|
2887
|
+
content: {
|
|
2888
|
+
"application/json": components["schemas"]["Error"];
|
|
2889
|
+
};
|
|
2890
|
+
}; /** @description Server error */
|
|
2891
|
+
500: {
|
|
2892
|
+
headers: {
|
|
2893
|
+
[name: string]: unknown;
|
|
2894
|
+
};
|
|
2895
|
+
content: {
|
|
2896
|
+
"application/json": components["schemas"]["Error"];
|
|
2897
|
+
};
|
|
2898
|
+
};
|
|
2899
|
+
};
|
|
2900
|
+
};
|
|
2901
|
+
dismissReview: {
|
|
2902
|
+
parameters: {
|
|
2903
|
+
query?: never;
|
|
2904
|
+
header?: never;
|
|
2905
|
+
path: {
|
|
2906
|
+
owner: string;
|
|
2907
|
+
project: string; /** @description The build number */
|
|
2908
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the review */
|
|
2909
|
+
reviewId: string;
|
|
2910
|
+
};
|
|
2911
|
+
cookie?: never;
|
|
2912
|
+
};
|
|
2913
|
+
requestBody?: never;
|
|
2914
|
+
responses: {
|
|
2915
|
+
/** @description Review dismissed successfully — returns the review */200: {
|
|
2916
|
+
headers: {
|
|
2917
|
+
[name: string]: unknown;
|
|
2918
|
+
};
|
|
2919
|
+
content: {
|
|
2920
|
+
"application/json": components["schemas"]["BuildReview"];
|
|
2921
|
+
};
|
|
2922
|
+
}; /** @description Invalid parameters */
|
|
2923
|
+
400: {
|
|
2924
|
+
headers: {
|
|
2925
|
+
[name: string]: unknown;
|
|
2926
|
+
};
|
|
2927
|
+
content: {
|
|
2928
|
+
"application/json": components["schemas"]["Error"];
|
|
2929
|
+
};
|
|
2930
|
+
}; /** @description Unauthorized */
|
|
2931
|
+
401: {
|
|
2932
|
+
headers: {
|
|
2933
|
+
[name: string]: unknown;
|
|
2934
|
+
};
|
|
2935
|
+
content: {
|
|
2936
|
+
"application/json": components["schemas"]["Error"];
|
|
2937
|
+
};
|
|
2938
|
+
}; /** @description Forbidden */
|
|
2939
|
+
403: {
|
|
2940
|
+
headers: {
|
|
2941
|
+
[name: string]: unknown;
|
|
2942
|
+
};
|
|
2943
|
+
content: {
|
|
2944
|
+
"application/json": components["schemas"]["Error"];
|
|
2945
|
+
};
|
|
2946
|
+
}; /** @description Not found */
|
|
2947
|
+
404: {
|
|
2948
|
+
headers: {
|
|
2949
|
+
[name: string]: unknown;
|
|
2950
|
+
};
|
|
2951
|
+
content: {
|
|
2952
|
+
"application/json": components["schemas"]["Error"];
|
|
2953
|
+
};
|
|
2954
|
+
}; /** @description Server error */
|
|
2955
|
+
500: {
|
|
2956
|
+
headers: {
|
|
2957
|
+
[name: string]: unknown;
|
|
2958
|
+
};
|
|
2959
|
+
content: {
|
|
2960
|
+
"application/json": components["schemas"]["Error"];
|
|
2961
|
+
};
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
};
|
|
2965
|
+
listBuildComments: {
|
|
2966
|
+
parameters: {
|
|
2967
|
+
query?: never;
|
|
2968
|
+
header?: never;
|
|
2969
|
+
path: {
|
|
2970
|
+
owner: string;
|
|
2971
|
+
project: string; /** @description The build number */
|
|
2972
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
2973
|
+
};
|
|
2974
|
+
cookie?: never;
|
|
2975
|
+
};
|
|
2976
|
+
requestBody?: never;
|
|
2977
|
+
responses: {
|
|
2978
|
+
/** @description Comments, oldest first. Replies carry a threadId pointing at their root comment. */200: {
|
|
2979
|
+
headers: {
|
|
2980
|
+
[name: string]: unknown;
|
|
2981
|
+
};
|
|
2982
|
+
content: {
|
|
2983
|
+
"application/json": components["schemas"]["Comment"][];
|
|
2984
|
+
};
|
|
2985
|
+
}; /** @description Invalid parameters */
|
|
2986
|
+
400: {
|
|
2987
|
+
headers: {
|
|
2988
|
+
[name: string]: unknown;
|
|
2989
|
+
};
|
|
2990
|
+
content: {
|
|
2991
|
+
"application/json": components["schemas"]["Error"];
|
|
2992
|
+
};
|
|
2993
|
+
}; /** @description Unauthorized */
|
|
2994
|
+
401: {
|
|
2995
|
+
headers: {
|
|
2996
|
+
[name: string]: unknown;
|
|
2997
|
+
};
|
|
2998
|
+
content: {
|
|
2999
|
+
"application/json": components["schemas"]["Error"];
|
|
3000
|
+
};
|
|
3001
|
+
}; /** @description Forbidden */
|
|
3002
|
+
403: {
|
|
3003
|
+
headers: {
|
|
3004
|
+
[name: string]: unknown;
|
|
3005
|
+
};
|
|
3006
|
+
content: {
|
|
3007
|
+
"application/json": components["schemas"]["Error"];
|
|
3008
|
+
};
|
|
3009
|
+
}; /** @description Not found */
|
|
3010
|
+
404: {
|
|
3011
|
+
headers: {
|
|
3012
|
+
[name: string]: unknown;
|
|
3013
|
+
};
|
|
3014
|
+
content: {
|
|
3015
|
+
"application/json": components["schemas"]["Error"];
|
|
3016
|
+
};
|
|
3017
|
+
}; /** @description Server error */
|
|
3018
|
+
500: {
|
|
3019
|
+
headers: {
|
|
3020
|
+
[name: string]: unknown;
|
|
3021
|
+
};
|
|
3022
|
+
content: {
|
|
3023
|
+
"application/json": components["schemas"]["Error"];
|
|
3024
|
+
};
|
|
3025
|
+
};
|
|
3026
|
+
};
|
|
3027
|
+
};
|
|
3028
|
+
createBuildComment: {
|
|
3029
|
+
parameters: {
|
|
3030
|
+
query?: never;
|
|
3031
|
+
header?: never;
|
|
3032
|
+
path: {
|
|
3033
|
+
owner: string;
|
|
3034
|
+
project: string; /** @description The build number */
|
|
3035
|
+
buildNumber: components["schemas"]["BuildNumber"];
|
|
3036
|
+
};
|
|
3037
|
+
cookie?: never;
|
|
3038
|
+
};
|
|
3039
|
+
requestBody: {
|
|
3040
|
+
content: {
|
|
3041
|
+
"application/json": {
|
|
3042
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
3043
|
+
[key: string]: unknown;
|
|
3044
|
+
}; /** @description Root comment ID to reply to. */
|
|
3045
|
+
threadId?: string; /** @description Screenshot diff to anchor the comment to. Required when anchor is set. */
|
|
3046
|
+
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. */
|
|
3047
|
+
anchor?: {
|
|
3048
|
+
/** @constant */type: "point";
|
|
3049
|
+
x: number;
|
|
3050
|
+
y: number;
|
|
3051
|
+
} | {
|
|
3052
|
+
/** @constant */type: "lines";
|
|
3053
|
+
from: number;
|
|
3054
|
+
to: number;
|
|
3055
|
+
}; /** @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. */
|
|
3056
|
+
addToReview?: boolean;
|
|
3057
|
+
};
|
|
3058
|
+
};
|
|
3059
|
+
};
|
|
3060
|
+
responses: {
|
|
3061
|
+
/** @description Comment created successfully — returns the comment */201: {
|
|
3062
|
+
headers: {
|
|
3063
|
+
[name: string]: unknown;
|
|
3064
|
+
};
|
|
3065
|
+
content: {
|
|
3066
|
+
"application/json": components["schemas"]["Comment"];
|
|
3067
|
+
};
|
|
3068
|
+
}; /** @description Invalid parameters */
|
|
3069
|
+
400: {
|
|
3070
|
+
headers: {
|
|
3071
|
+
[name: string]: unknown;
|
|
3072
|
+
};
|
|
3073
|
+
content: {
|
|
3074
|
+
"application/json": components["schemas"]["Error"];
|
|
3075
|
+
};
|
|
3076
|
+
}; /** @description Unauthorized */
|
|
3077
|
+
401: {
|
|
3078
|
+
headers: {
|
|
3079
|
+
[name: string]: unknown;
|
|
3080
|
+
};
|
|
3081
|
+
content: {
|
|
3082
|
+
"application/json": components["schemas"]["Error"];
|
|
3083
|
+
};
|
|
3084
|
+
}; /** @description Forbidden */
|
|
3085
|
+
403: {
|
|
3086
|
+
headers: {
|
|
3087
|
+
[name: string]: unknown;
|
|
3088
|
+
};
|
|
3089
|
+
content: {
|
|
3090
|
+
"application/json": components["schemas"]["Error"];
|
|
3091
|
+
};
|
|
3092
|
+
}; /** @description Not found */
|
|
3093
|
+
404: {
|
|
3094
|
+
headers: {
|
|
3095
|
+
[name: string]: unknown;
|
|
3096
|
+
};
|
|
3097
|
+
content: {
|
|
3098
|
+
"application/json": components["schemas"]["Error"];
|
|
3099
|
+
};
|
|
3100
|
+
}; /** @description Server error */
|
|
3101
|
+
500: {
|
|
3102
|
+
headers: {
|
|
3103
|
+
[name: string]: unknown;
|
|
3104
|
+
};
|
|
3105
|
+
content: {
|
|
3106
|
+
"application/json": components["schemas"]["Error"];
|
|
3107
|
+
};
|
|
3108
|
+
};
|
|
3109
|
+
};
|
|
3110
|
+
};
|
|
3111
|
+
getBuildComment: {
|
|
3112
|
+
parameters: {
|
|
3113
|
+
query?: never;
|
|
3114
|
+
header?: never;
|
|
3115
|
+
path: {
|
|
3116
|
+
owner: string;
|
|
3117
|
+
project: string; /** @description The build number */
|
|
3118
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3119
|
+
commentId: components["schemas"]["CommentId"];
|
|
3120
|
+
};
|
|
3121
|
+
cookie?: never;
|
|
3122
|
+
};
|
|
3123
|
+
requestBody?: never;
|
|
3124
|
+
responses: {
|
|
3125
|
+
/** @description Comment */200: {
|
|
3126
|
+
headers: {
|
|
3127
|
+
[name: string]: unknown;
|
|
3128
|
+
};
|
|
3129
|
+
content: {
|
|
3130
|
+
"application/json": components["schemas"]["Comment"];
|
|
3131
|
+
};
|
|
3132
|
+
}; /** @description Invalid parameters */
|
|
3133
|
+
400: {
|
|
3134
|
+
headers: {
|
|
3135
|
+
[name: string]: unknown;
|
|
3136
|
+
};
|
|
3137
|
+
content: {
|
|
3138
|
+
"application/json": components["schemas"]["Error"];
|
|
3139
|
+
};
|
|
3140
|
+
}; /** @description Unauthorized */
|
|
3141
|
+
401: {
|
|
3142
|
+
headers: {
|
|
3143
|
+
[name: string]: unknown;
|
|
3144
|
+
};
|
|
3145
|
+
content: {
|
|
3146
|
+
"application/json": components["schemas"]["Error"];
|
|
3147
|
+
};
|
|
3148
|
+
}; /** @description Forbidden */
|
|
3149
|
+
403: {
|
|
3150
|
+
headers: {
|
|
3151
|
+
[name: string]: unknown;
|
|
3152
|
+
};
|
|
3153
|
+
content: {
|
|
3154
|
+
"application/json": components["schemas"]["Error"];
|
|
3155
|
+
};
|
|
3156
|
+
}; /** @description Not found */
|
|
3157
|
+
404: {
|
|
1950
3158
|
headers: {
|
|
1951
3159
|
[name: string]: unknown;
|
|
1952
3160
|
};
|
|
@@ -1964,28 +3172,26 @@ interface operations {
|
|
|
1964
3172
|
};
|
|
1965
3173
|
};
|
|
1966
3174
|
};
|
|
1967
|
-
|
|
3175
|
+
deleteBuildComment: {
|
|
1968
3176
|
parameters: {
|
|
1969
3177
|
query?: never;
|
|
1970
3178
|
header?: never;
|
|
1971
|
-
path
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
"application/json": {
|
|
1977
|
-
/** @description Name of the project to create. Must be unique within the account (case-insensitive) and cannot be a reserved name. */name: string; /** @description Slug of the account (personal or team) that will own the project. The personal access token must be scoped to this account and the acting user must be one of its administrators. */
|
|
1978
|
-
accountSlug: string;
|
|
1979
|
-
};
|
|
3179
|
+
path: {
|
|
3180
|
+
owner: string;
|
|
3181
|
+
project: string; /** @description The build number */
|
|
3182
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3183
|
+
commentId: components["schemas"]["CommentId"];
|
|
1980
3184
|
};
|
|
3185
|
+
cookie?: never;
|
|
1981
3186
|
};
|
|
3187
|
+
requestBody?: never;
|
|
1982
3188
|
responses: {
|
|
1983
|
-
/** @description
|
|
3189
|
+
/** @description Comment deleted successfully — returns the comment */200: {
|
|
1984
3190
|
headers: {
|
|
1985
3191
|
[name: string]: unknown;
|
|
1986
3192
|
};
|
|
1987
3193
|
content: {
|
|
1988
|
-
"application/json": components["schemas"]["
|
|
3194
|
+
"application/json": components["schemas"]["Comment"];
|
|
1989
3195
|
};
|
|
1990
3196
|
}; /** @description Invalid parameters */
|
|
1991
3197
|
400: {
|
|
@@ -2011,6 +3217,14 @@ interface operations {
|
|
|
2011
3217
|
content: {
|
|
2012
3218
|
"application/json": components["schemas"]["Error"];
|
|
2013
3219
|
};
|
|
3220
|
+
}; /** @description Not found */
|
|
3221
|
+
404: {
|
|
3222
|
+
headers: {
|
|
3223
|
+
[name: string]: unknown;
|
|
3224
|
+
};
|
|
3225
|
+
content: {
|
|
3226
|
+
"application/json": components["schemas"]["Error"];
|
|
3227
|
+
};
|
|
2014
3228
|
}; /** @description Server error */
|
|
2015
3229
|
500: {
|
|
2016
3230
|
headers: {
|
|
@@ -2022,24 +3236,42 @@ interface operations {
|
|
|
2022
3236
|
};
|
|
2023
3237
|
};
|
|
2024
3238
|
};
|
|
2025
|
-
|
|
3239
|
+
updateBuildComment: {
|
|
2026
3240
|
parameters: {
|
|
2027
3241
|
query?: never;
|
|
2028
3242
|
header?: never;
|
|
2029
3243
|
path: {
|
|
2030
3244
|
owner: string;
|
|
2031
|
-
project: string;
|
|
3245
|
+
project: string; /** @description The build number */
|
|
3246
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3247
|
+
commentId: components["schemas"]["CommentId"];
|
|
2032
3248
|
};
|
|
2033
3249
|
cookie?: never;
|
|
2034
3250
|
};
|
|
2035
|
-
requestBody
|
|
3251
|
+
requestBody: {
|
|
3252
|
+
content: {
|
|
3253
|
+
"application/json": {
|
|
3254
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
3255
|
+
[key: string]: unknown;
|
|
3256
|
+
};
|
|
3257
|
+
};
|
|
3258
|
+
};
|
|
3259
|
+
};
|
|
2036
3260
|
responses: {
|
|
2037
|
-
/** @description
|
|
3261
|
+
/** @description Comment updated successfully — returns the comment */200: {
|
|
2038
3262
|
headers: {
|
|
2039
3263
|
[name: string]: unknown;
|
|
2040
3264
|
};
|
|
2041
3265
|
content: {
|
|
2042
|
-
"application/json": components["schemas"]["
|
|
3266
|
+
"application/json": components["schemas"]["Comment"];
|
|
3267
|
+
};
|
|
3268
|
+
}; /** @description Invalid parameters */
|
|
3269
|
+
400: {
|
|
3270
|
+
headers: {
|
|
3271
|
+
[name: string]: unknown;
|
|
3272
|
+
};
|
|
3273
|
+
content: {
|
|
3274
|
+
"application/json": components["schemas"]["Error"];
|
|
2043
3275
|
};
|
|
2044
3276
|
}; /** @description Unauthorized */
|
|
2045
3277
|
401: {
|
|
@@ -2076,33 +3308,32 @@ interface operations {
|
|
|
2076
3308
|
};
|
|
2077
3309
|
};
|
|
2078
3310
|
};
|
|
2079
|
-
|
|
3311
|
+
addBuildCommentReaction: {
|
|
2080
3312
|
parameters: {
|
|
2081
|
-
query?:
|
|
2082
|
-
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2083
|
-
page?: string;
|
|
2084
|
-
head?: string;
|
|
2085
|
-
headSha?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
|
|
2086
|
-
distinctName?: string;
|
|
2087
|
-
};
|
|
3313
|
+
query?: never;
|
|
2088
3314
|
header?: never;
|
|
2089
3315
|
path: {
|
|
2090
3316
|
owner: string;
|
|
2091
|
-
project: string;
|
|
3317
|
+
project: string; /** @description The build number */
|
|
3318
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3319
|
+
commentId: components["schemas"]["CommentId"];
|
|
2092
3320
|
};
|
|
2093
3321
|
cookie?: never;
|
|
2094
3322
|
};
|
|
2095
|
-
requestBody
|
|
3323
|
+
requestBody: {
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": {
|
|
3326
|
+
/** @description The emoji to react with. */emoji: string;
|
|
3327
|
+
};
|
|
3328
|
+
};
|
|
3329
|
+
};
|
|
2096
3330
|
responses: {
|
|
2097
|
-
/** @description
|
|
3331
|
+
/** @description Reaction added — returns the comment */200: {
|
|
2098
3332
|
headers: {
|
|
2099
3333
|
[name: string]: unknown;
|
|
2100
3334
|
};
|
|
2101
3335
|
content: {
|
|
2102
|
-
"application/json":
|
|
2103
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
2104
|
-
results: components["schemas"]["Build"][];
|
|
2105
|
-
};
|
|
3336
|
+
"application/json": components["schemas"]["Comment"];
|
|
2106
3337
|
};
|
|
2107
3338
|
}; /** @description Invalid parameters */
|
|
2108
3339
|
400: {
|
|
@@ -2147,25 +3378,28 @@ interface operations {
|
|
|
2147
3378
|
};
|
|
2148
3379
|
};
|
|
2149
3380
|
};
|
|
2150
|
-
|
|
3381
|
+
removeBuildCommentReaction: {
|
|
2151
3382
|
parameters: {
|
|
2152
|
-
query
|
|
3383
|
+
query: {
|
|
3384
|
+
/** @description The emoji reaction to remove. */emoji: string;
|
|
3385
|
+
};
|
|
2153
3386
|
header?: never;
|
|
2154
3387
|
path: {
|
|
2155
3388
|
owner: string;
|
|
2156
3389
|
project: string; /** @description The build number */
|
|
2157
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3390
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3391
|
+
commentId: components["schemas"]["CommentId"];
|
|
2158
3392
|
};
|
|
2159
3393
|
cookie?: never;
|
|
2160
3394
|
};
|
|
2161
3395
|
requestBody?: never;
|
|
2162
3396
|
responses: {
|
|
2163
|
-
/** @description
|
|
3397
|
+
/** @description Reaction removed — returns the comment */200: {
|
|
2164
3398
|
headers: {
|
|
2165
3399
|
[name: string]: unknown;
|
|
2166
3400
|
};
|
|
2167
3401
|
content: {
|
|
2168
|
-
"application/json": components["schemas"]["
|
|
3402
|
+
"application/json": components["schemas"]["Comment"];
|
|
2169
3403
|
};
|
|
2170
3404
|
}; /** @description Invalid parameters */
|
|
2171
3405
|
400: {
|
|
@@ -2210,33 +3444,26 @@ interface operations {
|
|
|
2210
3444
|
};
|
|
2211
3445
|
};
|
|
2212
3446
|
};
|
|
2213
|
-
|
|
3447
|
+
resolveBuildCommentThread: {
|
|
2214
3448
|
parameters: {
|
|
2215
|
-
query?:
|
|
2216
|
-
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2217
|
-
page?: string; /** @description Only return diffs that require review. Matches `changed`, `added`, and `removed`, except `removed` is excluded for subset builds. */
|
|
2218
|
-
needsReview?: string; /** @description Period over which the test flakiness metrics are computed. */
|
|
2219
|
-
metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2220
|
-
};
|
|
3449
|
+
query?: never;
|
|
2221
3450
|
header?: never;
|
|
2222
3451
|
path: {
|
|
2223
3452
|
owner: string;
|
|
2224
3453
|
project: string; /** @description The build number */
|
|
2225
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3454
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3455
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2226
3456
|
};
|
|
2227
3457
|
cookie?: never;
|
|
2228
3458
|
};
|
|
2229
3459
|
requestBody?: never;
|
|
2230
3460
|
responses: {
|
|
2231
|
-
/** @description
|
|
3461
|
+
/** @description Thread resolved — returns the root comment */200: {
|
|
2232
3462
|
headers: {
|
|
2233
3463
|
[name: string]: unknown;
|
|
2234
3464
|
};
|
|
2235
3465
|
content: {
|
|
2236
|
-
"application/json":
|
|
2237
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
2238
|
-
results: components["schemas"]["SnapshotDiff"][];
|
|
2239
|
-
};
|
|
3466
|
+
"application/json": components["schemas"]["Comment"];
|
|
2240
3467
|
};
|
|
2241
3468
|
}; /** @description Invalid parameters */
|
|
2242
3469
|
400: {
|
|
@@ -2254,6 +3481,14 @@ interface operations {
|
|
|
2254
3481
|
content: {
|
|
2255
3482
|
"application/json": components["schemas"]["Error"];
|
|
2256
3483
|
};
|
|
3484
|
+
}; /** @description Forbidden */
|
|
3485
|
+
403: {
|
|
3486
|
+
headers: {
|
|
3487
|
+
[name: string]: unknown;
|
|
3488
|
+
};
|
|
3489
|
+
content: {
|
|
3490
|
+
"application/json": components["schemas"]["Error"];
|
|
3491
|
+
};
|
|
2257
3492
|
}; /** @description Not found */
|
|
2258
3493
|
404: {
|
|
2259
3494
|
headers: {
|
|
@@ -2273,27 +3508,26 @@ interface operations {
|
|
|
2273
3508
|
};
|
|
2274
3509
|
};
|
|
2275
3510
|
};
|
|
2276
|
-
|
|
3511
|
+
unresolveBuildCommentThread: {
|
|
2277
3512
|
parameters: {
|
|
2278
|
-
query?:
|
|
2279
|
-
/** @description Period over which the test flakiness metrics are computed. */metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2280
|
-
};
|
|
3513
|
+
query?: never;
|
|
2281
3514
|
header?: never;
|
|
2282
3515
|
path: {
|
|
2283
3516
|
owner: string;
|
|
2284
|
-
project: string; /** @description
|
|
2285
|
-
|
|
3517
|
+
project: string; /** @description The build number */
|
|
3518
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3519
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2286
3520
|
};
|
|
2287
3521
|
cookie?: never;
|
|
2288
3522
|
};
|
|
2289
3523
|
requestBody?: never;
|
|
2290
3524
|
responses: {
|
|
2291
|
-
/** @description
|
|
3525
|
+
/** @description Thread reopened — returns the root comment */200: {
|
|
2292
3526
|
headers: {
|
|
2293
3527
|
[name: string]: unknown;
|
|
2294
3528
|
};
|
|
2295
3529
|
content: {
|
|
2296
|
-
"application/json": components["schemas"]["
|
|
3530
|
+
"application/json": components["schemas"]["Comment"];
|
|
2297
3531
|
};
|
|
2298
3532
|
}; /** @description Invalid parameters */
|
|
2299
3533
|
400: {
|
|
@@ -2338,27 +3572,26 @@ interface operations {
|
|
|
2338
3572
|
};
|
|
2339
3573
|
};
|
|
2340
3574
|
};
|
|
2341
|
-
|
|
3575
|
+
subscribeBuildCommentThread: {
|
|
2342
3576
|
parameters: {
|
|
2343
|
-
query?:
|
|
2344
|
-
/** @description Period over which the test flakiness metrics are computed. */metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2345
|
-
};
|
|
3577
|
+
query?: never;
|
|
2346
3578
|
header?: never;
|
|
2347
3579
|
path: {
|
|
2348
3580
|
owner: string;
|
|
2349
|
-
project: string; /** @description
|
|
2350
|
-
|
|
3581
|
+
project: string; /** @description The build number */
|
|
3582
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3583
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2351
3584
|
};
|
|
2352
3585
|
cookie?: never;
|
|
2353
3586
|
};
|
|
2354
3587
|
requestBody?: never;
|
|
2355
3588
|
responses: {
|
|
2356
|
-
/** @description
|
|
3589
|
+
/** @description Subscribed — returns the root comment */200: {
|
|
2357
3590
|
headers: {
|
|
2358
3591
|
[name: string]: unknown;
|
|
2359
3592
|
};
|
|
2360
3593
|
content: {
|
|
2361
|
-
"application/json": components["schemas"]["
|
|
3594
|
+
"application/json": components["schemas"]["Comment"];
|
|
2362
3595
|
};
|
|
2363
3596
|
}; /** @description Invalid parameters */
|
|
2364
3597
|
400: {
|
|
@@ -2403,25 +3636,26 @@ interface operations {
|
|
|
2403
3636
|
};
|
|
2404
3637
|
};
|
|
2405
3638
|
};
|
|
2406
|
-
|
|
3639
|
+
unsubscribeBuildCommentThread: {
|
|
2407
3640
|
parameters: {
|
|
2408
3641
|
query?: never;
|
|
2409
3642
|
header?: never;
|
|
2410
3643
|
path: {
|
|
2411
3644
|
owner: string;
|
|
2412
3645
|
project: string; /** @description The build number */
|
|
2413
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3646
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3647
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2414
3648
|
};
|
|
2415
3649
|
cookie?: never;
|
|
2416
3650
|
};
|
|
2417
3651
|
requestBody?: never;
|
|
2418
3652
|
responses: {
|
|
2419
|
-
/** @description
|
|
3653
|
+
/** @description Unsubscribed — returns the root comment */200: {
|
|
2420
3654
|
headers: {
|
|
2421
3655
|
[name: string]: unknown;
|
|
2422
3656
|
};
|
|
2423
3657
|
content: {
|
|
2424
|
-
"application/json": components["schemas"]["
|
|
3658
|
+
"application/json": components["schemas"]["Comment"];
|
|
2425
3659
|
};
|
|
2426
3660
|
}; /** @description Invalid parameters */
|
|
2427
3661
|
400: {
|
|
@@ -2466,54 +3700,27 @@ interface operations {
|
|
|
2466
3700
|
};
|
|
2467
3701
|
};
|
|
2468
3702
|
};
|
|
2469
|
-
|
|
3703
|
+
getTest: {
|
|
2470
3704
|
parameters: {
|
|
2471
|
-
query?:
|
|
3705
|
+
query?: {
|
|
3706
|
+
/** @description Period over which the test flakiness metrics are computed. */metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
3707
|
+
};
|
|
2472
3708
|
header?: never;
|
|
2473
3709
|
path: {
|
|
2474
3710
|
owner: string;
|
|
2475
|
-
project: string; /** @description The
|
|
2476
|
-
|
|
3711
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3712
|
+
testId: components["schemas"]["TestId"];
|
|
2477
3713
|
};
|
|
2478
3714
|
cookie?: never;
|
|
2479
3715
|
};
|
|
2480
|
-
requestBody
|
|
2481
|
-
content: {
|
|
2482
|
-
"application/json": {
|
|
2483
|
-
/**
|
|
2484
|
-
* @description Review event to apply to the build: "APPROVE", "REJECT" or "COMMENT". Required when `conclusion` is not provided.
|
|
2485
|
-
* @enum {string}
|
|
2486
|
-
*/
|
|
2487
|
-
event?: "APPROVE" | "REJECT" | "COMMENT";
|
|
2488
|
-
/**
|
|
2489
|
-
* @deprecated
|
|
2490
|
-
* @description Deprecated: use `event` instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".
|
|
2491
|
-
* @enum {string}
|
|
2492
|
-
*/
|
|
2493
|
-
conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document. */
|
|
2494
|
-
body?: unknown;
|
|
2495
|
-
/**
|
|
2496
|
-
* @description Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.
|
|
2497
|
-
* @default []
|
|
2498
|
-
*/
|
|
2499
|
-
snapshots?: {
|
|
2500
|
-
/** @description The ID of the snapshot to review */id: string;
|
|
2501
|
-
/**
|
|
2502
|
-
* @description Review conclusion for this individual snapshot: "APPROVE" or "REQUEST_CHANGES"
|
|
2503
|
-
* @enum {string}
|
|
2504
|
-
*/
|
|
2505
|
-
conclusion: "APPROVE" | "REQUEST_CHANGES";
|
|
2506
|
-
}[];
|
|
2507
|
-
};
|
|
2508
|
-
};
|
|
2509
|
-
};
|
|
3716
|
+
requestBody?: never;
|
|
2510
3717
|
responses: {
|
|
2511
|
-
/** @description
|
|
3718
|
+
/** @description The test and its flakiness metrics */200: {
|
|
2512
3719
|
headers: {
|
|
2513
3720
|
[name: string]: unknown;
|
|
2514
3721
|
};
|
|
2515
3722
|
content: {
|
|
2516
|
-
"application/json": components["schemas"]["
|
|
3723
|
+
"application/json": components["schemas"]["TestDetails"];
|
|
2517
3724
|
};
|
|
2518
3725
|
}; /** @description Invalid parameters */
|
|
2519
3726
|
400: {
|
|
@@ -2531,14 +3738,6 @@ interface operations {
|
|
|
2531
3738
|
content: {
|
|
2532
3739
|
"application/json": components["schemas"]["Error"];
|
|
2533
3740
|
};
|
|
2534
|
-
}; /** @description Forbidden */
|
|
2535
|
-
403: {
|
|
2536
|
-
headers: {
|
|
2537
|
-
[name: string]: unknown;
|
|
2538
|
-
};
|
|
2539
|
-
content: {
|
|
2540
|
-
"application/json": components["schemas"]["Error"];
|
|
2541
|
-
};
|
|
2542
3741
|
}; /** @description Not found */
|
|
2543
3742
|
404: {
|
|
2544
3743
|
headers: {
|
|
@@ -2558,26 +3757,33 @@ interface operations {
|
|
|
2558
3757
|
};
|
|
2559
3758
|
};
|
|
2560
3759
|
};
|
|
2561
|
-
|
|
3760
|
+
listTestChanges: {
|
|
2562
3761
|
parameters: {
|
|
2563
|
-
query?:
|
|
3762
|
+
query?: {
|
|
3763
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
3764
|
+
page?: string; /** @description Period over which the test flakiness metrics are computed. */
|
|
3765
|
+
metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS"; /** @description Restrict the changes to the ones currently ignored (`true`) or to the ones still under review (`false`). Omit it to get both. */
|
|
3766
|
+
ignored?: "true" | "false";
|
|
3767
|
+
};
|
|
2564
3768
|
header?: never;
|
|
2565
3769
|
path: {
|
|
2566
3770
|
owner: string;
|
|
2567
|
-
project: string; /** @description The
|
|
2568
|
-
|
|
2569
|
-
reviewId: string;
|
|
3771
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3772
|
+
testId: components["schemas"]["TestId"];
|
|
2570
3773
|
};
|
|
2571
3774
|
cookie?: never;
|
|
2572
3775
|
};
|
|
2573
3776
|
requestBody?: never;
|
|
2574
3777
|
responses: {
|
|
2575
|
-
/** @description
|
|
3778
|
+
/** @description List of the test's changes */200: {
|
|
2576
3779
|
headers: {
|
|
2577
3780
|
[name: string]: unknown;
|
|
2578
3781
|
};
|
|
2579
3782
|
content: {
|
|
2580
|
-
"application/json":
|
|
3783
|
+
"application/json": {
|
|
3784
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
3785
|
+
results: components["schemas"]["TestChange"][];
|
|
3786
|
+
};
|
|
2581
3787
|
};
|
|
2582
3788
|
}; /** @description Invalid parameters */
|
|
2583
3789
|
400: {
|
|
@@ -2595,14 +3801,6 @@ interface operations {
|
|
|
2595
3801
|
content: {
|
|
2596
3802
|
"application/json": components["schemas"]["Error"];
|
|
2597
3803
|
};
|
|
2598
|
-
}; /** @description Forbidden */
|
|
2599
|
-
403: {
|
|
2600
|
-
headers: {
|
|
2601
|
-
[name: string]: unknown;
|
|
2602
|
-
};
|
|
2603
|
-
content: {
|
|
2604
|
-
"application/json": components["schemas"]["Error"];
|
|
2605
|
-
};
|
|
2606
3804
|
}; /** @description Not found */
|
|
2607
3805
|
404: {
|
|
2608
3806
|
headers: {
|
|
@@ -2622,20 +3820,20 @@ interface operations {
|
|
|
2622
3820
|
};
|
|
2623
3821
|
};
|
|
2624
3822
|
};
|
|
2625
|
-
|
|
3823
|
+
listTestComments: {
|
|
2626
3824
|
parameters: {
|
|
2627
3825
|
query?: never;
|
|
2628
3826
|
header?: never;
|
|
2629
3827
|
path: {
|
|
2630
3828
|
owner: string;
|
|
2631
|
-
project: string; /** @description The
|
|
2632
|
-
|
|
3829
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3830
|
+
testId: components["schemas"]["TestId"];
|
|
2633
3831
|
};
|
|
2634
3832
|
cookie?: never;
|
|
2635
3833
|
};
|
|
2636
3834
|
requestBody?: never;
|
|
2637
3835
|
responses: {
|
|
2638
|
-
/** @description
|
|
3836
|
+
/** @description Comments, oldest first. Replies carry a threadId pointing at their root comment. */200: {
|
|
2639
3837
|
headers: {
|
|
2640
3838
|
[name: string]: unknown;
|
|
2641
3839
|
};
|
|
@@ -2685,14 +3883,14 @@ interface operations {
|
|
|
2685
3883
|
};
|
|
2686
3884
|
};
|
|
2687
3885
|
};
|
|
2688
|
-
|
|
3886
|
+
createTestComment: {
|
|
2689
3887
|
parameters: {
|
|
2690
3888
|
query?: never;
|
|
2691
3889
|
header?: never;
|
|
2692
3890
|
path: {
|
|
2693
3891
|
owner: string;
|
|
2694
|
-
project: string; /** @description The
|
|
2695
|
-
|
|
3892
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3893
|
+
testId: components["schemas"]["TestId"];
|
|
2696
3894
|
};
|
|
2697
3895
|
cookie?: never;
|
|
2698
3896
|
};
|
|
@@ -2702,18 +3900,7 @@ interface operations {
|
|
|
2702
3900
|
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
2703
3901
|
[key: string]: unknown;
|
|
2704
3902
|
}; /** @description Root comment ID to reply to. */
|
|
2705
|
-
threadId?: string;
|
|
2706
|
-
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. */
|
|
2707
|
-
anchor?: {
|
|
2708
|
-
/** @constant */type: "point";
|
|
2709
|
-
x: number;
|
|
2710
|
-
y: number;
|
|
2711
|
-
} | {
|
|
2712
|
-
/** @constant */type: "lines";
|
|
2713
|
-
from: number;
|
|
2714
|
-
to: number;
|
|
2715
|
-
}; /** @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. */
|
|
2716
|
-
addToReview?: boolean;
|
|
3903
|
+
threadId?: string;
|
|
2717
3904
|
};
|
|
2718
3905
|
};
|
|
2719
3906
|
};
|
|
@@ -2768,15 +3955,15 @@ interface operations {
|
|
|
2768
3955
|
};
|
|
2769
3956
|
};
|
|
2770
3957
|
};
|
|
2771
|
-
|
|
3958
|
+
getTestComment: {
|
|
2772
3959
|
parameters: {
|
|
2773
3960
|
query?: never;
|
|
2774
3961
|
header?: never;
|
|
2775
3962
|
path: {
|
|
2776
3963
|
owner: string;
|
|
2777
|
-
project: string; /** @description The
|
|
2778
|
-
|
|
2779
|
-
commentId:
|
|
3964
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3965
|
+
testId: components["schemas"]["TestId"]; /** @description The ID of the comment */
|
|
3966
|
+
commentId: components["schemas"]["CommentId"];
|
|
2780
3967
|
};
|
|
2781
3968
|
cookie?: never;
|
|
2782
3969
|
};
|
|
@@ -2832,15 +4019,15 @@ interface operations {
|
|
|
2832
4019
|
};
|
|
2833
4020
|
};
|
|
2834
4021
|
};
|
|
2835
|
-
|
|
4022
|
+
deleteTestComment: {
|
|
2836
4023
|
parameters: {
|
|
2837
4024
|
query?: never;
|
|
2838
4025
|
header?: never;
|
|
2839
4026
|
path: {
|
|
2840
4027
|
owner: string;
|
|
2841
|
-
project: string; /** @description The
|
|
2842
|
-
|
|
2843
|
-
commentId:
|
|
4028
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4029
|
+
testId: components["schemas"]["TestId"]; /** @description The ID of the comment */
|
|
4030
|
+
commentId: components["schemas"]["CommentId"];
|
|
2844
4031
|
};
|
|
2845
4032
|
cookie?: never;
|
|
2846
4033
|
};
|
|
@@ -2896,15 +4083,15 @@ interface operations {
|
|
|
2896
4083
|
};
|
|
2897
4084
|
};
|
|
2898
4085
|
};
|
|
2899
|
-
|
|
4086
|
+
updateTestComment: {
|
|
2900
4087
|
parameters: {
|
|
2901
4088
|
query?: never;
|
|
2902
4089
|
header?: never;
|
|
2903
4090
|
path: {
|
|
2904
4091
|
owner: string;
|
|
2905
|
-
project: string; /** @description The
|
|
2906
|
-
|
|
2907
|
-
commentId:
|
|
4092
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4093
|
+
testId: components["schemas"]["TestId"]; /** @description The ID of the comment */
|
|
4094
|
+
commentId: components["schemas"]["CommentId"];
|
|
2908
4095
|
};
|
|
2909
4096
|
cookie?: never;
|
|
2910
4097
|
};
|
|
@@ -2968,15 +4155,15 @@ interface operations {
|
|
|
2968
4155
|
};
|
|
2969
4156
|
};
|
|
2970
4157
|
};
|
|
2971
|
-
|
|
4158
|
+
addTestCommentReaction: {
|
|
2972
4159
|
parameters: {
|
|
2973
4160
|
query?: never;
|
|
2974
4161
|
header?: never;
|
|
2975
4162
|
path: {
|
|
2976
4163
|
owner: string;
|
|
2977
|
-
project: string; /** @description The
|
|
2978
|
-
|
|
2979
|
-
commentId:
|
|
4164
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4165
|
+
testId: components["schemas"]["TestId"]; /** @description The ID of the comment */
|
|
4166
|
+
commentId: components["schemas"]["CommentId"];
|
|
2980
4167
|
};
|
|
2981
4168
|
cookie?: never;
|
|
2982
4169
|
};
|
|
@@ -3038,7 +4225,7 @@ interface operations {
|
|
|
3038
4225
|
};
|
|
3039
4226
|
};
|
|
3040
4227
|
};
|
|
3041
|
-
|
|
4228
|
+
removeTestCommentReaction: {
|
|
3042
4229
|
parameters: {
|
|
3043
4230
|
query: {
|
|
3044
4231
|
/** @description The emoji reaction to remove. */emoji: string;
|
|
@@ -3046,9 +4233,9 @@ interface operations {
|
|
|
3046
4233
|
header?: never;
|
|
3047
4234
|
path: {
|
|
3048
4235
|
owner: string;
|
|
3049
|
-
project: string; /** @description The
|
|
3050
|
-
|
|
3051
|
-
commentId:
|
|
4236
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4237
|
+
testId: components["schemas"]["TestId"]; /** @description The ID of the comment */
|
|
4238
|
+
commentId: components["schemas"]["CommentId"];
|
|
3052
4239
|
};
|
|
3053
4240
|
cookie?: never;
|
|
3054
4241
|
};
|
|
@@ -3104,15 +4291,15 @@ interface operations {
|
|
|
3104
4291
|
};
|
|
3105
4292
|
};
|
|
3106
4293
|
};
|
|
3107
|
-
|
|
4294
|
+
resolveTestCommentThread: {
|
|
3108
4295
|
parameters: {
|
|
3109
4296
|
query?: never;
|
|
3110
4297
|
header?: never;
|
|
3111
4298
|
path: {
|
|
3112
4299
|
owner: string;
|
|
3113
|
-
project: string; /** @description The
|
|
3114
|
-
|
|
3115
|
-
commentId:
|
|
4300
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4301
|
+
testId: components["schemas"]["TestId"]; /** @description ID of any comment in the thread */
|
|
4302
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
3116
4303
|
};
|
|
3117
4304
|
cookie?: never;
|
|
3118
4305
|
};
|
|
@@ -3168,15 +4355,15 @@ interface operations {
|
|
|
3168
4355
|
};
|
|
3169
4356
|
};
|
|
3170
4357
|
};
|
|
3171
|
-
|
|
4358
|
+
unresolveTestCommentThread: {
|
|
3172
4359
|
parameters: {
|
|
3173
4360
|
query?: never;
|
|
3174
4361
|
header?: never;
|
|
3175
4362
|
path: {
|
|
3176
4363
|
owner: string;
|
|
3177
|
-
project: string; /** @description The
|
|
3178
|
-
|
|
3179
|
-
commentId:
|
|
4364
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4365
|
+
testId: components["schemas"]["TestId"]; /** @description ID of any comment in the thread */
|
|
4366
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
3180
4367
|
};
|
|
3181
4368
|
cookie?: never;
|
|
3182
4369
|
};
|
|
@@ -3232,15 +4419,15 @@ interface operations {
|
|
|
3232
4419
|
};
|
|
3233
4420
|
};
|
|
3234
4421
|
};
|
|
3235
|
-
|
|
4422
|
+
subscribeTestCommentThread: {
|
|
3236
4423
|
parameters: {
|
|
3237
4424
|
query?: never;
|
|
3238
4425
|
header?: never;
|
|
3239
4426
|
path: {
|
|
3240
4427
|
owner: string;
|
|
3241
|
-
project: string; /** @description The
|
|
3242
|
-
|
|
3243
|
-
commentId:
|
|
4428
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4429
|
+
testId: components["schemas"]["TestId"]; /** @description ID of any comment in the thread */
|
|
4430
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
3244
4431
|
};
|
|
3245
4432
|
cookie?: never;
|
|
3246
4433
|
};
|
|
@@ -3296,15 +4483,15 @@ interface operations {
|
|
|
3296
4483
|
};
|
|
3297
4484
|
};
|
|
3298
4485
|
};
|
|
3299
|
-
|
|
4486
|
+
unsubscribeTestCommentThread: {
|
|
3300
4487
|
parameters: {
|
|
3301
4488
|
query?: never;
|
|
3302
4489
|
header?: never;
|
|
3303
4490
|
path: {
|
|
3304
4491
|
owner: string;
|
|
3305
|
-
project: string; /** @description The
|
|
3306
|
-
|
|
3307
|
-
commentId:
|
|
4492
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
4493
|
+
testId: components["schemas"]["TestId"]; /** @description ID of any comment in the thread */
|
|
4494
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
3308
4495
|
};
|
|
3309
4496
|
cookie?: never;
|
|
3310
4497
|
};
|