@argos-ci/api-client 0.26.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 +1466 -271
- 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;
|
|
@@ -629,7 +829,15 @@ interface components {
|
|
|
629
829
|
ScreenshotInput: {
|
|
630
830
|
key: string;
|
|
631
831
|
name: string;
|
|
632
|
-
|
|
832
|
+
/**
|
|
833
|
+
* @description Name(s) to compare this screenshot against, instead of its own name. An array is tried in order: the first name that exists in the baseline wins, which lets a new screenshot fall back to an existing one.
|
|
834
|
+
* @example home.png
|
|
835
|
+
* @example [
|
|
836
|
+
* "home-variant-b.png",
|
|
837
|
+
* "home.png"
|
|
838
|
+
* ]
|
|
839
|
+
*/
|
|
840
|
+
baseName?: (string | string[]) | null;
|
|
633
841
|
parentName?: string | null;
|
|
634
842
|
metadata?: {
|
|
635
843
|
/**
|
|
@@ -709,7 +917,14 @@ interface components {
|
|
|
709
917
|
* @description The build number
|
|
710
918
|
* @example 42
|
|
711
919
|
*/
|
|
712
|
-
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;
|
|
713
928
|
AccountAnalytics: {
|
|
714
929
|
screenshots: {
|
|
715
930
|
series: {
|
|
@@ -763,10 +978,30 @@ interface components {
|
|
|
763
978
|
details?: {
|
|
764
979
|
message: string;
|
|
765
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;
|
|
766
997
|
}; /** @description Build */
|
|
767
998
|
Build: {
|
|
768
999
|
id: components["schemas"]["BuildId"];
|
|
769
|
-
|
|
1000
|
+
/**
|
|
1001
|
+
* @description The build number
|
|
1002
|
+
* @example 42
|
|
1003
|
+
*/
|
|
1004
|
+
number: number; /** @description The head reference of the build */
|
|
770
1005
|
head: components["schemas"]["BuildGitReference"]; /** @description The base reference of the build */
|
|
771
1006
|
base: components["schemas"]["BuildGitReference"] | null; /** @description The status of the build */
|
|
772
1007
|
status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted"); /** @description The conclusion of the build */
|
|
@@ -814,27 +1049,18 @@ interface components {
|
|
|
814
1049
|
BuildGitReference: {
|
|
815
1050
|
/** @description The commit SHA */sha: components["schemas"]["Sha1Hash"]; /** @description The branch name */
|
|
816
1051
|
branch: string;
|
|
817
|
-
}; /** @description
|
|
818
|
-
|
|
1052
|
+
}; /** @description The authenticated user. */
|
|
1053
|
+
Me: {
|
|
819
1054
|
id: string;
|
|
820
1055
|
slug: string;
|
|
821
|
-
name: string | null;
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
name: string;
|
|
827
|
-
defaultBaseBranch: string;
|
|
828
|
-
hasRemoteContentAccess: boolean;
|
|
829
|
-
}; /** @description Account */
|
|
830
|
-
Account: {
|
|
831
|
-
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. */
|
|
832
1061
|
slug: string;
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
/** @description Total number of items */total: number; /** @description Current page number */
|
|
836
|
-
page: number; /** @description Number of items per page */
|
|
837
|
-
perPage: number;
|
|
1062
|
+
name: string | null; /** @enum {string} */
|
|
1063
|
+
type: "user" | "team";
|
|
838
1064
|
}; /** @description Snapshot diff */
|
|
839
1065
|
SnapshotDiff: {
|
|
840
1066
|
/** @description Unique identifier of the snapshot diff */id: string; /** @description Name of the snapshot diff */
|
|
@@ -1020,10 +1246,16 @@ interface components {
|
|
|
1020
1246
|
dismissedAt: string | null; /** @description The user who dismissed the review, if any. */
|
|
1021
1247
|
dismissedBy: components["schemas"]["User"] | null; /** @description Date the review was created. */
|
|
1022
1248
|
date: string;
|
|
1023
|
-
}; /** @description A
|
|
1024
|
-
|
|
1249
|
+
}; /** @description A user. */
|
|
1250
|
+
User: {
|
|
1025
1251
|
id: string;
|
|
1026
|
-
|
|
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. */
|
|
1027
1259
|
threadId: string | null; /** @description Rich-text JSON content of the comment. */
|
|
1028
1260
|
body: unknown; /** @description Plain-text rendering of the comment content. */
|
|
1029
1261
|
text: string;
|
|
@@ -1047,12 +1279,68 @@ interface components {
|
|
|
1047
1279
|
count: number; /** @description The users who reacted with this emoji. */
|
|
1048
1280
|
users: components["schemas"]["User"][];
|
|
1049
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;
|
|
1050
1302
|
};
|
|
1051
1303
|
/**
|
|
1052
|
-
* @description
|
|
1053
|
-
* @
|
|
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}
|
|
1054
1306
|
*/
|
|
1055
|
-
|
|
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
|
+
};
|
|
1056
1344
|
};
|
|
1057
1345
|
responses: never;
|
|
1058
1346
|
parameters: never;
|
|
@@ -1112,40 +1400,99 @@ interface operations {
|
|
|
1112
1400
|
};
|
|
1113
1401
|
};
|
|
1114
1402
|
};
|
|
1115
|
-
|
|
1403
|
+
listProjects: {
|
|
1116
1404
|
parameters: {
|
|
1117
|
-
query?:
|
|
1405
|
+
query?: {
|
|
1406
|
+
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
1407
|
+
page?: string;
|
|
1408
|
+
};
|
|
1118
1409
|
header?: never;
|
|
1119
|
-
path
|
|
1410
|
+
path: {
|
|
1411
|
+
/** @description Slug of the account to list projects for. */accountSlug: string;
|
|
1412
|
+
};
|
|
1120
1413
|
cookie?: never;
|
|
1121
1414
|
};
|
|
1122
|
-
requestBody?:
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
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;
|
|
1149
1496
|
} & ({
|
|
1150
1497
|
/**
|
|
1151
1498
|
* @deprecated
|
|
@@ -1818,7 +2165,7 @@ interface operations {
|
|
|
1818
2165
|
[name: string]: unknown;
|
|
1819
2166
|
};
|
|
1820
2167
|
content: {
|
|
1821
|
-
"application/json": components["schemas"]["
|
|
2168
|
+
"application/json": components["schemas"]["Me"];
|
|
1822
2169
|
};
|
|
1823
2170
|
}; /** @description Unauthorized */
|
|
1824
2171
|
401: {
|
|
@@ -1937,8 +2284,877 @@ interface operations {
|
|
|
1937
2284
|
content: {
|
|
1938
2285
|
"application/json": components["schemas"]["Error"];
|
|
1939
2286
|
};
|
|
1940
|
-
}; /** @description Conflict */
|
|
1941
|
-
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: {
|
|
1942
3158
|
headers: {
|
|
1943
3159
|
[name: string]: unknown;
|
|
1944
3160
|
};
|
|
@@ -1956,28 +3172,26 @@ interface operations {
|
|
|
1956
3172
|
};
|
|
1957
3173
|
};
|
|
1958
3174
|
};
|
|
1959
|
-
|
|
3175
|
+
deleteBuildComment: {
|
|
1960
3176
|
parameters: {
|
|
1961
3177
|
query?: never;
|
|
1962
3178
|
header?: never;
|
|
1963
|
-
path
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
"application/json": {
|
|
1969
|
-
/** @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. */
|
|
1970
|
-
accountSlug: string;
|
|
1971
|
-
};
|
|
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"];
|
|
1972
3184
|
};
|
|
3185
|
+
cookie?: never;
|
|
1973
3186
|
};
|
|
3187
|
+
requestBody?: never;
|
|
1974
3188
|
responses: {
|
|
1975
|
-
/** @description
|
|
3189
|
+
/** @description Comment deleted successfully — returns the comment */200: {
|
|
1976
3190
|
headers: {
|
|
1977
3191
|
[name: string]: unknown;
|
|
1978
3192
|
};
|
|
1979
3193
|
content: {
|
|
1980
|
-
"application/json": components["schemas"]["
|
|
3194
|
+
"application/json": components["schemas"]["Comment"];
|
|
1981
3195
|
};
|
|
1982
3196
|
}; /** @description Invalid parameters */
|
|
1983
3197
|
400: {
|
|
@@ -2003,6 +3217,14 @@ interface operations {
|
|
|
2003
3217
|
content: {
|
|
2004
3218
|
"application/json": components["schemas"]["Error"];
|
|
2005
3219
|
};
|
|
3220
|
+
}; /** @description Not found */
|
|
3221
|
+
404: {
|
|
3222
|
+
headers: {
|
|
3223
|
+
[name: string]: unknown;
|
|
3224
|
+
};
|
|
3225
|
+
content: {
|
|
3226
|
+
"application/json": components["schemas"]["Error"];
|
|
3227
|
+
};
|
|
2006
3228
|
}; /** @description Server error */
|
|
2007
3229
|
500: {
|
|
2008
3230
|
headers: {
|
|
@@ -2014,24 +3236,42 @@ interface operations {
|
|
|
2014
3236
|
};
|
|
2015
3237
|
};
|
|
2016
3238
|
};
|
|
2017
|
-
|
|
3239
|
+
updateBuildComment: {
|
|
2018
3240
|
parameters: {
|
|
2019
3241
|
query?: never;
|
|
2020
3242
|
header?: never;
|
|
2021
3243
|
path: {
|
|
2022
3244
|
owner: string;
|
|
2023
|
-
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"];
|
|
2024
3248
|
};
|
|
2025
3249
|
cookie?: never;
|
|
2026
3250
|
};
|
|
2027
|
-
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
|
+
};
|
|
2028
3260
|
responses: {
|
|
2029
|
-
/** @description
|
|
3261
|
+
/** @description Comment updated successfully — returns the comment */200: {
|
|
2030
3262
|
headers: {
|
|
2031
3263
|
[name: string]: unknown;
|
|
2032
3264
|
};
|
|
2033
3265
|
content: {
|
|
2034
|
-
"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"];
|
|
2035
3275
|
};
|
|
2036
3276
|
}; /** @description Unauthorized */
|
|
2037
3277
|
401: {
|
|
@@ -2068,33 +3308,32 @@ interface operations {
|
|
|
2068
3308
|
};
|
|
2069
3309
|
};
|
|
2070
3310
|
};
|
|
2071
|
-
|
|
3311
|
+
addBuildCommentReaction: {
|
|
2072
3312
|
parameters: {
|
|
2073
|
-
query?:
|
|
2074
|
-
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2075
|
-
page?: string;
|
|
2076
|
-
head?: string;
|
|
2077
|
-
headSha?: components["schemas"]["Sha1Hash"]; /** @description Only return the latest builds created, unique by name and commit. */
|
|
2078
|
-
distinctName?: string;
|
|
2079
|
-
};
|
|
3313
|
+
query?: never;
|
|
2080
3314
|
header?: never;
|
|
2081
3315
|
path: {
|
|
2082
3316
|
owner: string;
|
|
2083
|
-
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"];
|
|
2084
3320
|
};
|
|
2085
3321
|
cookie?: never;
|
|
2086
3322
|
};
|
|
2087
|
-
requestBody
|
|
3323
|
+
requestBody: {
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": {
|
|
3326
|
+
/** @description The emoji to react with. */emoji: string;
|
|
3327
|
+
};
|
|
3328
|
+
};
|
|
3329
|
+
};
|
|
2088
3330
|
responses: {
|
|
2089
|
-
/** @description
|
|
3331
|
+
/** @description Reaction added — returns the comment */200: {
|
|
2090
3332
|
headers: {
|
|
2091
3333
|
[name: string]: unknown;
|
|
2092
3334
|
};
|
|
2093
3335
|
content: {
|
|
2094
|
-
"application/json":
|
|
2095
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
2096
|
-
results: components["schemas"]["Build"][];
|
|
2097
|
-
};
|
|
3336
|
+
"application/json": components["schemas"]["Comment"];
|
|
2098
3337
|
};
|
|
2099
3338
|
}; /** @description Invalid parameters */
|
|
2100
3339
|
400: {
|
|
@@ -2139,25 +3378,28 @@ interface operations {
|
|
|
2139
3378
|
};
|
|
2140
3379
|
};
|
|
2141
3380
|
};
|
|
2142
|
-
|
|
3381
|
+
removeBuildCommentReaction: {
|
|
2143
3382
|
parameters: {
|
|
2144
|
-
query
|
|
3383
|
+
query: {
|
|
3384
|
+
/** @description The emoji reaction to remove. */emoji: string;
|
|
3385
|
+
};
|
|
2145
3386
|
header?: never;
|
|
2146
3387
|
path: {
|
|
2147
3388
|
owner: string;
|
|
2148
3389
|
project: string; /** @description The build number */
|
|
2149
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3390
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description The ID of the comment */
|
|
3391
|
+
commentId: components["schemas"]["CommentId"];
|
|
2150
3392
|
};
|
|
2151
3393
|
cookie?: never;
|
|
2152
3394
|
};
|
|
2153
3395
|
requestBody?: never;
|
|
2154
3396
|
responses: {
|
|
2155
|
-
/** @description
|
|
3397
|
+
/** @description Reaction removed — returns the comment */200: {
|
|
2156
3398
|
headers: {
|
|
2157
3399
|
[name: string]: unknown;
|
|
2158
3400
|
};
|
|
2159
3401
|
content: {
|
|
2160
|
-
"application/json": components["schemas"]["
|
|
3402
|
+
"application/json": components["schemas"]["Comment"];
|
|
2161
3403
|
};
|
|
2162
3404
|
}; /** @description Invalid parameters */
|
|
2163
3405
|
400: {
|
|
@@ -2202,33 +3444,26 @@ interface operations {
|
|
|
2202
3444
|
};
|
|
2203
3445
|
};
|
|
2204
3446
|
};
|
|
2205
|
-
|
|
3447
|
+
resolveBuildCommentThread: {
|
|
2206
3448
|
parameters: {
|
|
2207
|
-
query?:
|
|
2208
|
-
/** @description Number of items per page (max 100) */perPage?: string; /** @description Page number */
|
|
2209
|
-
page?: string; /** @description Only return diffs that require review. Matches `changed`, `added`, and `removed`, except `removed` is excluded for subset builds. */
|
|
2210
|
-
needsReview?: string; /** @description Period over which the test flakiness metrics are computed. */
|
|
2211
|
-
metricsPeriod?: "LAST_24_HOURS" | "LAST_3_DAYS" | "LAST_7_DAYS" | "LAST_30_DAYS" | "LAST_90_DAYS";
|
|
2212
|
-
};
|
|
3449
|
+
query?: never;
|
|
2213
3450
|
header?: never;
|
|
2214
3451
|
path: {
|
|
2215
3452
|
owner: string;
|
|
2216
3453
|
project: string; /** @description The build number */
|
|
2217
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3454
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3455
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2218
3456
|
};
|
|
2219
3457
|
cookie?: never;
|
|
2220
3458
|
};
|
|
2221
3459
|
requestBody?: never;
|
|
2222
3460
|
responses: {
|
|
2223
|
-
/** @description
|
|
3461
|
+
/** @description Thread resolved — returns the root comment */200: {
|
|
2224
3462
|
headers: {
|
|
2225
3463
|
[name: string]: unknown;
|
|
2226
3464
|
};
|
|
2227
3465
|
content: {
|
|
2228
|
-
"application/json":
|
|
2229
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
2230
|
-
results: components["schemas"]["SnapshotDiff"][];
|
|
2231
|
-
};
|
|
3466
|
+
"application/json": components["schemas"]["Comment"];
|
|
2232
3467
|
};
|
|
2233
3468
|
}; /** @description Invalid parameters */
|
|
2234
3469
|
400: {
|
|
@@ -2246,6 +3481,14 @@ interface operations {
|
|
|
2246
3481
|
content: {
|
|
2247
3482
|
"application/json": components["schemas"]["Error"];
|
|
2248
3483
|
};
|
|
3484
|
+
}; /** @description Forbidden */
|
|
3485
|
+
403: {
|
|
3486
|
+
headers: {
|
|
3487
|
+
[name: string]: unknown;
|
|
3488
|
+
};
|
|
3489
|
+
content: {
|
|
3490
|
+
"application/json": components["schemas"]["Error"];
|
|
3491
|
+
};
|
|
2249
3492
|
}; /** @description Not found */
|
|
2250
3493
|
404: {
|
|
2251
3494
|
headers: {
|
|
@@ -2265,27 +3508,26 @@ interface operations {
|
|
|
2265
3508
|
};
|
|
2266
3509
|
};
|
|
2267
3510
|
};
|
|
2268
|
-
|
|
3511
|
+
unresolveBuildCommentThread: {
|
|
2269
3512
|
parameters: {
|
|
2270
|
-
query?:
|
|
2271
|
-
/** @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";
|
|
2272
|
-
};
|
|
3513
|
+
query?: never;
|
|
2273
3514
|
header?: never;
|
|
2274
3515
|
path: {
|
|
2275
3516
|
owner: string;
|
|
2276
|
-
project: string; /** @description
|
|
2277
|
-
|
|
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"];
|
|
2278
3520
|
};
|
|
2279
3521
|
cookie?: never;
|
|
2280
3522
|
};
|
|
2281
3523
|
requestBody?: never;
|
|
2282
3524
|
responses: {
|
|
2283
|
-
/** @description
|
|
3525
|
+
/** @description Thread reopened — returns the root comment */200: {
|
|
2284
3526
|
headers: {
|
|
2285
3527
|
[name: string]: unknown;
|
|
2286
3528
|
};
|
|
2287
3529
|
content: {
|
|
2288
|
-
"application/json": components["schemas"]["
|
|
3530
|
+
"application/json": components["schemas"]["Comment"];
|
|
2289
3531
|
};
|
|
2290
3532
|
}; /** @description Invalid parameters */
|
|
2291
3533
|
400: {
|
|
@@ -2330,27 +3572,26 @@ interface operations {
|
|
|
2330
3572
|
};
|
|
2331
3573
|
};
|
|
2332
3574
|
};
|
|
2333
|
-
|
|
3575
|
+
subscribeBuildCommentThread: {
|
|
2334
3576
|
parameters: {
|
|
2335
|
-
query?:
|
|
2336
|
-
/** @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";
|
|
2337
|
-
};
|
|
3577
|
+
query?: never;
|
|
2338
3578
|
header?: never;
|
|
2339
3579
|
path: {
|
|
2340
3580
|
owner: string;
|
|
2341
|
-
project: string; /** @description
|
|
2342
|
-
|
|
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"];
|
|
2343
3584
|
};
|
|
2344
3585
|
cookie?: never;
|
|
2345
3586
|
};
|
|
2346
3587
|
requestBody?: never;
|
|
2347
3588
|
responses: {
|
|
2348
|
-
/** @description
|
|
3589
|
+
/** @description Subscribed — returns the root comment */200: {
|
|
2349
3590
|
headers: {
|
|
2350
3591
|
[name: string]: unknown;
|
|
2351
3592
|
};
|
|
2352
3593
|
content: {
|
|
2353
|
-
"application/json": components["schemas"]["
|
|
3594
|
+
"application/json": components["schemas"]["Comment"];
|
|
2354
3595
|
};
|
|
2355
3596
|
}; /** @description Invalid parameters */
|
|
2356
3597
|
400: {
|
|
@@ -2395,25 +3636,26 @@ interface operations {
|
|
|
2395
3636
|
};
|
|
2396
3637
|
};
|
|
2397
3638
|
};
|
|
2398
|
-
|
|
3639
|
+
unsubscribeBuildCommentThread: {
|
|
2399
3640
|
parameters: {
|
|
2400
3641
|
query?: never;
|
|
2401
3642
|
header?: never;
|
|
2402
3643
|
path: {
|
|
2403
3644
|
owner: string;
|
|
2404
3645
|
project: string; /** @description The build number */
|
|
2405
|
-
buildNumber: components["schemas"]["BuildNumber"];
|
|
3646
|
+
buildNumber: components["schemas"]["BuildNumber"]; /** @description ID of any comment in the thread */
|
|
3647
|
+
commentId: components["schemas"]["ThreadCommentId"];
|
|
2406
3648
|
};
|
|
2407
3649
|
cookie?: never;
|
|
2408
3650
|
};
|
|
2409
3651
|
requestBody?: never;
|
|
2410
3652
|
responses: {
|
|
2411
|
-
/** @description
|
|
3653
|
+
/** @description Unsubscribed — returns the root comment */200: {
|
|
2412
3654
|
headers: {
|
|
2413
3655
|
[name: string]: unknown;
|
|
2414
3656
|
};
|
|
2415
3657
|
content: {
|
|
2416
|
-
"application/json": components["schemas"]["
|
|
3658
|
+
"application/json": components["schemas"]["Comment"];
|
|
2417
3659
|
};
|
|
2418
3660
|
}; /** @description Invalid parameters */
|
|
2419
3661
|
400: {
|
|
@@ -2458,54 +3700,27 @@ interface operations {
|
|
|
2458
3700
|
};
|
|
2459
3701
|
};
|
|
2460
3702
|
};
|
|
2461
|
-
|
|
3703
|
+
getTest: {
|
|
2462
3704
|
parameters: {
|
|
2463
|
-
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
|
+
};
|
|
2464
3708
|
header?: never;
|
|
2465
3709
|
path: {
|
|
2466
3710
|
owner: string;
|
|
2467
|
-
project: string; /** @description The
|
|
2468
|
-
|
|
3711
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3712
|
+
testId: components["schemas"]["TestId"];
|
|
2469
3713
|
};
|
|
2470
3714
|
cookie?: never;
|
|
2471
3715
|
};
|
|
2472
|
-
requestBody
|
|
2473
|
-
content: {
|
|
2474
|
-
"application/json": {
|
|
2475
|
-
/**
|
|
2476
|
-
* @description Review event to apply to the build: "APPROVE", "REJECT" or "COMMENT". Required when `conclusion` is not provided.
|
|
2477
|
-
* @enum {string}
|
|
2478
|
-
*/
|
|
2479
|
-
event?: "APPROVE" | "REJECT" | "COMMENT";
|
|
2480
|
-
/**
|
|
2481
|
-
* @deprecated
|
|
2482
|
-
* @description Deprecated: use `event` instead. Overall review conclusion for the build: "APPROVE" or "REQUEST_CHANGES".
|
|
2483
|
-
* @enum {string}
|
|
2484
|
-
*/
|
|
2485
|
-
conclusion?: "APPROVE" | "REQUEST_CHANGES"; /** @description Optional comment to attach to the review. Either Markdown text or the JSON representation of a rich-text document. */
|
|
2486
|
-
body?: unknown;
|
|
2487
|
-
/**
|
|
2488
|
-
* @description Optional per-snapshot review decisions. When omitted, only the build-level review is recorded.
|
|
2489
|
-
* @default []
|
|
2490
|
-
*/
|
|
2491
|
-
snapshots?: {
|
|
2492
|
-
/** @description The ID of the snapshot to review */id: string;
|
|
2493
|
-
/**
|
|
2494
|
-
* @description Review conclusion for this individual snapshot: "APPROVE" or "REQUEST_CHANGES"
|
|
2495
|
-
* @enum {string}
|
|
2496
|
-
*/
|
|
2497
|
-
conclusion: "APPROVE" | "REQUEST_CHANGES";
|
|
2498
|
-
}[];
|
|
2499
|
-
};
|
|
2500
|
-
};
|
|
2501
|
-
};
|
|
3716
|
+
requestBody?: never;
|
|
2502
3717
|
responses: {
|
|
2503
|
-
/** @description
|
|
3718
|
+
/** @description The test and its flakiness metrics */200: {
|
|
2504
3719
|
headers: {
|
|
2505
3720
|
[name: string]: unknown;
|
|
2506
3721
|
};
|
|
2507
3722
|
content: {
|
|
2508
|
-
"application/json": components["schemas"]["
|
|
3723
|
+
"application/json": components["schemas"]["TestDetails"];
|
|
2509
3724
|
};
|
|
2510
3725
|
}; /** @description Invalid parameters */
|
|
2511
3726
|
400: {
|
|
@@ -2523,14 +3738,6 @@ interface operations {
|
|
|
2523
3738
|
content: {
|
|
2524
3739
|
"application/json": components["schemas"]["Error"];
|
|
2525
3740
|
};
|
|
2526
|
-
}; /** @description Forbidden */
|
|
2527
|
-
403: {
|
|
2528
|
-
headers: {
|
|
2529
|
-
[name: string]: unknown;
|
|
2530
|
-
};
|
|
2531
|
-
content: {
|
|
2532
|
-
"application/json": components["schemas"]["Error"];
|
|
2533
|
-
};
|
|
2534
3741
|
}; /** @description Not found */
|
|
2535
3742
|
404: {
|
|
2536
3743
|
headers: {
|
|
@@ -2550,26 +3757,33 @@ interface operations {
|
|
|
2550
3757
|
};
|
|
2551
3758
|
};
|
|
2552
3759
|
};
|
|
2553
|
-
|
|
3760
|
+
listTestChanges: {
|
|
2554
3761
|
parameters: {
|
|
2555
|
-
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
|
+
};
|
|
2556
3768
|
header?: never;
|
|
2557
3769
|
path: {
|
|
2558
3770
|
owner: string;
|
|
2559
|
-
project: string; /** @description The
|
|
2560
|
-
|
|
2561
|
-
reviewId: string;
|
|
3771
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3772
|
+
testId: components["schemas"]["TestId"];
|
|
2562
3773
|
};
|
|
2563
3774
|
cookie?: never;
|
|
2564
3775
|
};
|
|
2565
3776
|
requestBody?: never;
|
|
2566
3777
|
responses: {
|
|
2567
|
-
/** @description
|
|
3778
|
+
/** @description List of the test's changes */200: {
|
|
2568
3779
|
headers: {
|
|
2569
3780
|
[name: string]: unknown;
|
|
2570
3781
|
};
|
|
2571
3782
|
content: {
|
|
2572
|
-
"application/json":
|
|
3783
|
+
"application/json": {
|
|
3784
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
3785
|
+
results: components["schemas"]["TestChange"][];
|
|
3786
|
+
};
|
|
2573
3787
|
};
|
|
2574
3788
|
}; /** @description Invalid parameters */
|
|
2575
3789
|
400: {
|
|
@@ -2587,14 +3801,6 @@ interface operations {
|
|
|
2587
3801
|
content: {
|
|
2588
3802
|
"application/json": components["schemas"]["Error"];
|
|
2589
3803
|
};
|
|
2590
|
-
}; /** @description Forbidden */
|
|
2591
|
-
403: {
|
|
2592
|
-
headers: {
|
|
2593
|
-
[name: string]: unknown;
|
|
2594
|
-
};
|
|
2595
|
-
content: {
|
|
2596
|
-
"application/json": components["schemas"]["Error"];
|
|
2597
|
-
};
|
|
2598
3804
|
}; /** @description Not found */
|
|
2599
3805
|
404: {
|
|
2600
3806
|
headers: {
|
|
@@ -2614,20 +3820,20 @@ interface operations {
|
|
|
2614
3820
|
};
|
|
2615
3821
|
};
|
|
2616
3822
|
};
|
|
2617
|
-
|
|
3823
|
+
listTestComments: {
|
|
2618
3824
|
parameters: {
|
|
2619
3825
|
query?: never;
|
|
2620
3826
|
header?: never;
|
|
2621
3827
|
path: {
|
|
2622
3828
|
owner: string;
|
|
2623
|
-
project: string; /** @description The
|
|
2624
|
-
|
|
3829
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3830
|
+
testId: components["schemas"]["TestId"];
|
|
2625
3831
|
};
|
|
2626
3832
|
cookie?: never;
|
|
2627
3833
|
};
|
|
2628
3834
|
requestBody?: never;
|
|
2629
3835
|
responses: {
|
|
2630
|
-
/** @description
|
|
3836
|
+
/** @description Comments, oldest first. Replies carry a threadId pointing at their root comment. */200: {
|
|
2631
3837
|
headers: {
|
|
2632
3838
|
[name: string]: unknown;
|
|
2633
3839
|
};
|
|
@@ -2677,14 +3883,14 @@ interface operations {
|
|
|
2677
3883
|
};
|
|
2678
3884
|
};
|
|
2679
3885
|
};
|
|
2680
|
-
|
|
3886
|
+
createTestComment: {
|
|
2681
3887
|
parameters: {
|
|
2682
3888
|
query?: never;
|
|
2683
3889
|
header?: never;
|
|
2684
3890
|
path: {
|
|
2685
3891
|
owner: string;
|
|
2686
|
-
project: string; /** @description The
|
|
2687
|
-
|
|
3892
|
+
project: string; /** @description The test identifier, as returned in a diff's `test.id` */
|
|
3893
|
+
testId: components["schemas"]["TestId"];
|
|
2688
3894
|
};
|
|
2689
3895
|
cookie?: never;
|
|
2690
3896
|
};
|
|
@@ -2694,18 +3900,7 @@ interface operations {
|
|
|
2694
3900
|
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */body: string | {
|
|
2695
3901
|
[key: string]: unknown;
|
|
2696
3902
|
}; /** @description Root comment ID to reply to. */
|
|
2697
|
-
threadId?: string;
|
|
2698
|
-
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. */
|
|
2699
|
-
anchor?: {
|
|
2700
|
-
/** @constant */type: "point";
|
|
2701
|
-
x: number;
|
|
2702
|
-
y: number;
|
|
2703
|
-
} | {
|
|
2704
|
-
/** @constant */type: "lines";
|
|
2705
|
-
from: number;
|
|
2706
|
-
to: number;
|
|
2707
|
-
}; /** @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. */
|
|
2708
|
-
addToReview?: boolean;
|
|
3903
|
+
threadId?: string;
|
|
2709
3904
|
};
|
|
2710
3905
|
};
|
|
2711
3906
|
};
|
|
@@ -2760,15 +3955,15 @@ interface operations {
|
|
|
2760
3955
|
};
|
|
2761
3956
|
};
|
|
2762
3957
|
};
|
|
2763
|
-
|
|
3958
|
+
getTestComment: {
|
|
2764
3959
|
parameters: {
|
|
2765
3960
|
query?: never;
|
|
2766
3961
|
header?: never;
|
|
2767
3962
|
path: {
|
|
2768
3963
|
owner: string;
|
|
2769
|
-
project: string; /** @description The
|
|
2770
|
-
|
|
2771
|
-
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"];
|
|
2772
3967
|
};
|
|
2773
3968
|
cookie?: never;
|
|
2774
3969
|
};
|
|
@@ -2824,15 +4019,15 @@ interface operations {
|
|
|
2824
4019
|
};
|
|
2825
4020
|
};
|
|
2826
4021
|
};
|
|
2827
|
-
|
|
4022
|
+
deleteTestComment: {
|
|
2828
4023
|
parameters: {
|
|
2829
4024
|
query?: never;
|
|
2830
4025
|
header?: never;
|
|
2831
4026
|
path: {
|
|
2832
4027
|
owner: string;
|
|
2833
|
-
project: string; /** @description The
|
|
2834
|
-
|
|
2835
|
-
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"];
|
|
2836
4031
|
};
|
|
2837
4032
|
cookie?: never;
|
|
2838
4033
|
};
|
|
@@ -2888,15 +4083,15 @@ interface operations {
|
|
|
2888
4083
|
};
|
|
2889
4084
|
};
|
|
2890
4085
|
};
|
|
2891
|
-
|
|
4086
|
+
updateTestComment: {
|
|
2892
4087
|
parameters: {
|
|
2893
4088
|
query?: never;
|
|
2894
4089
|
header?: never;
|
|
2895
4090
|
path: {
|
|
2896
4091
|
owner: string;
|
|
2897
|
-
project: string; /** @description The
|
|
2898
|
-
|
|
2899
|
-
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"];
|
|
2900
4095
|
};
|
|
2901
4096
|
cookie?: never;
|
|
2902
4097
|
};
|
|
@@ -2960,15 +4155,15 @@ interface operations {
|
|
|
2960
4155
|
};
|
|
2961
4156
|
};
|
|
2962
4157
|
};
|
|
2963
|
-
|
|
4158
|
+
addTestCommentReaction: {
|
|
2964
4159
|
parameters: {
|
|
2965
4160
|
query?: never;
|
|
2966
4161
|
header?: never;
|
|
2967
4162
|
path: {
|
|
2968
4163
|
owner: string;
|
|
2969
|
-
project: string; /** @description The
|
|
2970
|
-
|
|
2971
|
-
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"];
|
|
2972
4167
|
};
|
|
2973
4168
|
cookie?: never;
|
|
2974
4169
|
};
|
|
@@ -3030,7 +4225,7 @@ interface operations {
|
|
|
3030
4225
|
};
|
|
3031
4226
|
};
|
|
3032
4227
|
};
|
|
3033
|
-
|
|
4228
|
+
removeTestCommentReaction: {
|
|
3034
4229
|
parameters: {
|
|
3035
4230
|
query: {
|
|
3036
4231
|
/** @description The emoji reaction to remove. */emoji: string;
|
|
@@ -3038,9 +4233,9 @@ interface operations {
|
|
|
3038
4233
|
header?: never;
|
|
3039
4234
|
path: {
|
|
3040
4235
|
owner: string;
|
|
3041
|
-
project: string; /** @description The
|
|
3042
|
-
|
|
3043
|
-
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"];
|
|
3044
4239
|
};
|
|
3045
4240
|
cookie?: never;
|
|
3046
4241
|
};
|
|
@@ -3096,15 +4291,15 @@ interface operations {
|
|
|
3096
4291
|
};
|
|
3097
4292
|
};
|
|
3098
4293
|
};
|
|
3099
|
-
|
|
4294
|
+
resolveTestCommentThread: {
|
|
3100
4295
|
parameters: {
|
|
3101
4296
|
query?: never;
|
|
3102
4297
|
header?: never;
|
|
3103
4298
|
path: {
|
|
3104
4299
|
owner: string;
|
|
3105
|
-
project: string; /** @description The
|
|
3106
|
-
|
|
3107
|
-
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"];
|
|
3108
4303
|
};
|
|
3109
4304
|
cookie?: never;
|
|
3110
4305
|
};
|
|
@@ -3160,15 +4355,15 @@ interface operations {
|
|
|
3160
4355
|
};
|
|
3161
4356
|
};
|
|
3162
4357
|
};
|
|
3163
|
-
|
|
4358
|
+
unresolveTestCommentThread: {
|
|
3164
4359
|
parameters: {
|
|
3165
4360
|
query?: never;
|
|
3166
4361
|
header?: never;
|
|
3167
4362
|
path: {
|
|
3168
4363
|
owner: string;
|
|
3169
|
-
project: string; /** @description The
|
|
3170
|
-
|
|
3171
|
-
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"];
|
|
3172
4367
|
};
|
|
3173
4368
|
cookie?: never;
|
|
3174
4369
|
};
|
|
@@ -3224,15 +4419,15 @@ interface operations {
|
|
|
3224
4419
|
};
|
|
3225
4420
|
};
|
|
3226
4421
|
};
|
|
3227
|
-
|
|
4422
|
+
subscribeTestCommentThread: {
|
|
3228
4423
|
parameters: {
|
|
3229
4424
|
query?: never;
|
|
3230
4425
|
header?: never;
|
|
3231
4426
|
path: {
|
|
3232
4427
|
owner: string;
|
|
3233
|
-
project: string; /** @description The
|
|
3234
|
-
|
|
3235
|
-
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"];
|
|
3236
4431
|
};
|
|
3237
4432
|
cookie?: never;
|
|
3238
4433
|
};
|
|
@@ -3288,15 +4483,15 @@ interface operations {
|
|
|
3288
4483
|
};
|
|
3289
4484
|
};
|
|
3290
4485
|
};
|
|
3291
|
-
|
|
4486
|
+
unsubscribeTestCommentThread: {
|
|
3292
4487
|
parameters: {
|
|
3293
4488
|
query?: never;
|
|
3294
4489
|
header?: never;
|
|
3295
4490
|
path: {
|
|
3296
4491
|
owner: string;
|
|
3297
|
-
project: string; /** @description The
|
|
3298
|
-
|
|
3299
|
-
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"];
|
|
3300
4495
|
};
|
|
3301
4496
|
cookie?: never;
|
|
3302
4497
|
};
|