@argos-ci/api-client 0.31.3 → 0.33.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 +1092 -383
- package/dist/index.mjs +4 -8
- package/dist/rolldown-runtime-D3KUYPsf.mjs +12 -0
- package/package.json +2 -2
- package/dist/rolldown-runtime-D7D4PA-g.mjs +0 -13
package/dist/index.d.mts
CHANGED
|
@@ -173,7 +173,7 @@ interface paths {
|
|
|
173
173
|
put?: never;
|
|
174
174
|
/**
|
|
175
175
|
* Open a team to an email domain
|
|
176
|
-
* @description Add an email domain to a team, so anyone signing up with a verified address on it joins automatically. Requires administrator access to the team, and you must yourself hold a verified address on the domain
|
|
176
|
+
* @description Add an email domain to a team, so anyone signing up with a verified address on it joins automatically. Requires administrator access to the team, and you must yourself hold a verified address on the domain. A team can only be opened to a domain its administrator demonstrably belongs to. Public email providers are refused.
|
|
177
177
|
*/
|
|
178
178
|
post: operations["addTeamDomain"];
|
|
179
179
|
delete?: never;
|
|
@@ -202,6 +202,50 @@ interface paths {
|
|
|
202
202
|
patch?: never;
|
|
203
203
|
trace?: never;
|
|
204
204
|
};
|
|
205
|
+
"/accounts/{accountSlug}/project-tokens": {
|
|
206
|
+
parameters: {
|
|
207
|
+
query?: never;
|
|
208
|
+
header?: never;
|
|
209
|
+
path?: never;
|
|
210
|
+
cookie?: never;
|
|
211
|
+
};
|
|
212
|
+
/**
|
|
213
|
+
* List an account's project tokens
|
|
214
|
+
* @description List every project token of an account, whatever projects they are linked to. Requires administrator access to the account.
|
|
215
|
+
*/
|
|
216
|
+
get: operations["listAccountProjectTokens"];
|
|
217
|
+
put?: never;
|
|
218
|
+
/**
|
|
219
|
+
* Create a project token for several projects
|
|
220
|
+
* @description Create a project token linked to one or more projects of an account. CI using it has to name the project it uploads to (`ARGOS_PROJECT`) when it is linked to several. Requires administrator access to the account, or to every listed project.
|
|
221
|
+
*/
|
|
222
|
+
post: operations["createAccountProjectToken"];
|
|
223
|
+
delete?: never;
|
|
224
|
+
options?: never;
|
|
225
|
+
head?: never;
|
|
226
|
+
patch?: never;
|
|
227
|
+
trace?: never;
|
|
228
|
+
};
|
|
229
|
+
"/accounts/{accountSlug}/project-tokens/{tokenId}": {
|
|
230
|
+
parameters: {
|
|
231
|
+
query?: never;
|
|
232
|
+
header?: never;
|
|
233
|
+
path?: never;
|
|
234
|
+
cookie?: never;
|
|
235
|
+
};
|
|
236
|
+
get?: never;
|
|
237
|
+
put?: never;
|
|
238
|
+
post?: never;
|
|
239
|
+
/**
|
|
240
|
+
* Revoke a project token of an account
|
|
241
|
+
* @description Revoke a project token: CI using it is rejected from its next request. Requires administrator access to the account, or to every project the token is linked to.
|
|
242
|
+
*/
|
|
243
|
+
delete: operations["deleteAccountProjectToken"];
|
|
244
|
+
options?: never;
|
|
245
|
+
head?: never;
|
|
246
|
+
patch?: never;
|
|
247
|
+
trace?: never;
|
|
248
|
+
};
|
|
205
249
|
"/accounts/{accountSlug}/invite-link/reset": {
|
|
206
250
|
parameters: {
|
|
207
251
|
query?: never;
|
|
@@ -237,13 +281,13 @@ interface paths {
|
|
|
237
281
|
*
|
|
238
282
|
* Uploading takes three calls:
|
|
239
283
|
*
|
|
240
|
-
* 1. `POST /media
|
|
284
|
+
* 1. `POST /media`: declare the file and get back an `upload` target.
|
|
241
285
|
* 2. `POST` the file to `upload.url` as `multipart/form-data`, appending every entry of `upload.fields` **before** the `file` part.
|
|
242
|
-
* 3. `POST /media/{mediaId}/finalize
|
|
286
|
+
* 3. `POST /media/{mediaId}/finalize`: confirm the bytes landed.
|
|
243
287
|
*
|
|
244
288
|
* When `upload` comes back `null`, Argos already holds this exact file and steps 2 and 3 are unnecessary.
|
|
245
289
|
*
|
|
246
|
-
* Pass `prNumber` when the pull request already exists, or `branch` when it does not. A media uploaded against a branch is **staged**: it has its share URL immediately, and the moment a pull request opens for that branch Argos attaches it and posts the comment
|
|
290
|
+
* Pass `prNumber` when the pull request already exists, or `branch` when it does not. A media uploaded against a branch is **staged**: it has its share URL immediately, and the moment a pull request opens for that branch Argos attaches it and posts the comment. Nothing has to come back and connect the two.
|
|
247
291
|
*
|
|
248
292
|
* The `argos media upload` CLI command does all of this in one step.
|
|
249
293
|
*/
|
|
@@ -279,7 +323,7 @@ interface paths {
|
|
|
279
323
|
* Update a staged media
|
|
280
324
|
* @description Change a staged media's name, description or branch.
|
|
281
325
|
*
|
|
282
|
-
* Staged media only. A media's name and branch are its identity
|
|
326
|
+
* Staged media only. A media's name and branch are its identity: they decide whether the next upload of that name is a new version or a new media, and which pull request will publish it. Once it is published, that identity is what the pull request comment is built from and what a reviewer's comments hang off. Editing it there would rewrite history rather than correct a staged media.
|
|
283
327
|
*
|
|
284
328
|
* Omitted fields are left alone. `description` and `branch` accept `null` to clear them; `name` is required and has no cleared state. Clearing a staged media's branch leaves it attached to nothing, so no pull request will ever publish it.
|
|
285
329
|
*/
|
|
@@ -297,9 +341,9 @@ interface paths {
|
|
|
297
341
|
* List a media's versions
|
|
298
342
|
* @description A media's most recent uploaded versions, newest first, up to 100.
|
|
299
343
|
*
|
|
300
|
-
* A separate call because it is rarely needed: a media usually has one version, and the media itself already carries the newest one flattened onto it. Check `versionCount` first
|
|
344
|
+
* A separate call because it is rarely needed: a media usually has one version, and the media itself already carries the newest one flattened onto it. Check `versionCount` first: at 1 there is nothing here you do not already have.
|
|
301
345
|
*
|
|
302
|
-
* When you do need it, it is because a comment carries the `mediaVersionId` it was written against. A pin describes a spot on *those* bytes, so feedback written on an earlier upload has to be read against that upload
|
|
346
|
+
* When you do need it, it is because a comment carries the `mediaVersionId` it was written against. A pin describes a spot on *those* bytes, so feedback written on an earlier upload has to be read against that upload. Match the id here to get its file.
|
|
303
347
|
*/
|
|
304
348
|
get: operations["listMediaVersions"];
|
|
305
349
|
put?: never;
|
|
@@ -345,7 +389,7 @@ interface paths {
|
|
|
345
389
|
put?: never;
|
|
346
390
|
/**
|
|
347
391
|
* Post a comment (or reply) on a media
|
|
348
|
-
* @description Post a comment on an uploaded media. Start a new thread, or reply to an existing one with `threadId`. Pass an `anchor` to pin the comment to a point on the image
|
|
392
|
+
* @description Post a comment on an uploaded media. Start a new thread, or reply to an existing one with `threadId`. Pass an `anchor` to pin the comment to a point on the image (normalized coordinates, so it survives any scaling). This is how a reviewer marks up a screenshot.
|
|
349
393
|
*/
|
|
350
394
|
post: operations["createMediaComment"];
|
|
351
395
|
delete?: never;
|
|
@@ -610,26 +654,6 @@ interface paths {
|
|
|
610
654
|
patch?: never;
|
|
611
655
|
trace?: never;
|
|
612
656
|
};
|
|
613
|
-
"/auth/cli/token": {
|
|
614
|
-
parameters: {
|
|
615
|
-
query?: never;
|
|
616
|
-
header?: never;
|
|
617
|
-
path?: never;
|
|
618
|
-
cookie?: never;
|
|
619
|
-
};
|
|
620
|
-
get?: never;
|
|
621
|
-
put?: never;
|
|
622
|
-
/**
|
|
623
|
-
* Exchange a CLI authorization code for a token
|
|
624
|
-
* @description Called by the CLI to exchange a PKCE authorization code for an API token.
|
|
625
|
-
*/
|
|
626
|
-
post: operations["exchangeCliToken"];
|
|
627
|
-
delete?: never;
|
|
628
|
-
options?: never;
|
|
629
|
-
head?: never;
|
|
630
|
-
patch?: never;
|
|
631
|
-
trace?: never;
|
|
632
|
-
};
|
|
633
657
|
"/auth/github-actions/oidc/exchange": {
|
|
634
658
|
parameters: {
|
|
635
659
|
query?: never;
|
|
@@ -699,7 +723,7 @@ interface paths {
|
|
|
699
723
|
};
|
|
700
724
|
/**
|
|
701
725
|
* Get the current project
|
|
702
|
-
* @description Retrieve the project associated with the project token used to authenticate the request.
|
|
726
|
+
* @description Retrieve the project associated with the project token used to authenticate the request. Any project token can read it, whatever its permissions.
|
|
703
727
|
*/
|
|
704
728
|
get: operations["getAuthProject"];
|
|
705
729
|
put?: never;
|
|
@@ -833,7 +857,7 @@ interface paths {
|
|
|
833
857
|
put?: never;
|
|
834
858
|
/**
|
|
835
859
|
* Deactivate an automation rule
|
|
836
|
-
* @description Stop a rule from firing. Rules are never deleted
|
|
860
|
+
* @description Stop a rule from firing. Rules are never deleted: a deactivated one keeps its run history, which is what tells you why something fired. Requires administrator access to the project.
|
|
837
861
|
*/
|
|
838
862
|
post: operations["deactivateAutomationRule"];
|
|
839
863
|
delete?: never;
|
|
@@ -851,7 +875,7 @@ interface paths {
|
|
|
851
875
|
};
|
|
852
876
|
/**
|
|
853
877
|
* List a project's contributors
|
|
854
|
-
* @description List the users explicitly granted access to a project, with their level. Team owners and members are not listed
|
|
878
|
+
* @description List the users explicitly granted access to a project, with their level. Team owners and members are not listed: they reach every project through their team role. The authenticated user comes first when they are one of them.
|
|
855
879
|
*/
|
|
856
880
|
get: operations["listProjectContributors"];
|
|
857
881
|
put?: never;
|
|
@@ -878,7 +902,7 @@ interface paths {
|
|
|
878
902
|
post?: never;
|
|
879
903
|
/**
|
|
880
904
|
* Revoke a contributor's access
|
|
881
|
-
* @description Revoke a user's access to a project. Requires administrator access to the project, except when removing yourself
|
|
905
|
+
* @description Revoke a user's access to a project. Requires administrator access to the project, except when removing yourself: a contributor can always walk away from a project.
|
|
882
906
|
*/
|
|
883
907
|
delete: operations["removeProjectContributor"];
|
|
884
908
|
options?: never;
|
|
@@ -886,6 +910,50 @@ interface paths {
|
|
|
886
910
|
patch?: never;
|
|
887
911
|
trace?: never;
|
|
888
912
|
};
|
|
913
|
+
"/projects/{owner}/{project}/tokens": {
|
|
914
|
+
parameters: {
|
|
915
|
+
query?: never;
|
|
916
|
+
header?: never;
|
|
917
|
+
path?: never;
|
|
918
|
+
cookie?: never;
|
|
919
|
+
};
|
|
920
|
+
/**
|
|
921
|
+
* List a project's tokens
|
|
922
|
+
* @description List the tokens linked to a project, including the ones linked to other projects too. Requires the reviewer role on the project.
|
|
923
|
+
*/
|
|
924
|
+
get: operations["listProjectTokens"];
|
|
925
|
+
put?: never;
|
|
926
|
+
/**
|
|
927
|
+
* Create a project token
|
|
928
|
+
* @description Create a token linked to a project, to set as `ARGOS_TOKEN` in CI. To rotate a token without downtime, create its replacement, update the CI secret, then revoke the old one. Requires administrator access to the project.
|
|
929
|
+
*/
|
|
930
|
+
post: operations["createProjectToken"];
|
|
931
|
+
delete?: never;
|
|
932
|
+
options?: never;
|
|
933
|
+
head?: never;
|
|
934
|
+
patch?: never;
|
|
935
|
+
trace?: never;
|
|
936
|
+
};
|
|
937
|
+
"/projects/{owner}/{project}/tokens/{tokenId}": {
|
|
938
|
+
parameters: {
|
|
939
|
+
query?: never;
|
|
940
|
+
header?: never;
|
|
941
|
+
path?: never;
|
|
942
|
+
cookie?: never;
|
|
943
|
+
};
|
|
944
|
+
get?: never;
|
|
945
|
+
put?: never;
|
|
946
|
+
post?: never;
|
|
947
|
+
/**
|
|
948
|
+
* Revoke a project token
|
|
949
|
+
* @description Revoke a token linked to a project: CI using it is rejected from its next request. Requires administrator access to every project the token is linked to, or to the account.
|
|
950
|
+
*/
|
|
951
|
+
delete: operations["deleteProjectToken"];
|
|
952
|
+
options?: never;
|
|
953
|
+
head?: never;
|
|
954
|
+
patch?: never;
|
|
955
|
+
trace?: never;
|
|
956
|
+
};
|
|
889
957
|
"/projects/{owner}/{project}/transfer": {
|
|
890
958
|
parameters: {
|
|
891
959
|
query?: never;
|
|
@@ -917,7 +985,7 @@ interface paths {
|
|
|
917
985
|
* List a project's media
|
|
918
986
|
* @description List the standalone images and videos uploaded to a project, most recent first.
|
|
919
987
|
*
|
|
920
|
-
* `branch` and `prNumber` are what this is usually for: everything uploaded for the work in hand, whether or not a pull request exists yet. `branch` covers both
|
|
988
|
+
* `branch` and `prNumber` are what this is usually for: everything uploaded for the work in hand, whether or not a pull request exists yet. `branch` covers both (a media keeps its branch after publishing), so it stays a single query across the moment the pull request opens.
|
|
921
989
|
*/
|
|
922
990
|
get: operations["listMedia"];
|
|
923
991
|
put?: never;
|
|
@@ -977,7 +1045,7 @@ interface paths {
|
|
|
977
1045
|
};
|
|
978
1046
|
/**
|
|
979
1047
|
* List a build's screenshot diffs
|
|
980
|
-
* @description List the screenshot diffs of a build, with pagination. Each diff compares a baseline screenshot to the one captured by the build. Each diff also carries its test's flakiness metrics and, when it is a change, its ignore state and occurrence count
|
|
1048
|
+
* @description List the screenshot diffs of a build, with pagination. Each diff compares a baseline screenshot to the one captured by the build. Each diff also carries its test's flakiness metrics and, when it is a change, its ignore state and occurrence count, so you can tell whether a change is worth reviewing or is just a flaky one. Use `needsReview` to return only the diffs that require review.
|
|
981
1049
|
*/
|
|
982
1050
|
get: operations["listBuildDiffs"];
|
|
983
1051
|
put?: never;
|
|
@@ -1091,7 +1159,7 @@ interface paths {
|
|
|
1091
1159
|
put?: never;
|
|
1092
1160
|
/**
|
|
1093
1161
|
* Subscribe to a build
|
|
1094
|
-
* @description Start receiving notifications about a build
|
|
1162
|
+
* @description Start receiving notifications about a build: new comments, reviews, and status changes. Clears a previous explicit unsubscription.
|
|
1095
1163
|
*/
|
|
1096
1164
|
post: operations["subscribeBuild"];
|
|
1097
1165
|
/**
|
|
@@ -1115,7 +1183,7 @@ interface paths {
|
|
|
1115
1183
|
put?: never;
|
|
1116
1184
|
/**
|
|
1117
1185
|
* Subscribe to a test
|
|
1118
|
-
* @description Start receiving notifications about a test
|
|
1186
|
+
* @description Start receiving notifications about a test: new comments and the changes it produces. Clears a previous explicit unsubscription.
|
|
1119
1187
|
*/
|
|
1120
1188
|
post: operations["subscribeTest"];
|
|
1121
1189
|
/**
|
|
@@ -1297,7 +1365,7 @@ interface paths {
|
|
|
1297
1365
|
};
|
|
1298
1366
|
/**
|
|
1299
1367
|
* List a project's tests
|
|
1300
|
-
* @description List the tests currently running in a project, flakiest first. A test is listed when it appeared in the latest reference build of its build name
|
|
1368
|
+
* @description List the tests currently running in a project, flakiest first. A test is listed when it appeared in the latest reference build of its build name. Tests that were deleted, renamed or skipped drop out. Use it to find what to stabilise: the first page is the project's flakiness backlog.
|
|
1301
1369
|
*/
|
|
1302
1370
|
get: operations["listTests"];
|
|
1303
1371
|
put?: never;
|
|
@@ -1317,7 +1385,7 @@ interface paths {
|
|
|
1317
1385
|
};
|
|
1318
1386
|
/**
|
|
1319
1387
|
* List a project's deployments
|
|
1320
|
-
* @description List a project's deployments, most recent first. Use `environment` to keep only the production ones
|
|
1388
|
+
* @description List a project's deployments, most recent first. Use `environment` to keep only the production ones: the deployments that answer "what is live right now?".
|
|
1321
1389
|
*/
|
|
1322
1390
|
get: operations["listProjectDeployments"];
|
|
1323
1391
|
put?: never;
|
|
@@ -1401,7 +1469,7 @@ interface paths {
|
|
|
1401
1469
|
};
|
|
1402
1470
|
/**
|
|
1403
1471
|
* List a test's changes
|
|
1404
|
-
* @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
|
|
1472
|
+
* @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`.
|
|
1405
1473
|
*/
|
|
1406
1474
|
get: operations["listTestChanges"];
|
|
1407
1475
|
put?: never;
|
|
@@ -1566,6 +1634,16 @@ interface components {
|
|
|
1566
1634
|
* @enum {string}
|
|
1567
1635
|
*/
|
|
1568
1636
|
TeamUserLevel: "owner" | "member" | "contributor";
|
|
1637
|
+
/**
|
|
1638
|
+
* @description What a project token can do on its projects:
|
|
1639
|
+
* - `builds:write`: Create, update and finalize builds and their screenshots.
|
|
1640
|
+
* - `deployments:write`: Create and finalize deployments.
|
|
1641
|
+
* - `projects:read`: Read builds, screenshot diffs, tests and deployments.
|
|
1642
|
+
* - `media:read`: Read the images and videos uploaded to the projects.
|
|
1643
|
+
* - `media:write`: Upload images and videos, and delete the ones already uploaded.
|
|
1644
|
+
* @enum {string}
|
|
1645
|
+
*/
|
|
1646
|
+
ProjectTokenPermission: "builds:write" | "deployments:write" | "projects:read" | "media:read" | "media:write";
|
|
1569
1647
|
/** @description The public ID of the comment (e.g. `comment-xf23d`) */
|
|
1570
1648
|
CommentId: string;
|
|
1571
1649
|
/** @description Public ID of any comment in the thread (e.g. `comment-xf23d`) */
|
|
@@ -1692,6 +1770,10 @@ interface components {
|
|
|
1692
1770
|
/** @description True if the story has a play function */
|
|
1693
1771
|
play?: boolean;
|
|
1694
1772
|
} | null;
|
|
1773
|
+
capture?: {
|
|
1774
|
+
/** @description The 0-based position of the screenshot within its test, following capture order */
|
|
1775
|
+
index: number;
|
|
1776
|
+
} | null;
|
|
1695
1777
|
/** @description Tags associated to the screenshot */
|
|
1696
1778
|
tags?: string[];
|
|
1697
1779
|
} | null;
|
|
@@ -1722,6 +1804,11 @@ interface components {
|
|
|
1722
1804
|
* @enum {string}
|
|
1723
1805
|
*/
|
|
1724
1806
|
SummaryCheck: "always" | "never" | "auto";
|
|
1807
|
+
/**
|
|
1808
|
+
* @description Status reported to the Git provider while a build has changes waiting for a review: `failure`, or `pending` until the build is approved or rejected (`running` on GitLab).
|
|
1809
|
+
* @enum {string}
|
|
1810
|
+
*/
|
|
1811
|
+
AwaitingReviewStatus: "failure" | "pending";
|
|
1725
1812
|
/**
|
|
1726
1813
|
* @description Access level given to team members that are not explicit contributors on the project. `null` means they get no access.
|
|
1727
1814
|
* @enum {string}
|
|
@@ -1877,7 +1964,9 @@ interface components {
|
|
|
1877
1964
|
projects: {
|
|
1878
1965
|
[key: string]: number;
|
|
1879
1966
|
};
|
|
1880
|
-
/** @description
|
|
1967
|
+
/** @description Screenshots captured from Storybook stories. Already included in `total`, so the rest of the test suite is `total - storybook`. */
|
|
1968
|
+
storybook: number;
|
|
1969
|
+
/** @description Unix timestamp in milliseconds at the start of the period: midnight in `timeZone`, UTC by default. */
|
|
1881
1970
|
ts: number;
|
|
1882
1971
|
}[];
|
|
1883
1972
|
all: {
|
|
@@ -1886,6 +1975,8 @@ interface components {
|
|
|
1886
1975
|
projects: {
|
|
1887
1976
|
[key: string]: number;
|
|
1888
1977
|
};
|
|
1978
|
+
/** @description Screenshots captured from Storybook stories. Already included in `total`, so the rest of the test suite is `total - storybook`. */
|
|
1979
|
+
storybook: number;
|
|
1889
1980
|
};
|
|
1890
1981
|
projects: {
|
|
1891
1982
|
id: string;
|
|
@@ -1903,7 +1994,7 @@ interface components {
|
|
|
1903
1994
|
noChanges: number;
|
|
1904
1995
|
accepted: number;
|
|
1905
1996
|
rejected: number;
|
|
1906
|
-
/** @description Unix timestamp in milliseconds at the start of the period. */
|
|
1997
|
+
/** @description Unix timestamp in milliseconds at the start of the period: midnight in `timeZone`, UTC by default. */
|
|
1907
1998
|
ts: number;
|
|
1908
1999
|
}[];
|
|
1909
2000
|
all: {
|
|
@@ -1939,13 +2030,16 @@ interface components {
|
|
|
1939
2030
|
name: string;
|
|
1940
2031
|
defaultBaseBranch: string;
|
|
1941
2032
|
hasRemoteContentAccess: boolean;
|
|
1942
|
-
/** @description Glob matching the branches whose builds are approved automatically. */
|
|
2033
|
+
/** @description Glob matching the branches whose builds are approved automatically. Ignored while `autoApprovalEnabled` is `false`. */
|
|
1943
2034
|
autoApprovedBranchGlob: string;
|
|
2035
|
+
/** @description Whether builds on branches matching `autoApprovedBranchGlob` are approved automatically. When `false`, every build needs a review, including the ones on the base branch. */
|
|
2036
|
+
autoApprovalEnabled: boolean;
|
|
1944
2037
|
/** @description Glob matching the branches whose deployments are treated as production. */
|
|
1945
2038
|
deploymentProductionBranchGlob: string;
|
|
1946
2039
|
/** @description Whether the project is private. Resolved from the linked repository unless overridden. */
|
|
1947
2040
|
private: boolean;
|
|
1948
2041
|
summaryCheck: components["schemas"]["SummaryCheck"];
|
|
2042
|
+
awaitingReviewStatus: components["schemas"]["AwaitingReviewStatus"];
|
|
1949
2043
|
/** @description Whether Argos comments on pull requests. */
|
|
1950
2044
|
prCommentEnabled: boolean;
|
|
1951
2045
|
/** @description Whether builds can authenticate with a GitHub Actions OIDC token instead of a project token. */
|
|
@@ -1995,6 +2089,33 @@ interface components {
|
|
|
1995
2089
|
/** Format: date-time */
|
|
1996
2090
|
createdAt: string;
|
|
1997
2091
|
};
|
|
2092
|
+
/** @description A token CI and the SDK authenticate with, set as `ARGOS_TOKEN`. Its value is only returned at creation. */
|
|
2093
|
+
ProjectToken: {
|
|
2094
|
+
id: string;
|
|
2095
|
+
name: string;
|
|
2096
|
+
/** @description Names of the projects of the account the token reaches, among the ones you can see. */
|
|
2097
|
+
projects: string[];
|
|
2098
|
+
permissions: components["schemas"]["ProjectTokenPermission"][];
|
|
2099
|
+
/** Format: date-time */
|
|
2100
|
+
createdAt: string;
|
|
2101
|
+
expireAt: string | null;
|
|
2102
|
+
/** @description When CI last authenticated with the token, to a few minutes. Once it stops moving, a replaced token can be revoked safely. */
|
|
2103
|
+
lastUsedAt: string | null;
|
|
2104
|
+
};
|
|
2105
|
+
CreatedProjectToken: {
|
|
2106
|
+
id: string;
|
|
2107
|
+
name: string;
|
|
2108
|
+
/** @description Names of the projects of the account the token reaches, among the ones you can see. */
|
|
2109
|
+
projects: string[];
|
|
2110
|
+
permissions: components["schemas"]["ProjectTokenPermission"][];
|
|
2111
|
+
/** Format: date-time */
|
|
2112
|
+
createdAt: string;
|
|
2113
|
+
expireAt: string | null;
|
|
2114
|
+
/** @description When CI last authenticated with the token, to a few minutes. Once it stops moving, a replaced token can be revoked safely. */
|
|
2115
|
+
lastUsedAt: string | null;
|
|
2116
|
+
/** @description The token itself. It is not stored and never returned again: save it now. */
|
|
2117
|
+
token: string;
|
|
2118
|
+
};
|
|
1998
2119
|
InviteLink: {
|
|
1999
2120
|
/**
|
|
2000
2121
|
* Format: uri
|
|
@@ -2022,14 +2143,14 @@ interface components {
|
|
|
2022
2143
|
prNumber: number | null;
|
|
2023
2144
|
/**
|
|
2024
2145
|
* Format: uri
|
|
2025
|
-
* @description Share page URL. This is the link to put in a pull request or a chat message, and it keeps working across versions
|
|
2146
|
+
* @description Share page URL. This is the link to put in a pull request or a chat message, and it keeps working across versions: it always shows the newest one.
|
|
2026
2147
|
*/
|
|
2027
2148
|
url: string;
|
|
2028
|
-
/** @description Ready-to-paste Markdown
|
|
2149
|
+
/** @description Ready-to-paste Markdown: the picture (the image itself, or a video's poster frame) embedded from the CDN and linked to the share page. Embed this rather than building your own from `url`: that is an HTML page, and an image embed pointing at it renders as a broken image. */
|
|
2029
2150
|
markdown: string;
|
|
2030
2151
|
/** @description Which version this response describes: 1 for a first upload, incrementing each time the same name is uploaded again. */
|
|
2031
2152
|
version: number;
|
|
2032
|
-
/** @description How many uploaded versions this media has. Above 1, `GET /media/{mediaId}/versions` lists them
|
|
2153
|
+
/** @description How many uploaded versions this media has. Above 1, `GET /media/{mediaId}/versions` lists them, which is how a comment's `mediaVersionId` resolves to the file it was written against. */
|
|
2033
2154
|
versionCount: number;
|
|
2034
2155
|
/**
|
|
2035
2156
|
* Format: uri
|
|
@@ -2052,7 +2173,7 @@ interface components {
|
|
|
2052
2173
|
*/
|
|
2053
2174
|
visibility: "team" | "public";
|
|
2054
2175
|
/**
|
|
2055
|
-
* @description `pending` until the bytes are uploaded, then `ready`. There is no processing step
|
|
2176
|
+
* @description `pending` until the bytes are uploaded, then `ready`. There is no processing step: Argos serves the bytes it was given.
|
|
2056
2177
|
* @enum {string}
|
|
2057
2178
|
*/
|
|
2058
2179
|
status: "pending" | "ready";
|
|
@@ -2074,7 +2195,7 @@ interface components {
|
|
|
2074
2195
|
};
|
|
2075
2196
|
/** @description One uploaded version of a media */
|
|
2076
2197
|
MediaVersion: {
|
|
2077
|
-
/** @description Unique identifier of this version
|
|
2198
|
+
/** @description Unique identifier of this version: what a comment's `mediaVersionId` points at. */
|
|
2078
2199
|
id: string;
|
|
2079
2200
|
/** @description 1-based, and what the UI calls the version. Increments each time the same name is uploaded again. */
|
|
2080
2201
|
number: number;
|
|
@@ -2095,7 +2216,7 @@ interface components {
|
|
|
2095
2216
|
};
|
|
2096
2217
|
/** @description A comment posted on a build or on a test. */
|
|
2097
2218
|
Comment: {
|
|
2098
|
-
/** @description Public ID of the comment (e.g. `comment-xf23d`)
|
|
2219
|
+
/** @description Public ID of the comment (e.g. `comment-xf23d`): the one the app links to, and the one every endpoint taking a comment ID expects. */
|
|
2099
2220
|
id: string;
|
|
2100
2221
|
/** @description Build this comment is posted on, null when it is posted on a test. */
|
|
2101
2222
|
buildId: string | null;
|
|
@@ -2103,7 +2224,7 @@ interface components {
|
|
|
2103
2224
|
testId: string | null;
|
|
2104
2225
|
/** @description Media this comment is posted on, null when it is posted on a build or a test. */
|
|
2105
2226
|
mediaId: string | null;
|
|
2106
|
-
/** @description Version of the media the comment was written against. A pin describes a spot on the bytes its author was looking at, so feedback on an older upload has to be read against that upload
|
|
2227
|
+
/** @description Version of the media the comment was written against. A pin describes a spot on the bytes its author was looking at, so feedback on an older upload has to be read against that upload. Match this id against `GET /media/{mediaId}/versions` to get the right file. */
|
|
2107
2228
|
mediaVersionId: string | null;
|
|
2108
2229
|
/** @description Root comment ID when this comment is a reply. */
|
|
2109
2230
|
threadId: string | null;
|
|
@@ -2112,6 +2233,8 @@ interface components {
|
|
|
2112
2233
|
/** @description Plain-text rendering of the comment content. */
|
|
2113
2234
|
text: string;
|
|
2114
2235
|
author: components["schemas"]["User"] | null;
|
|
2236
|
+
/** @description The coding agent that posted the comment on the author's behalf. Null when the author posted it directly. */
|
|
2237
|
+
agent: components["schemas"]["Agent"] | null;
|
|
2115
2238
|
/** @description Screenshot diff this comment is anchored to, if any. */
|
|
2116
2239
|
screenshotDiffId: string | null;
|
|
2117
2240
|
/** @description Where the comment points on its screenshot diff. Null means the whole diff. */
|
|
@@ -2143,6 +2266,13 @@ interface components {
|
|
|
2143
2266
|
users: components["schemas"]["User"][];
|
|
2144
2267
|
}[];
|
|
2145
2268
|
};
|
|
2269
|
+
/** @description A coding agent acting on behalf of a user. */
|
|
2270
|
+
Agent: {
|
|
2271
|
+
/** @description Stable id of the agent, e.g. `claude-code`. `unknown` when it could not be identified. */
|
|
2272
|
+
id: string;
|
|
2273
|
+
/** @description Name to display, e.g. `Claude Code`. Null for an agent we cannot name. */
|
|
2274
|
+
name: string | null;
|
|
2275
|
+
};
|
|
2146
2276
|
/** @description Build */
|
|
2147
2277
|
Build: {
|
|
2148
2278
|
id: components["schemas"]["BuildId"];
|
|
@@ -2211,6 +2341,11 @@ interface components {
|
|
|
2211
2341
|
/** @enum {string} */
|
|
2212
2342
|
state: "pending" | "running" | "success" | "failed" | "canceled";
|
|
2213
2343
|
};
|
|
2344
|
+
origin: {
|
|
2345
|
+
/** @enum {string} */
|
|
2346
|
+
status: "queued" | "in_progress" | "completed";
|
|
2347
|
+
conclusion: ("success" | "failure") | null;
|
|
2348
|
+
};
|
|
2214
2349
|
/** Format: uri */
|
|
2215
2350
|
url: string;
|
|
2216
2351
|
} | null;
|
|
@@ -2382,6 +2517,10 @@ interface components {
|
|
|
2382
2517
|
/** @description True if the story has a play function */
|
|
2383
2518
|
play?: boolean;
|
|
2384
2519
|
} | null;
|
|
2520
|
+
capture?: {
|
|
2521
|
+
/** @description The 0-based position of the screenshot within its test, following capture order */
|
|
2522
|
+
index: number;
|
|
2523
|
+
} | null;
|
|
2385
2524
|
/** @description Tags associated to the screenshot */
|
|
2386
2525
|
tags?: string[];
|
|
2387
2526
|
} | null;
|
|
@@ -2391,7 +2530,7 @@ interface components {
|
|
|
2391
2530
|
height: number | null;
|
|
2392
2531
|
/**
|
|
2393
2532
|
* Format: uri
|
|
2394
|
-
* @description Public URL of the snapshot
|
|
2533
|
+
* @description Public URL of the snapshot file, as it was uploaded
|
|
2395
2534
|
*/
|
|
2396
2535
|
url: string;
|
|
2397
2536
|
/** @description Content type of the snapshot file */
|
|
@@ -2494,6 +2633,10 @@ interface components {
|
|
|
2494
2633
|
/** @description True if the story has a play function */
|
|
2495
2634
|
play?: boolean;
|
|
2496
2635
|
} | null;
|
|
2636
|
+
capture?: {
|
|
2637
|
+
/** @description The 0-based position of the screenshot within its test, following capture order */
|
|
2638
|
+
index: number;
|
|
2639
|
+
} | null;
|
|
2497
2640
|
/** @description Tags associated to the screenshot */
|
|
2498
2641
|
tags?: string[];
|
|
2499
2642
|
} | null;
|
|
@@ -2503,7 +2646,7 @@ interface components {
|
|
|
2503
2646
|
height: number | null;
|
|
2504
2647
|
/**
|
|
2505
2648
|
* Format: uri
|
|
2506
|
-
* @description Public URL of the snapshot
|
|
2649
|
+
* @description Public URL of the snapshot file, as it was uploaded
|
|
2507
2650
|
*/
|
|
2508
2651
|
url: string;
|
|
2509
2652
|
/** @description Content type of the snapshot file */
|
|
@@ -2561,6 +2704,8 @@ interface components {
|
|
|
2561
2704
|
dismissedAt: string | null;
|
|
2562
2705
|
/** @description The user who dismissed the review, if any. */
|
|
2563
2706
|
dismissedBy: components["schemas"]["User"] | null;
|
|
2707
|
+
/** @description The coding agent that submitted the review on the reviewer's behalf. Null when they submitted it themselves. */
|
|
2708
|
+
agent: components["schemas"]["Agent"] | null;
|
|
2564
2709
|
/** @description Date the review was created. */
|
|
2565
2710
|
date: string;
|
|
2566
2711
|
};
|
|
@@ -2620,7 +2765,7 @@ interface components {
|
|
|
2620
2765
|
lastSeenChange: components["schemas"]["TestChangeOccurrence"] | null;
|
|
2621
2766
|
};
|
|
2622
2767
|
/**
|
|
2623
|
-
* @description `ongoing` when the test still runs
|
|
2768
|
+
* @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.
|
|
2624
2769
|
* @enum {string}
|
|
2625
2770
|
*/
|
|
2626
2771
|
TestStatus: "ongoing" | "removed";
|
|
@@ -2899,6 +3044,8 @@ interface operations {
|
|
|
2899
3044
|
to?: string;
|
|
2900
3045
|
/** @description Time period used to group each series data point. */
|
|
2901
3046
|
groupBy: "day" | "week" | "month";
|
|
3047
|
+
/** @description IANA time zone that periods start in, such as `Europe/Paris`. Defaults to UTC. Set `from` to midnight in that zone, such as `2026-11-02T00:00:00+01:00`, to get a whole first period. */
|
|
3048
|
+
timeZone?: string;
|
|
2902
3049
|
/** @description Optional project name filter. Pass one value or repeat the parameter for multiple projects. */
|
|
2903
3050
|
projectNames?: string | string[];
|
|
2904
3051
|
};
|
|
@@ -3105,7 +3252,7 @@ interface operations {
|
|
|
3105
3252
|
path: {
|
|
3106
3253
|
/** @description Slug of the team. */
|
|
3107
3254
|
accountSlug: string;
|
|
3108
|
-
/** @description Identifier of the user to act on
|
|
3255
|
+
/** @description Identifier of the user to act on: the `user.id` returned by `listAccountMembers`, which is the user's account id. */
|
|
3109
3256
|
userId: string;
|
|
3110
3257
|
};
|
|
3111
3258
|
cookie?: never;
|
|
@@ -3173,7 +3320,7 @@ interface operations {
|
|
|
3173
3320
|
path: {
|
|
3174
3321
|
/** @description Slug of the team. */
|
|
3175
3322
|
accountSlug: string;
|
|
3176
|
-
/** @description Identifier of the user to act on
|
|
3323
|
+
/** @description Identifier of the user to act on: the `user.id` returned by `listAccountMembers`, which is the user's account id. */
|
|
3177
3324
|
userId: string;
|
|
3178
3325
|
};
|
|
3179
3326
|
cookie?: never;
|
|
@@ -3678,25 +3825,25 @@ interface operations {
|
|
|
3678
3825
|
};
|
|
3679
3826
|
};
|
|
3680
3827
|
};
|
|
3681
|
-
|
|
3828
|
+
listAccountProjectTokens: {
|
|
3682
3829
|
parameters: {
|
|
3683
3830
|
query?: never;
|
|
3684
3831
|
header?: never;
|
|
3685
3832
|
path: {
|
|
3686
|
-
/** @description Slug of the
|
|
3833
|
+
/** @description Slug of the account. */
|
|
3687
3834
|
accountSlug: string;
|
|
3688
3835
|
};
|
|
3689
3836
|
cookie?: never;
|
|
3690
3837
|
};
|
|
3691
3838
|
requestBody?: never;
|
|
3692
3839
|
responses: {
|
|
3693
|
-
/** @description The
|
|
3840
|
+
/** @description The account's project tokens, newest first */
|
|
3694
3841
|
200: {
|
|
3695
3842
|
headers: {
|
|
3696
3843
|
[name: string]: unknown;
|
|
3697
3844
|
};
|
|
3698
3845
|
content: {
|
|
3699
|
-
"application/json": components["schemas"]["
|
|
3846
|
+
"application/json": components["schemas"]["ProjectToken"][];
|
|
3700
3847
|
};
|
|
3701
3848
|
};
|
|
3702
3849
|
/** @description Invalid parameters */
|
|
@@ -3746,55 +3893,47 @@ interface operations {
|
|
|
3746
3893
|
};
|
|
3747
3894
|
};
|
|
3748
3895
|
};
|
|
3749
|
-
|
|
3896
|
+
createAccountProjectToken: {
|
|
3750
3897
|
parameters: {
|
|
3751
3898
|
query?: never;
|
|
3752
3899
|
header?: never;
|
|
3753
|
-
path
|
|
3900
|
+
path: {
|
|
3901
|
+
/** @description Slug of the account. */
|
|
3902
|
+
accountSlug: string;
|
|
3903
|
+
};
|
|
3754
3904
|
cookie?: never;
|
|
3755
3905
|
};
|
|
3756
|
-
requestBody
|
|
3906
|
+
requestBody: {
|
|
3757
3907
|
content: {
|
|
3758
3908
|
"application/json": {
|
|
3759
|
-
/**
|
|
3760
|
-
* @description File name, used for display and as the Markdown alt text. Also the media's identity: uploading the same name on the same pull request adds a version rather than creating a second media.
|
|
3761
|
-
* @example before.png
|
|
3762
|
-
* @example checkout-flow.mp4
|
|
3763
|
-
*/
|
|
3909
|
+
/** @description A name to recognize the token, e.g. `GitHub Actions`. */
|
|
3764
3910
|
name: string;
|
|
3765
|
-
state?: ("before" | "after") | null;
|
|
3766
|
-
/** @description Prose shown under the media in the managed pull request comment. */
|
|
3767
|
-
description?: string | null;
|
|
3768
|
-
/** @description Content type of the media file */
|
|
3769
|
-
contentType: string;
|
|
3770
|
-
/** @description Size of the file in bytes. Checked against your plan's limit before the upload is signed. */
|
|
3771
|
-
size: number;
|
|
3772
|
-
/** @description SHA-256 of the file contents, hex encoded. Uploading the same file twice is free: Argos recognizes the hash and skips the transfer, and byte-identical bytes do not create a new version. */
|
|
3773
|
-
hash: string;
|
|
3774
|
-
visibility?: ("team" | "public") | null;
|
|
3775
3911
|
/**
|
|
3776
|
-
* @description
|
|
3777
|
-
* @
|
|
3912
|
+
* @description What the token can do. Defaults to every permission.
|
|
3913
|
+
* @default [
|
|
3914
|
+
* "builds:write",
|
|
3915
|
+
* "deployments:write",
|
|
3916
|
+
* "projects:read",
|
|
3917
|
+
* "media:read",
|
|
3918
|
+
* "media:write"
|
|
3919
|
+
* ]
|
|
3778
3920
|
*/
|
|
3779
|
-
|
|
3780
|
-
/** @description
|
|
3781
|
-
|
|
3782
|
-
|
|
3921
|
+
permissions?: components["schemas"]["ProjectTokenPermission"][];
|
|
3922
|
+
/** @description When the token stops working, or `null` for a token that never expires. */
|
|
3923
|
+
expireAt: string | null;
|
|
3924
|
+
/** @description Names of the projects of the account to link. */
|
|
3925
|
+
projects: string[];
|
|
3783
3926
|
};
|
|
3784
3927
|
};
|
|
3785
3928
|
};
|
|
3786
3929
|
responses: {
|
|
3787
|
-
/** @description The
|
|
3930
|
+
/** @description The created token, with its value */
|
|
3788
3931
|
201: {
|
|
3789
3932
|
headers: {
|
|
3790
3933
|
[name: string]: unknown;
|
|
3791
3934
|
};
|
|
3792
3935
|
content: {
|
|
3793
|
-
"application/json":
|
|
3794
|
-
media: components["schemas"]["Media"];
|
|
3795
|
-
/** @description Where to send the bytes, or `null` when Argos already holds this exact file — in which case the media is ready and nothing needs uploading. */
|
|
3796
|
-
upload: components["schemas"]["MediaUploadTarget"] | null;
|
|
3797
|
-
};
|
|
3936
|
+
"application/json": components["schemas"]["CreatedProjectToken"];
|
|
3798
3937
|
};
|
|
3799
3938
|
};
|
|
3800
3939
|
/** @description Invalid parameters */
|
|
@@ -3844,26 +3983,26 @@ interface operations {
|
|
|
3844
3983
|
};
|
|
3845
3984
|
};
|
|
3846
3985
|
};
|
|
3847
|
-
|
|
3986
|
+
deleteAccountProjectToken: {
|
|
3848
3987
|
parameters: {
|
|
3849
3988
|
query?: never;
|
|
3850
3989
|
header?: never;
|
|
3851
3990
|
path: {
|
|
3852
|
-
/** @description
|
|
3853
|
-
|
|
3991
|
+
/** @description Slug of the account. */
|
|
3992
|
+
accountSlug: string;
|
|
3993
|
+
/** @description ID of the token. */
|
|
3994
|
+
tokenId: string;
|
|
3854
3995
|
};
|
|
3855
3996
|
cookie?: never;
|
|
3856
3997
|
};
|
|
3857
3998
|
requestBody?: never;
|
|
3858
3999
|
responses: {
|
|
3859
|
-
/** @description
|
|
3860
|
-
|
|
4000
|
+
/** @description Token revoked */
|
|
4001
|
+
204: {
|
|
3861
4002
|
headers: {
|
|
3862
4003
|
[name: string]: unknown;
|
|
3863
4004
|
};
|
|
3864
|
-
content
|
|
3865
|
-
"application/json": components["schemas"]["Media"];
|
|
3866
|
-
};
|
|
4005
|
+
content?: never;
|
|
3867
4006
|
};
|
|
3868
4007
|
/** @description Invalid parameters */
|
|
3869
4008
|
400: {
|
|
@@ -3912,24 +4051,26 @@ interface operations {
|
|
|
3912
4051
|
};
|
|
3913
4052
|
};
|
|
3914
4053
|
};
|
|
3915
|
-
|
|
4054
|
+
resetAccountInviteLink: {
|
|
3916
4055
|
parameters: {
|
|
3917
4056
|
query?: never;
|
|
3918
4057
|
header?: never;
|
|
3919
4058
|
path: {
|
|
3920
|
-
/** @description
|
|
3921
|
-
|
|
4059
|
+
/** @description Slug of the team. */
|
|
4060
|
+
accountSlug: string;
|
|
3922
4061
|
};
|
|
3923
4062
|
cookie?: never;
|
|
3924
4063
|
};
|
|
3925
4064
|
requestBody?: never;
|
|
3926
4065
|
responses: {
|
|
3927
|
-
/** @description
|
|
3928
|
-
|
|
4066
|
+
/** @description The new invite link */
|
|
4067
|
+
200: {
|
|
3929
4068
|
headers: {
|
|
3930
4069
|
[name: string]: unknown;
|
|
3931
4070
|
};
|
|
3932
|
-
content
|
|
4071
|
+
content: {
|
|
4072
|
+
"application/json": components["schemas"]["InviteLink"];
|
|
4073
|
+
};
|
|
3933
4074
|
};
|
|
3934
4075
|
/** @description Invalid parameters */
|
|
3935
4076
|
400: {
|
|
@@ -3978,14 +4119,11 @@ interface operations {
|
|
|
3978
4119
|
};
|
|
3979
4120
|
};
|
|
3980
4121
|
};
|
|
3981
|
-
|
|
4122
|
+
createMedia: {
|
|
3982
4123
|
parameters: {
|
|
3983
4124
|
query?: never;
|
|
3984
4125
|
header?: never;
|
|
3985
|
-
path
|
|
3986
|
-
/** @description The media ID */
|
|
3987
|
-
mediaId: string;
|
|
3988
|
-
};
|
|
4126
|
+
path?: never;
|
|
3989
4127
|
cookie?: never;
|
|
3990
4128
|
};
|
|
3991
4129
|
requestBody?: {
|
|
@@ -3996,21 +4134,41 @@ interface operations {
|
|
|
3996
4134
|
* @example before.png
|
|
3997
4135
|
* @example checkout-flow.mp4
|
|
3998
4136
|
*/
|
|
3999
|
-
name
|
|
4137
|
+
name: string;
|
|
4138
|
+
state?: ("before" | "after") | null;
|
|
4000
4139
|
/** @description Prose shown under the media in the managed pull request comment. */
|
|
4001
4140
|
description?: string | null;
|
|
4141
|
+
/** @description Content type of the media file */
|
|
4142
|
+
contentType: string;
|
|
4143
|
+
/** @description Size of the file in bytes. Checked against your plan's limit before the upload is signed. */
|
|
4144
|
+
size: number;
|
|
4145
|
+
/** @description SHA-256 of the file contents, hex encoded. Uploading the same file twice is free: Argos recognizes the hash and skips the transfer, and byte-identical bytes do not create a new version. */
|
|
4146
|
+
hash: string;
|
|
4147
|
+
/** @description Who can open the media share page. `team` requires an Argos session with access to the owning account; `public` only requires the share URL. Omit it (the usual case) and the media follows its project's visibility: `public` for a public project, `team` for a private one. `team` requires a paid plan. */
|
|
4148
|
+
visibility?: ("team" | "public") | null;
|
|
4149
|
+
/**
|
|
4150
|
+
* @description Project to upload to, as `owner/project`. Required with a personal access token, and with a project token linked to several projects.
|
|
4151
|
+
* @example acme/web
|
|
4152
|
+
*/
|
|
4153
|
+
project?: string | null;
|
|
4154
|
+
/** @description Pull request this media belongs to. Argos maintains a single comment on it listing every media uploaded, editing it in place rather than posting a new one each time. Attaching a media to a pull request and showing it there are the same act, not two. Also part of the media's identity: uploading the same name again on this pull request adds a version. */
|
|
4155
|
+
prNumber?: number | null;
|
|
4002
4156
|
branch?: string | null;
|
|
4003
4157
|
};
|
|
4004
4158
|
};
|
|
4005
4159
|
};
|
|
4006
4160
|
responses: {
|
|
4007
|
-
/** @description The
|
|
4008
|
-
|
|
4161
|
+
/** @description The registered media and where to upload it */
|
|
4162
|
+
201: {
|
|
4009
4163
|
headers: {
|
|
4010
4164
|
[name: string]: unknown;
|
|
4011
4165
|
};
|
|
4012
4166
|
content: {
|
|
4013
|
-
"application/json":
|
|
4167
|
+
"application/json": {
|
|
4168
|
+
media: components["schemas"]["Media"];
|
|
4169
|
+
/** @description Where to send the bytes, or `null` when Argos already holds this exact file, in which case the media is ready and nothing needs uploading. */
|
|
4170
|
+
upload: components["schemas"]["MediaUploadTarget"] | null;
|
|
4171
|
+
};
|
|
4014
4172
|
};
|
|
4015
4173
|
};
|
|
4016
4174
|
/** @description Invalid parameters */
|
|
@@ -4060,7 +4218,7 @@ interface operations {
|
|
|
4060
4218
|
};
|
|
4061
4219
|
};
|
|
4062
4220
|
};
|
|
4063
|
-
|
|
4221
|
+
getMedia: {
|
|
4064
4222
|
parameters: {
|
|
4065
4223
|
query?: never;
|
|
4066
4224
|
header?: never;
|
|
@@ -4072,13 +4230,13 @@ interface operations {
|
|
|
4072
4230
|
};
|
|
4073
4231
|
requestBody?: never;
|
|
4074
4232
|
responses: {
|
|
4075
|
-
/** @description
|
|
4233
|
+
/** @description Media details */
|
|
4076
4234
|
200: {
|
|
4077
4235
|
headers: {
|
|
4078
4236
|
[name: string]: unknown;
|
|
4079
4237
|
};
|
|
4080
4238
|
content: {
|
|
4081
|
-
"application/json": components["schemas"]["
|
|
4239
|
+
"application/json": components["schemas"]["Media"];
|
|
4082
4240
|
};
|
|
4083
4241
|
};
|
|
4084
4242
|
/** @description Invalid parameters */
|
|
@@ -4128,7 +4286,7 @@ interface operations {
|
|
|
4128
4286
|
};
|
|
4129
4287
|
};
|
|
4130
4288
|
};
|
|
4131
|
-
|
|
4289
|
+
deleteMedia: {
|
|
4132
4290
|
parameters: {
|
|
4133
4291
|
query?: never;
|
|
4134
4292
|
header?: never;
|
|
@@ -4140,14 +4298,12 @@ interface operations {
|
|
|
4140
4298
|
};
|
|
4141
4299
|
requestBody?: never;
|
|
4142
4300
|
responses: {
|
|
4143
|
-
/** @description
|
|
4144
|
-
|
|
4301
|
+
/** @description Media deleted */
|
|
4302
|
+
204: {
|
|
4145
4303
|
headers: {
|
|
4146
4304
|
[name: string]: unknown;
|
|
4147
4305
|
};
|
|
4148
|
-
content
|
|
4149
|
-
"application/json": components["schemas"]["Media"];
|
|
4150
|
-
};
|
|
4306
|
+
content?: never;
|
|
4151
4307
|
};
|
|
4152
4308
|
/** @description Invalid parameters */
|
|
4153
4309
|
400: {
|
|
@@ -4196,7 +4352,7 @@ interface operations {
|
|
|
4196
4352
|
};
|
|
4197
4353
|
};
|
|
4198
4354
|
};
|
|
4199
|
-
|
|
4355
|
+
updateMedia: {
|
|
4200
4356
|
parameters: {
|
|
4201
4357
|
query?: never;
|
|
4202
4358
|
header?: never;
|
|
@@ -4206,15 +4362,29 @@ interface operations {
|
|
|
4206
4362
|
};
|
|
4207
4363
|
cookie?: never;
|
|
4208
4364
|
};
|
|
4209
|
-
requestBody?:
|
|
4365
|
+
requestBody?: {
|
|
4366
|
+
content: {
|
|
4367
|
+
"application/json": {
|
|
4368
|
+
/**
|
|
4369
|
+
* @description File name, used for display and as the Markdown alt text. Also the media's identity: uploading the same name on the same pull request adds a version rather than creating a second media.
|
|
4370
|
+
* @example before.png
|
|
4371
|
+
* @example checkout-flow.mp4
|
|
4372
|
+
*/
|
|
4373
|
+
name?: string;
|
|
4374
|
+
/** @description Prose shown under the media in the managed pull request comment. */
|
|
4375
|
+
description?: string | null;
|
|
4376
|
+
branch?: string | null;
|
|
4377
|
+
};
|
|
4378
|
+
};
|
|
4379
|
+
};
|
|
4210
4380
|
responses: {
|
|
4211
|
-
/** @description
|
|
4381
|
+
/** @description The updated media */
|
|
4212
4382
|
200: {
|
|
4213
4383
|
headers: {
|
|
4214
4384
|
[name: string]: unknown;
|
|
4215
4385
|
};
|
|
4216
4386
|
content: {
|
|
4217
|
-
"application/json": components["schemas"]["
|
|
4387
|
+
"application/json": components["schemas"]["Media"];
|
|
4218
4388
|
};
|
|
4219
4389
|
};
|
|
4220
4390
|
/** @description Invalid parameters */
|
|
@@ -4264,7 +4434,7 @@ interface operations {
|
|
|
4264
4434
|
};
|
|
4265
4435
|
};
|
|
4266
4436
|
};
|
|
4267
|
-
|
|
4437
|
+
listMediaVersions: {
|
|
4268
4438
|
parameters: {
|
|
4269
4439
|
query?: never;
|
|
4270
4440
|
header?: never;
|
|
@@ -4274,32 +4444,236 @@ interface operations {
|
|
|
4274
4444
|
};
|
|
4275
4445
|
cookie?: never;
|
|
4276
4446
|
};
|
|
4277
|
-
requestBody
|
|
4278
|
-
|
|
4279
|
-
|
|
4280
|
-
|
|
4281
|
-
|
|
4282
|
-
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
|
|
4296
|
-
|
|
4447
|
+
requestBody?: never;
|
|
4448
|
+
responses: {
|
|
4449
|
+
/** @description The media's versions, newest first */
|
|
4450
|
+
200: {
|
|
4451
|
+
headers: {
|
|
4452
|
+
[name: string]: unknown;
|
|
4453
|
+
};
|
|
4454
|
+
content: {
|
|
4455
|
+
"application/json": components["schemas"]["MediaVersion"][];
|
|
4456
|
+
};
|
|
4457
|
+
};
|
|
4458
|
+
/** @description Invalid parameters */
|
|
4459
|
+
400: {
|
|
4460
|
+
headers: {
|
|
4461
|
+
[name: string]: unknown;
|
|
4462
|
+
};
|
|
4463
|
+
content: {
|
|
4464
|
+
"application/json": components["schemas"]["Error"];
|
|
4465
|
+
};
|
|
4466
|
+
};
|
|
4467
|
+
/** @description Unauthorized */
|
|
4468
|
+
401: {
|
|
4469
|
+
headers: {
|
|
4470
|
+
[name: string]: unknown;
|
|
4471
|
+
};
|
|
4472
|
+
content: {
|
|
4473
|
+
"application/json": components["schemas"]["Error"];
|
|
4474
|
+
};
|
|
4475
|
+
};
|
|
4476
|
+
/** @description Forbidden */
|
|
4477
|
+
403: {
|
|
4478
|
+
headers: {
|
|
4479
|
+
[name: string]: unknown;
|
|
4480
|
+
};
|
|
4481
|
+
content: {
|
|
4482
|
+
"application/json": components["schemas"]["Error"];
|
|
4483
|
+
};
|
|
4484
|
+
};
|
|
4485
|
+
/** @description Not found */
|
|
4486
|
+
404: {
|
|
4487
|
+
headers: {
|
|
4488
|
+
[name: string]: unknown;
|
|
4489
|
+
};
|
|
4490
|
+
content: {
|
|
4491
|
+
"application/json": components["schemas"]["Error"];
|
|
4492
|
+
};
|
|
4493
|
+
};
|
|
4494
|
+
/** @description Server error */
|
|
4495
|
+
500: {
|
|
4496
|
+
headers: {
|
|
4497
|
+
[name: string]: unknown;
|
|
4498
|
+
};
|
|
4499
|
+
content: {
|
|
4500
|
+
"application/json": components["schemas"]["Error"];
|
|
4501
|
+
};
|
|
4502
|
+
};
|
|
4503
|
+
};
|
|
4504
|
+
};
|
|
4505
|
+
finalizeMedia: {
|
|
4506
|
+
parameters: {
|
|
4507
|
+
query?: never;
|
|
4508
|
+
header?: never;
|
|
4509
|
+
path: {
|
|
4510
|
+
/** @description The media ID */
|
|
4511
|
+
mediaId: string;
|
|
4512
|
+
};
|
|
4513
|
+
cookie?: never;
|
|
4514
|
+
};
|
|
4515
|
+
requestBody?: never;
|
|
4516
|
+
responses: {
|
|
4517
|
+
/** @description The finalized media */
|
|
4518
|
+
200: {
|
|
4519
|
+
headers: {
|
|
4520
|
+
[name: string]: unknown;
|
|
4521
|
+
};
|
|
4522
|
+
content: {
|
|
4523
|
+
"application/json": components["schemas"]["Media"];
|
|
4524
|
+
};
|
|
4525
|
+
};
|
|
4526
|
+
/** @description Invalid parameters */
|
|
4527
|
+
400: {
|
|
4528
|
+
headers: {
|
|
4529
|
+
[name: string]: unknown;
|
|
4530
|
+
};
|
|
4531
|
+
content: {
|
|
4532
|
+
"application/json": components["schemas"]["Error"];
|
|
4533
|
+
};
|
|
4534
|
+
};
|
|
4535
|
+
/** @description Unauthorized */
|
|
4536
|
+
401: {
|
|
4537
|
+
headers: {
|
|
4538
|
+
[name: string]: unknown;
|
|
4539
|
+
};
|
|
4540
|
+
content: {
|
|
4541
|
+
"application/json": components["schemas"]["Error"];
|
|
4542
|
+
};
|
|
4543
|
+
};
|
|
4544
|
+
/** @description Forbidden */
|
|
4545
|
+
403: {
|
|
4546
|
+
headers: {
|
|
4547
|
+
[name: string]: unknown;
|
|
4548
|
+
};
|
|
4549
|
+
content: {
|
|
4550
|
+
"application/json": components["schemas"]["Error"];
|
|
4551
|
+
};
|
|
4552
|
+
};
|
|
4553
|
+
/** @description Not found */
|
|
4554
|
+
404: {
|
|
4555
|
+
headers: {
|
|
4556
|
+
[name: string]: unknown;
|
|
4557
|
+
};
|
|
4558
|
+
content: {
|
|
4559
|
+
"application/json": components["schemas"]["Error"];
|
|
4560
|
+
};
|
|
4561
|
+
};
|
|
4562
|
+
/** @description Server error */
|
|
4563
|
+
500: {
|
|
4564
|
+
headers: {
|
|
4565
|
+
[name: string]: unknown;
|
|
4566
|
+
};
|
|
4567
|
+
content: {
|
|
4568
|
+
"application/json": components["schemas"]["Error"];
|
|
4569
|
+
};
|
|
4570
|
+
};
|
|
4571
|
+
};
|
|
4572
|
+
};
|
|
4573
|
+
listMediaComments: {
|
|
4574
|
+
parameters: {
|
|
4575
|
+
query?: never;
|
|
4576
|
+
header?: never;
|
|
4577
|
+
path: {
|
|
4578
|
+
/** @description The media ID */
|
|
4579
|
+
mediaId: string;
|
|
4580
|
+
};
|
|
4581
|
+
cookie?: never;
|
|
4582
|
+
};
|
|
4583
|
+
requestBody?: never;
|
|
4584
|
+
responses: {
|
|
4585
|
+
/** @description Comments, oldest first. Replies carry a threadId pointing at their root comment. */
|
|
4586
|
+
200: {
|
|
4587
|
+
headers: {
|
|
4588
|
+
[name: string]: unknown;
|
|
4589
|
+
};
|
|
4590
|
+
content: {
|
|
4591
|
+
"application/json": components["schemas"]["Comment"][];
|
|
4592
|
+
};
|
|
4593
|
+
};
|
|
4594
|
+
/** @description Invalid parameters */
|
|
4595
|
+
400: {
|
|
4596
|
+
headers: {
|
|
4597
|
+
[name: string]: unknown;
|
|
4598
|
+
};
|
|
4599
|
+
content: {
|
|
4600
|
+
"application/json": components["schemas"]["Error"];
|
|
4601
|
+
};
|
|
4602
|
+
};
|
|
4603
|
+
/** @description Unauthorized */
|
|
4604
|
+
401: {
|
|
4605
|
+
headers: {
|
|
4606
|
+
[name: string]: unknown;
|
|
4607
|
+
};
|
|
4608
|
+
content: {
|
|
4609
|
+
"application/json": components["schemas"]["Error"];
|
|
4610
|
+
};
|
|
4611
|
+
};
|
|
4612
|
+
/** @description Forbidden */
|
|
4613
|
+
403: {
|
|
4614
|
+
headers: {
|
|
4615
|
+
[name: string]: unknown;
|
|
4616
|
+
};
|
|
4617
|
+
content: {
|
|
4618
|
+
"application/json": components["schemas"]["Error"];
|
|
4619
|
+
};
|
|
4620
|
+
};
|
|
4621
|
+
/** @description Not found */
|
|
4622
|
+
404: {
|
|
4623
|
+
headers: {
|
|
4624
|
+
[name: string]: unknown;
|
|
4625
|
+
};
|
|
4626
|
+
content: {
|
|
4627
|
+
"application/json": components["schemas"]["Error"];
|
|
4628
|
+
};
|
|
4629
|
+
};
|
|
4630
|
+
/** @description Server error */
|
|
4631
|
+
500: {
|
|
4632
|
+
headers: {
|
|
4633
|
+
[name: string]: unknown;
|
|
4634
|
+
};
|
|
4635
|
+
content: {
|
|
4636
|
+
"application/json": components["schemas"]["Error"];
|
|
4637
|
+
};
|
|
4638
|
+
};
|
|
4639
|
+
};
|
|
4640
|
+
};
|
|
4641
|
+
createMediaComment: {
|
|
4642
|
+
parameters: {
|
|
4643
|
+
query?: never;
|
|
4644
|
+
header?: never;
|
|
4645
|
+
path: {
|
|
4646
|
+
/** @description The media ID */
|
|
4647
|
+
mediaId: string;
|
|
4648
|
+
};
|
|
4649
|
+
cookie?: never;
|
|
4650
|
+
};
|
|
4651
|
+
requestBody: {
|
|
4652
|
+
content: {
|
|
4653
|
+
"application/json": {
|
|
4654
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */
|
|
4655
|
+
body: string | {
|
|
4656
|
+
[key: string]: unknown;
|
|
4657
|
+
};
|
|
4658
|
+
/** @description Public ID of the root comment to reply to (e.g. `comment-xf23d`). */
|
|
4659
|
+
threadId?: string;
|
|
4660
|
+
/** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0-1) coordinates; lines is a 1-based inclusive range. */
|
|
4661
|
+
anchor?: {
|
|
4662
|
+
/** @constant */
|
|
4663
|
+
type: "point";
|
|
4664
|
+
x: number;
|
|
4665
|
+
y: number;
|
|
4666
|
+
} | {
|
|
4667
|
+
/** @constant */
|
|
4668
|
+
type: "lines";
|
|
4669
|
+
from: number;
|
|
4670
|
+
to: number;
|
|
4297
4671
|
};
|
|
4298
4672
|
};
|
|
4299
4673
|
};
|
|
4300
4674
|
};
|
|
4301
4675
|
responses: {
|
|
4302
|
-
/** @description
|
|
4676
|
+
/** @description The created comment */
|
|
4303
4677
|
201: {
|
|
4304
4678
|
headers: {
|
|
4305
4679
|
[name: string]: unknown;
|
|
@@ -4439,7 +4813,7 @@ interface operations {
|
|
|
4439
4813
|
};
|
|
4440
4814
|
requestBody?: never;
|
|
4441
4815
|
responses: {
|
|
4442
|
-
/** @description
|
|
4816
|
+
/** @description The deleted comment */
|
|
4443
4817
|
200: {
|
|
4444
4818
|
headers: {
|
|
4445
4819
|
[name: string]: unknown;
|
|
@@ -4518,7 +4892,7 @@ interface operations {
|
|
|
4518
4892
|
};
|
|
4519
4893
|
};
|
|
4520
4894
|
responses: {
|
|
4521
|
-
/** @description
|
|
4895
|
+
/** @description The updated comment */
|
|
4522
4896
|
200: {
|
|
4523
4897
|
headers: {
|
|
4524
4898
|
[name: string]: unknown;
|
|
@@ -4595,7 +4969,7 @@ interface operations {
|
|
|
4595
4969
|
};
|
|
4596
4970
|
};
|
|
4597
4971
|
responses: {
|
|
4598
|
-
/** @description
|
|
4972
|
+
/** @description The comment, with the reaction added */
|
|
4599
4973
|
200: {
|
|
4600
4974
|
headers: {
|
|
4601
4975
|
[name: string]: unknown;
|
|
@@ -4668,7 +5042,7 @@ interface operations {
|
|
|
4668
5042
|
};
|
|
4669
5043
|
requestBody?: never;
|
|
4670
5044
|
responses: {
|
|
4671
|
-
/** @description
|
|
5045
|
+
/** @description The comment, with the reaction removed */
|
|
4672
5046
|
200: {
|
|
4673
5047
|
headers: {
|
|
4674
5048
|
[name: string]: unknown;
|
|
@@ -4738,7 +5112,7 @@ interface operations {
|
|
|
4738
5112
|
};
|
|
4739
5113
|
requestBody?: never;
|
|
4740
5114
|
responses: {
|
|
4741
|
-
/** @description
|
|
5115
|
+
/** @description The root comment of the resolved thread */
|
|
4742
5116
|
200: {
|
|
4743
5117
|
headers: {
|
|
4744
5118
|
[name: string]: unknown;
|
|
@@ -4808,7 +5182,7 @@ interface operations {
|
|
|
4808
5182
|
};
|
|
4809
5183
|
requestBody?: never;
|
|
4810
5184
|
responses: {
|
|
4811
|
-
/** @description
|
|
5185
|
+
/** @description The root comment of the reopened thread */
|
|
4812
5186
|
200: {
|
|
4813
5187
|
headers: {
|
|
4814
5188
|
[name: string]: unknown;
|
|
@@ -4878,7 +5252,7 @@ interface operations {
|
|
|
4878
5252
|
};
|
|
4879
5253
|
requestBody?: never;
|
|
4880
5254
|
responses: {
|
|
4881
|
-
/** @description
|
|
5255
|
+
/** @description The root comment of the subscribed thread */
|
|
4882
5256
|
200: {
|
|
4883
5257
|
headers: {
|
|
4884
5258
|
[name: string]: unknown;
|
|
@@ -4948,7 +5322,7 @@ interface operations {
|
|
|
4948
5322
|
};
|
|
4949
5323
|
requestBody?: never;
|
|
4950
5324
|
responses: {
|
|
4951
|
-
/** @description
|
|
5325
|
+
/** @description The root comment of the unsubscribed thread */
|
|
4952
5326
|
200: {
|
|
4953
5327
|
headers: {
|
|
4954
5328
|
[name: string]: unknown;
|
|
@@ -5014,6 +5388,8 @@ interface operations {
|
|
|
5014
5388
|
requestBody?: {
|
|
5015
5389
|
content: {
|
|
5016
5390
|
"application/json": {
|
|
5391
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
5392
|
+
project?: string | null;
|
|
5017
5393
|
/** @description The commit the build is running on */
|
|
5018
5394
|
commit: components["schemas"]["Sha1Hash"];
|
|
5019
5395
|
/** @description The branch the build is running on */
|
|
@@ -5057,7 +5433,6 @@ interface operations {
|
|
|
5057
5433
|
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
5058
5434
|
*/
|
|
5059
5435
|
subset?: boolean | null;
|
|
5060
|
-
} & ({
|
|
5061
5436
|
/**
|
|
5062
5437
|
* @deprecated
|
|
5063
5438
|
* @description Keys of screenshot files
|
|
@@ -5065,39 +5440,84 @@ interface operations {
|
|
|
5065
5440
|
screenshotKeys: components["schemas"]["Sha256Hash"][];
|
|
5066
5441
|
screenshots?: unknown;
|
|
5067
5442
|
} | {
|
|
5068
|
-
/** @description
|
|
5069
|
-
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5077
|
-
|
|
5078
|
-
|
|
5079
|
-
|
|
5080
|
-
|
|
5081
|
-
|
|
5082
|
-
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
|
|
5091
|
-
|
|
5092
|
-
|
|
5093
|
-
|
|
5094
|
-
|
|
5095
|
-
|
|
5096
|
-
|
|
5097
|
-
|
|
5098
|
-
|
|
5099
|
-
|
|
5100
|
-
|
|
5443
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
5444
|
+
project?: string | null;
|
|
5445
|
+
/** @description The commit the build is running on */
|
|
5446
|
+
commit: components["schemas"]["Sha1Hash"];
|
|
5447
|
+
/** @description The branch the build is running on */
|
|
5448
|
+
branch: components["schemas"]["GitBranch"];
|
|
5449
|
+
/** @description Keys of Playwright trace files */
|
|
5450
|
+
pwTraceKeys?: components["schemas"]["Sha256Hash"][];
|
|
5451
|
+
/** @description The name of the build (for multi-build setups) */
|
|
5452
|
+
name?: string | null;
|
|
5453
|
+
/** @description Whether to run the build in parallel */
|
|
5454
|
+
parallel?: boolean | null;
|
|
5455
|
+
/** @description A unique nonce for the parallel build */
|
|
5456
|
+
parallelNonce?: string | null;
|
|
5457
|
+
/** @description The pull request number */
|
|
5458
|
+
prNumber?: number | null;
|
|
5459
|
+
/** @description The head commit of the pull request */
|
|
5460
|
+
prHeadCommit?: components["schemas"]["Sha1Hash"] | null;
|
|
5461
|
+
/** @description The commit to use as a reference for the build */
|
|
5462
|
+
referenceCommit?: components["schemas"]["Sha1Hash"] | null;
|
|
5463
|
+
/** @description The branch to use as a reference for the build */
|
|
5464
|
+
referenceBranch?: string | null;
|
|
5465
|
+
/** @description The parent commits of the build */
|
|
5466
|
+
parentCommits?: components["schemas"]["Sha1Hash"][] | null;
|
|
5467
|
+
/** @description The mode in which the build is running */
|
|
5468
|
+
mode?: ("ci" | "monitoring") | null;
|
|
5469
|
+
/** @description The CI provider being used */
|
|
5470
|
+
ciProvider?: string | null;
|
|
5471
|
+
/** @description The version of the Argos SDK being used */
|
|
5472
|
+
argosSdk?: string | null;
|
|
5473
|
+
/** @description The ID of the current run */
|
|
5474
|
+
runId?: string | null;
|
|
5475
|
+
/** @description The attempt number of the current run */
|
|
5476
|
+
runAttempt?: number | null;
|
|
5477
|
+
/** @description Whether the build was skipped, not comparing anything and always succeeding */
|
|
5478
|
+
skipped?: boolean | null;
|
|
5479
|
+
/** @description Whether the build has been created in a merge queue */
|
|
5480
|
+
mergeQueue?: boolean | null;
|
|
5481
|
+
/** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
|
|
5482
|
+
mergeQueuePrNumbers?: number[] | null;
|
|
5483
|
+
/**
|
|
5484
|
+
* @description Indicates whether this build contains only a subset of screenshots.
|
|
5485
|
+
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
5486
|
+
*/
|
|
5487
|
+
subset?: boolean | null;
|
|
5488
|
+
/** @description Screenshot files to upload */
|
|
5489
|
+
screenshots: components["schemas"]["ScreenshotUploadRequest"][];
|
|
5490
|
+
screenshotKeys?: unknown;
|
|
5491
|
+
};
|
|
5492
|
+
};
|
|
5493
|
+
};
|
|
5494
|
+
responses: {
|
|
5495
|
+
/** @description Result of build creation */
|
|
5496
|
+
201: {
|
|
5497
|
+
headers: {
|
|
5498
|
+
[name: string]: unknown;
|
|
5499
|
+
};
|
|
5500
|
+
content: {
|
|
5501
|
+
"application/json": {
|
|
5502
|
+
build: components["schemas"]["Build"];
|
|
5503
|
+
screenshots: ({
|
|
5504
|
+
key: string;
|
|
5505
|
+
/**
|
|
5506
|
+
* Format: uri
|
|
5507
|
+
* @deprecated
|
|
5508
|
+
* @description Deprecated. Use postUrl and fields instead.
|
|
5509
|
+
*/
|
|
5510
|
+
putUrl: string;
|
|
5511
|
+
} | {
|
|
5512
|
+
key: string;
|
|
5513
|
+
/** Format: uri */
|
|
5514
|
+
postUrl: string;
|
|
5515
|
+
fields: {
|
|
5516
|
+
[key: string]: string;
|
|
5517
|
+
};
|
|
5518
|
+
})[];
|
|
5519
|
+
pwTraces: ({
|
|
5520
|
+
key: string;
|
|
5101
5521
|
/**
|
|
5102
5522
|
* Format: uri
|
|
5103
5523
|
* @deprecated
|
|
@@ -5133,6 +5553,15 @@ interface operations {
|
|
|
5133
5553
|
"application/json": components["schemas"]["Error"];
|
|
5134
5554
|
};
|
|
5135
5555
|
};
|
|
5556
|
+
/** @description Forbidden */
|
|
5557
|
+
403: {
|
|
5558
|
+
headers: {
|
|
5559
|
+
[name: string]: unknown;
|
|
5560
|
+
};
|
|
5561
|
+
content: {
|
|
5562
|
+
"application/json": components["schemas"]["Error"];
|
|
5563
|
+
};
|
|
5564
|
+
};
|
|
5136
5565
|
/** @description Conflict */
|
|
5137
5566
|
409: {
|
|
5138
5567
|
headers: {
|
|
@@ -5163,6 +5592,8 @@ interface operations {
|
|
|
5163
5592
|
requestBody?: {
|
|
5164
5593
|
content: {
|
|
5165
5594
|
"application/json": {
|
|
5595
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
5596
|
+
project?: string | null;
|
|
5166
5597
|
/** @description The commit SHA */
|
|
5167
5598
|
commit: components["schemas"]["Sha1Hash"];
|
|
5168
5599
|
/** @description The branch name */
|
|
@@ -5222,6 +5653,15 @@ interface operations {
|
|
|
5222
5653
|
"application/json": components["schemas"]["Error"];
|
|
5223
5654
|
};
|
|
5224
5655
|
};
|
|
5656
|
+
/** @description Forbidden */
|
|
5657
|
+
403: {
|
|
5658
|
+
headers: {
|
|
5659
|
+
[name: string]: unknown;
|
|
5660
|
+
};
|
|
5661
|
+
content: {
|
|
5662
|
+
"application/json": components["schemas"]["Error"];
|
|
5663
|
+
};
|
|
5664
|
+
};
|
|
5225
5665
|
/** @description Server error */
|
|
5226
5666
|
500: {
|
|
5227
5667
|
headers: {
|
|
@@ -5283,6 +5723,15 @@ interface operations {
|
|
|
5283
5723
|
"application/json": components["schemas"]["Error"];
|
|
5284
5724
|
};
|
|
5285
5725
|
};
|
|
5726
|
+
/** @description Forbidden */
|
|
5727
|
+
403: {
|
|
5728
|
+
headers: {
|
|
5729
|
+
[name: string]: unknown;
|
|
5730
|
+
};
|
|
5731
|
+
content: {
|
|
5732
|
+
"application/json": components["schemas"]["Error"];
|
|
5733
|
+
};
|
|
5734
|
+
};
|
|
5286
5735
|
/** @description Not found */
|
|
5287
5736
|
404: {
|
|
5288
5737
|
headers: {
|
|
@@ -5353,6 +5802,15 @@ interface operations {
|
|
|
5353
5802
|
"application/json": components["schemas"]["Error"];
|
|
5354
5803
|
};
|
|
5355
5804
|
};
|
|
5805
|
+
/** @description Forbidden */
|
|
5806
|
+
403: {
|
|
5807
|
+
headers: {
|
|
5808
|
+
[name: string]: unknown;
|
|
5809
|
+
};
|
|
5810
|
+
content: {
|
|
5811
|
+
"application/json": components["schemas"]["Error"];
|
|
5812
|
+
};
|
|
5813
|
+
};
|
|
5356
5814
|
/** @description Not found */
|
|
5357
5815
|
404: {
|
|
5358
5816
|
headers: {
|
|
@@ -5441,6 +5899,8 @@ interface operations {
|
|
|
5441
5899
|
content: {
|
|
5442
5900
|
"application/json": {
|
|
5443
5901
|
parallelNonce: string;
|
|
5902
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
5903
|
+
project?: string | null;
|
|
5444
5904
|
};
|
|
5445
5905
|
};
|
|
5446
5906
|
};
|
|
@@ -5522,6 +5982,8 @@ interface operations {
|
|
|
5522
5982
|
requestBody?: {
|
|
5523
5983
|
content: {
|
|
5524
5984
|
"application/json": {
|
|
5985
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
5986
|
+
project?: string | null;
|
|
5525
5987
|
/** @description The commits to look for an eligible baseline, ordered from the closest to the furthest ancestor. The first commit with an eligible baseline wins. */
|
|
5526
5988
|
commits: components["schemas"]["Sha1Hash"][];
|
|
5527
5989
|
/**
|
|
@@ -5569,58 +6031,8 @@ interface operations {
|
|
|
5569
6031
|
"application/json": components["schemas"]["Error"];
|
|
5570
6032
|
};
|
|
5571
6033
|
};
|
|
5572
|
-
/** @description
|
|
5573
|
-
|
|
5574
|
-
headers: {
|
|
5575
|
-
[name: string]: unknown;
|
|
5576
|
-
};
|
|
5577
|
-
content: {
|
|
5578
|
-
"application/json": components["schemas"]["Error"];
|
|
5579
|
-
};
|
|
5580
|
-
};
|
|
5581
|
-
};
|
|
5582
|
-
};
|
|
5583
|
-
exchangeCliToken: {
|
|
5584
|
-
parameters: {
|
|
5585
|
-
query?: never;
|
|
5586
|
-
header?: never;
|
|
5587
|
-
path?: never;
|
|
5588
|
-
cookie?: never;
|
|
5589
|
-
};
|
|
5590
|
-
requestBody?: {
|
|
5591
|
-
content: {
|
|
5592
|
-
"application/json": {
|
|
5593
|
-
/** @description PKCE authorization code from the login flow */
|
|
5594
|
-
code: string;
|
|
5595
|
-
/** @description PKCE code verifier matching the code challenge */
|
|
5596
|
-
code_verifier: string;
|
|
5597
|
-
};
|
|
5598
|
-
};
|
|
5599
|
-
};
|
|
5600
|
-
responses: {
|
|
5601
|
-
/** @description Token exchange successful */
|
|
5602
|
-
200: {
|
|
5603
|
-
headers: {
|
|
5604
|
-
[name: string]: unknown;
|
|
5605
|
-
};
|
|
5606
|
-
content: {
|
|
5607
|
-
"application/json": {
|
|
5608
|
-
/** @description Argos API token for CLI use */
|
|
5609
|
-
token: string;
|
|
5610
|
-
};
|
|
5611
|
-
};
|
|
5612
|
-
};
|
|
5613
|
-
/** @description Invalid parameters */
|
|
5614
|
-
400: {
|
|
5615
|
-
headers: {
|
|
5616
|
-
[name: string]: unknown;
|
|
5617
|
-
};
|
|
5618
|
-
content: {
|
|
5619
|
-
"application/json": components["schemas"]["Error"];
|
|
5620
|
-
};
|
|
5621
|
-
};
|
|
5622
|
-
/** @description Unauthorized */
|
|
5623
|
-
401: {
|
|
6034
|
+
/** @description Forbidden */
|
|
6035
|
+
403: {
|
|
5624
6036
|
headers: {
|
|
5625
6037
|
[name: string]: unknown;
|
|
5626
6038
|
};
|
|
@@ -5841,7 +6253,10 @@ interface operations {
|
|
|
5841
6253
|
};
|
|
5842
6254
|
getAuthProject: {
|
|
5843
6255
|
parameters: {
|
|
5844
|
-
query?:
|
|
6256
|
+
query?: {
|
|
6257
|
+
/** @description Project to act on, as `owner/project`. Required when the project token is linked to several projects, ignored when it is linked to only one. */
|
|
6258
|
+
project?: string | null;
|
|
6259
|
+
};
|
|
5845
6260
|
header?: never;
|
|
5846
6261
|
path?: never;
|
|
5847
6262
|
cookie?: never;
|
|
@@ -5857,6 +6272,15 @@ interface operations {
|
|
|
5857
6272
|
"application/json": components["schemas"]["Project"];
|
|
5858
6273
|
};
|
|
5859
6274
|
};
|
|
6275
|
+
/** @description Invalid parameters */
|
|
6276
|
+
400: {
|
|
6277
|
+
headers: {
|
|
6278
|
+
[name: string]: unknown;
|
|
6279
|
+
};
|
|
6280
|
+
content: {
|
|
6281
|
+
"application/json": components["schemas"]["Error"];
|
|
6282
|
+
};
|
|
6283
|
+
};
|
|
5860
6284
|
/** @description Unauthorized */
|
|
5861
6285
|
401: {
|
|
5862
6286
|
headers: {
|
|
@@ -5986,7 +6410,7 @@ interface operations {
|
|
|
5986
6410
|
};
|
|
5987
6411
|
};
|
|
5988
6412
|
responses: {
|
|
5989
|
-
/** @description
|
|
6413
|
+
/** @description The created project */
|
|
5990
6414
|
201: {
|
|
5991
6415
|
headers: {
|
|
5992
6416
|
[name: string]: unknown;
|
|
@@ -6013,8 +6437,239 @@ interface operations {
|
|
|
6013
6437
|
"application/json": components["schemas"]["Error"];
|
|
6014
6438
|
};
|
|
6015
6439
|
};
|
|
6016
|
-
/** @description Forbidden */
|
|
6017
|
-
403: {
|
|
6440
|
+
/** @description Forbidden */
|
|
6441
|
+
403: {
|
|
6442
|
+
headers: {
|
|
6443
|
+
[name: string]: unknown;
|
|
6444
|
+
};
|
|
6445
|
+
content: {
|
|
6446
|
+
"application/json": components["schemas"]["Error"];
|
|
6447
|
+
};
|
|
6448
|
+
};
|
|
6449
|
+
/** @description Server error */
|
|
6450
|
+
500: {
|
|
6451
|
+
headers: {
|
|
6452
|
+
[name: string]: unknown;
|
|
6453
|
+
};
|
|
6454
|
+
content: {
|
|
6455
|
+
"application/json": components["schemas"]["Error"];
|
|
6456
|
+
};
|
|
6457
|
+
};
|
|
6458
|
+
};
|
|
6459
|
+
};
|
|
6460
|
+
getProject: {
|
|
6461
|
+
parameters: {
|
|
6462
|
+
query?: never;
|
|
6463
|
+
header?: never;
|
|
6464
|
+
path: {
|
|
6465
|
+
owner: string;
|
|
6466
|
+
project: string;
|
|
6467
|
+
};
|
|
6468
|
+
cookie?: never;
|
|
6469
|
+
};
|
|
6470
|
+
requestBody?: never;
|
|
6471
|
+
responses: {
|
|
6472
|
+
/** @description Project */
|
|
6473
|
+
200: {
|
|
6474
|
+
headers: {
|
|
6475
|
+
[name: string]: unknown;
|
|
6476
|
+
};
|
|
6477
|
+
content: {
|
|
6478
|
+
"application/json": components["schemas"]["Project"];
|
|
6479
|
+
};
|
|
6480
|
+
};
|
|
6481
|
+
/** @description Unauthorized */
|
|
6482
|
+
401: {
|
|
6483
|
+
headers: {
|
|
6484
|
+
[name: string]: unknown;
|
|
6485
|
+
};
|
|
6486
|
+
content: {
|
|
6487
|
+
"application/json": components["schemas"]["Error"];
|
|
6488
|
+
};
|
|
6489
|
+
};
|
|
6490
|
+
/** @description Forbidden */
|
|
6491
|
+
403: {
|
|
6492
|
+
headers: {
|
|
6493
|
+
[name: string]: unknown;
|
|
6494
|
+
};
|
|
6495
|
+
content: {
|
|
6496
|
+
"application/json": components["schemas"]["Error"];
|
|
6497
|
+
};
|
|
6498
|
+
};
|
|
6499
|
+
/** @description Not found */
|
|
6500
|
+
404: {
|
|
6501
|
+
headers: {
|
|
6502
|
+
[name: string]: unknown;
|
|
6503
|
+
};
|
|
6504
|
+
content: {
|
|
6505
|
+
"application/json": components["schemas"]["Error"];
|
|
6506
|
+
};
|
|
6507
|
+
};
|
|
6508
|
+
/** @description Server error */
|
|
6509
|
+
500: {
|
|
6510
|
+
headers: {
|
|
6511
|
+
[name: string]: unknown;
|
|
6512
|
+
};
|
|
6513
|
+
content: {
|
|
6514
|
+
"application/json": components["schemas"]["Error"];
|
|
6515
|
+
};
|
|
6516
|
+
};
|
|
6517
|
+
};
|
|
6518
|
+
};
|
|
6519
|
+
updateProject: {
|
|
6520
|
+
parameters: {
|
|
6521
|
+
query?: never;
|
|
6522
|
+
header?: never;
|
|
6523
|
+
path: {
|
|
6524
|
+
owner: string;
|
|
6525
|
+
project: string;
|
|
6526
|
+
};
|
|
6527
|
+
cookie?: never;
|
|
6528
|
+
};
|
|
6529
|
+
requestBody: {
|
|
6530
|
+
content: {
|
|
6531
|
+
"application/json": {
|
|
6532
|
+
/** @description New name for the project. Must be unique within the owning account (case-insensitive). */
|
|
6533
|
+
name?: string;
|
|
6534
|
+
/** @description Branch used as the baseline when no better one applies. `null` falls back to the repository's default branch. */
|
|
6535
|
+
defaultBaseBranch?: string | null;
|
|
6536
|
+
/** @description Glob matching the branches whose builds are approved automatically. `null` falls back to the default base branch. */
|
|
6537
|
+
autoApprovedBranchGlob?: string | null;
|
|
6538
|
+
/** @description Turn auto-approval on or off. When `false`, no branch is auto-approved and every build needs a review, including the ones on the base branch. */
|
|
6539
|
+
autoApprovalEnabled?: boolean;
|
|
6540
|
+
/** @description Glob matching the branches whose deployments count as production. `null` falls back to the repository's default branch. */
|
|
6541
|
+
deploymentProductionBranchGlob?: string | null;
|
|
6542
|
+
/** @description Force the project's privacy. `null` inherits it from the linked repository. */
|
|
6543
|
+
private?: boolean | null;
|
|
6544
|
+
summaryCheck?: components["schemas"]["SummaryCheck"];
|
|
6545
|
+
awaitingReviewStatus?: components["schemas"]["AwaitingReviewStatus"];
|
|
6546
|
+
/** @description Access given to team members that are not contributors on this project. `null` gives them none. */
|
|
6547
|
+
defaultUserLevel?: components["schemas"]["ProjectUserLevel"] | null;
|
|
6548
|
+
ignoreConfig?: components["schemas"]["IgnoreConfig"];
|
|
6549
|
+
deploymentEnabled?: boolean;
|
|
6550
|
+
deploymentAuth?: components["schemas"]["DeploymentAuth"];
|
|
6551
|
+
githubActionsOidcEnabled?: boolean;
|
|
6552
|
+
tokenlessAuthEnabled?: boolean;
|
|
6553
|
+
};
|
|
6554
|
+
};
|
|
6555
|
+
};
|
|
6556
|
+
responses: {
|
|
6557
|
+
/** @description The updated project */
|
|
6558
|
+
200: {
|
|
6559
|
+
headers: {
|
|
6560
|
+
[name: string]: unknown;
|
|
6561
|
+
};
|
|
6562
|
+
content: {
|
|
6563
|
+
"application/json": components["schemas"]["Project"];
|
|
6564
|
+
};
|
|
6565
|
+
};
|
|
6566
|
+
/** @description Invalid parameters */
|
|
6567
|
+
400: {
|
|
6568
|
+
headers: {
|
|
6569
|
+
[name: string]: unknown;
|
|
6570
|
+
};
|
|
6571
|
+
content: {
|
|
6572
|
+
"application/json": components["schemas"]["Error"];
|
|
6573
|
+
};
|
|
6574
|
+
};
|
|
6575
|
+
/** @description Unauthorized */
|
|
6576
|
+
401: {
|
|
6577
|
+
headers: {
|
|
6578
|
+
[name: string]: unknown;
|
|
6579
|
+
};
|
|
6580
|
+
content: {
|
|
6581
|
+
"application/json": components["schemas"]["Error"];
|
|
6582
|
+
};
|
|
6583
|
+
};
|
|
6584
|
+
/** @description Forbidden */
|
|
6585
|
+
403: {
|
|
6586
|
+
headers: {
|
|
6587
|
+
[name: string]: unknown;
|
|
6588
|
+
};
|
|
6589
|
+
content: {
|
|
6590
|
+
"application/json": components["schemas"]["Error"];
|
|
6591
|
+
};
|
|
6592
|
+
};
|
|
6593
|
+
/** @description Not found */
|
|
6594
|
+
404: {
|
|
6595
|
+
headers: {
|
|
6596
|
+
[name: string]: unknown;
|
|
6597
|
+
};
|
|
6598
|
+
content: {
|
|
6599
|
+
"application/json": components["schemas"]["Error"];
|
|
6600
|
+
};
|
|
6601
|
+
};
|
|
6602
|
+
/** @description Server error */
|
|
6603
|
+
500: {
|
|
6604
|
+
headers: {
|
|
6605
|
+
[name: string]: unknown;
|
|
6606
|
+
};
|
|
6607
|
+
content: {
|
|
6608
|
+
"application/json": components["schemas"]["Error"];
|
|
6609
|
+
};
|
|
6610
|
+
};
|
|
6611
|
+
};
|
|
6612
|
+
};
|
|
6613
|
+
listAutomationRules: {
|
|
6614
|
+
parameters: {
|
|
6615
|
+
query?: {
|
|
6616
|
+
/** @description Number of items per page (max 100) */
|
|
6617
|
+
perPage?: string;
|
|
6618
|
+
/** @description Page number */
|
|
6619
|
+
page?: string;
|
|
6620
|
+
/** @description Restrict to rules that still fire (`true`) or to deactivated ones (`false`). Omit for both. */
|
|
6621
|
+
active?: "true" | "false";
|
|
6622
|
+
};
|
|
6623
|
+
header?: never;
|
|
6624
|
+
path: {
|
|
6625
|
+
owner: string;
|
|
6626
|
+
project: string;
|
|
6627
|
+
};
|
|
6628
|
+
cookie?: never;
|
|
6629
|
+
};
|
|
6630
|
+
requestBody?: never;
|
|
6631
|
+
responses: {
|
|
6632
|
+
/** @description List of automation rules */
|
|
6633
|
+
200: {
|
|
6634
|
+
headers: {
|
|
6635
|
+
[name: string]: unknown;
|
|
6636
|
+
};
|
|
6637
|
+
content: {
|
|
6638
|
+
"application/json": {
|
|
6639
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
6640
|
+
results: components["schemas"]["AutomationRule"][];
|
|
6641
|
+
};
|
|
6642
|
+
};
|
|
6643
|
+
};
|
|
6644
|
+
/** @description Invalid parameters */
|
|
6645
|
+
400: {
|
|
6646
|
+
headers: {
|
|
6647
|
+
[name: string]: unknown;
|
|
6648
|
+
};
|
|
6649
|
+
content: {
|
|
6650
|
+
"application/json": components["schemas"]["Error"];
|
|
6651
|
+
};
|
|
6652
|
+
};
|
|
6653
|
+
/** @description Unauthorized */
|
|
6654
|
+
401: {
|
|
6655
|
+
headers: {
|
|
6656
|
+
[name: string]: unknown;
|
|
6657
|
+
};
|
|
6658
|
+
content: {
|
|
6659
|
+
"application/json": components["schemas"]["Error"];
|
|
6660
|
+
};
|
|
6661
|
+
};
|
|
6662
|
+
/** @description Forbidden */
|
|
6663
|
+
403: {
|
|
6664
|
+
headers: {
|
|
6665
|
+
[name: string]: unknown;
|
|
6666
|
+
};
|
|
6667
|
+
content: {
|
|
6668
|
+
"application/json": components["schemas"]["Error"];
|
|
6669
|
+
};
|
|
6670
|
+
};
|
|
6671
|
+
/** @description Not found */
|
|
6672
|
+
404: {
|
|
6018
6673
|
headers: {
|
|
6019
6674
|
[name: string]: unknown;
|
|
6020
6675
|
};
|
|
@@ -6033,7 +6688,7 @@ interface operations {
|
|
|
6033
6688
|
};
|
|
6034
6689
|
};
|
|
6035
6690
|
};
|
|
6036
|
-
|
|
6691
|
+
createAutomationRule: {
|
|
6037
6692
|
parameters: {
|
|
6038
6693
|
query?: never;
|
|
6039
6694
|
header?: never;
|
|
@@ -6043,15 +6698,34 @@ interface operations {
|
|
|
6043
6698
|
};
|
|
6044
6699
|
cookie?: never;
|
|
6045
6700
|
};
|
|
6046
|
-
requestBody
|
|
6701
|
+
requestBody: {
|
|
6702
|
+
content: {
|
|
6703
|
+
"application/json": {
|
|
6704
|
+
name: string;
|
|
6705
|
+
events: components["schemas"]["AutomationEvent"][];
|
|
6706
|
+
/** @default [] */
|
|
6707
|
+
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6708
|
+
actions: components["schemas"]["AutomationActionInput"][];
|
|
6709
|
+
};
|
|
6710
|
+
};
|
|
6711
|
+
};
|
|
6047
6712
|
responses: {
|
|
6048
|
-
/** @description
|
|
6049
|
-
|
|
6713
|
+
/** @description The created rule */
|
|
6714
|
+
201: {
|
|
6050
6715
|
headers: {
|
|
6051
6716
|
[name: string]: unknown;
|
|
6052
6717
|
};
|
|
6053
6718
|
content: {
|
|
6054
|
-
"application/json": components["schemas"]["
|
|
6719
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6720
|
+
};
|
|
6721
|
+
};
|
|
6722
|
+
/** @description Invalid parameters */
|
|
6723
|
+
400: {
|
|
6724
|
+
headers: {
|
|
6725
|
+
[name: string]: unknown;
|
|
6726
|
+
};
|
|
6727
|
+
content: {
|
|
6728
|
+
"application/json": components["schemas"]["Error"];
|
|
6055
6729
|
};
|
|
6056
6730
|
};
|
|
6057
6731
|
/** @description Unauthorized */
|
|
@@ -6092,48 +6766,27 @@ interface operations {
|
|
|
6092
6766
|
};
|
|
6093
6767
|
};
|
|
6094
6768
|
};
|
|
6095
|
-
|
|
6769
|
+
getAutomationRule: {
|
|
6096
6770
|
parameters: {
|
|
6097
6771
|
query?: never;
|
|
6098
6772
|
header?: never;
|
|
6099
6773
|
path: {
|
|
6100
6774
|
owner: string;
|
|
6101
6775
|
project: string;
|
|
6776
|
+
/** @description Identifier of the automation rule. */
|
|
6777
|
+
ruleId: string;
|
|
6102
6778
|
};
|
|
6103
6779
|
cookie?: never;
|
|
6104
6780
|
};
|
|
6105
|
-
requestBody
|
|
6106
|
-
content: {
|
|
6107
|
-
"application/json": {
|
|
6108
|
-
/** @description New name for the project. Must be unique within the owning account (case-insensitive). */
|
|
6109
|
-
name?: string;
|
|
6110
|
-
/** @description Branch used as the baseline when no better one applies. `null` falls back to the repository's default branch. */
|
|
6111
|
-
defaultBaseBranch?: string | null;
|
|
6112
|
-
/** @description Glob matching the branches whose builds are approved automatically. `null` falls back to the default base branch. */
|
|
6113
|
-
autoApprovedBranchGlob?: string | null;
|
|
6114
|
-
/** @description Glob matching the branches whose deployments count as production. `null` falls back to the repository's default branch. */
|
|
6115
|
-
deploymentProductionBranchGlob?: string | null;
|
|
6116
|
-
/** @description Force the project's privacy. `null` inherits it from the linked repository. */
|
|
6117
|
-
private?: boolean | null;
|
|
6118
|
-
summaryCheck?: components["schemas"]["SummaryCheck"];
|
|
6119
|
-
/** @description Access given to team members that are not contributors on this project. `null` gives them none. */
|
|
6120
|
-
defaultUserLevel?: components["schemas"]["ProjectUserLevel"] | null;
|
|
6121
|
-
ignoreConfig?: components["schemas"]["IgnoreConfig"];
|
|
6122
|
-
deploymentEnabled?: boolean;
|
|
6123
|
-
deploymentAuth?: components["schemas"]["DeploymentAuth"];
|
|
6124
|
-
githubActionsOidcEnabled?: boolean;
|
|
6125
|
-
tokenlessAuthEnabled?: boolean;
|
|
6126
|
-
};
|
|
6127
|
-
};
|
|
6128
|
-
};
|
|
6781
|
+
requestBody?: never;
|
|
6129
6782
|
responses: {
|
|
6130
|
-
/** @description The
|
|
6783
|
+
/** @description The automation rule */
|
|
6131
6784
|
200: {
|
|
6132
6785
|
headers: {
|
|
6133
6786
|
[name: string]: unknown;
|
|
6134
6787
|
};
|
|
6135
6788
|
content: {
|
|
6136
|
-
"application/json": components["schemas"]["
|
|
6789
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6137
6790
|
};
|
|
6138
6791
|
};
|
|
6139
6792
|
/** @description Invalid parameters */
|
|
@@ -6183,35 +6836,37 @@ interface operations {
|
|
|
6183
6836
|
};
|
|
6184
6837
|
};
|
|
6185
6838
|
};
|
|
6186
|
-
|
|
6839
|
+
updateAutomationRule: {
|
|
6187
6840
|
parameters: {
|
|
6188
|
-
query?:
|
|
6189
|
-
/** @description Number of items per page (max 100) */
|
|
6190
|
-
perPage?: string;
|
|
6191
|
-
/** @description Page number */
|
|
6192
|
-
page?: string;
|
|
6193
|
-
/** @description Restrict to rules that still fire (`true`) or to deactivated ones (`false`). Omit for both. */
|
|
6194
|
-
active?: "true" | "false";
|
|
6195
|
-
};
|
|
6841
|
+
query?: never;
|
|
6196
6842
|
header?: never;
|
|
6197
6843
|
path: {
|
|
6198
6844
|
owner: string;
|
|
6199
6845
|
project: string;
|
|
6846
|
+
/** @description Identifier of the automation rule. */
|
|
6847
|
+
ruleId: string;
|
|
6200
6848
|
};
|
|
6201
6849
|
cookie?: never;
|
|
6202
6850
|
};
|
|
6203
|
-
requestBody
|
|
6851
|
+
requestBody: {
|
|
6852
|
+
content: {
|
|
6853
|
+
"application/json": {
|
|
6854
|
+
name: string;
|
|
6855
|
+
events: components["schemas"]["AutomationEvent"][];
|
|
6856
|
+
/** @default [] */
|
|
6857
|
+
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6858
|
+
actions: components["schemas"]["AutomationActionInput"][];
|
|
6859
|
+
};
|
|
6860
|
+
};
|
|
6861
|
+
};
|
|
6204
6862
|
responses: {
|
|
6205
|
-
/** @description
|
|
6863
|
+
/** @description The updated rule */
|
|
6206
6864
|
200: {
|
|
6207
6865
|
headers: {
|
|
6208
6866
|
[name: string]: unknown;
|
|
6209
6867
|
};
|
|
6210
6868
|
content: {
|
|
6211
|
-
"application/json":
|
|
6212
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
6213
|
-
results: components["schemas"]["AutomationRule"][];
|
|
6214
|
-
};
|
|
6869
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6215
6870
|
};
|
|
6216
6871
|
};
|
|
6217
6872
|
/** @description Invalid parameters */
|
|
@@ -6261,30 +6916,22 @@ interface operations {
|
|
|
6261
6916
|
};
|
|
6262
6917
|
};
|
|
6263
6918
|
};
|
|
6264
|
-
|
|
6919
|
+
deactivateAutomationRule: {
|
|
6265
6920
|
parameters: {
|
|
6266
6921
|
query?: never;
|
|
6267
6922
|
header?: never;
|
|
6268
6923
|
path: {
|
|
6269
6924
|
owner: string;
|
|
6270
6925
|
project: string;
|
|
6926
|
+
/** @description Identifier of the automation rule. */
|
|
6927
|
+
ruleId: string;
|
|
6271
6928
|
};
|
|
6272
6929
|
cookie?: never;
|
|
6273
6930
|
};
|
|
6274
|
-
requestBody
|
|
6275
|
-
content: {
|
|
6276
|
-
"application/json": {
|
|
6277
|
-
name: string;
|
|
6278
|
-
events: components["schemas"]["AutomationEvent"][];
|
|
6279
|
-
/** @default [] */
|
|
6280
|
-
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6281
|
-
actions: components["schemas"]["AutomationActionInput"][];
|
|
6282
|
-
};
|
|
6283
|
-
};
|
|
6284
|
-
};
|
|
6931
|
+
requestBody?: never;
|
|
6285
6932
|
responses: {
|
|
6286
|
-
/** @description The
|
|
6287
|
-
|
|
6933
|
+
/** @description The deactivated rule */
|
|
6934
|
+
200: {
|
|
6288
6935
|
headers: {
|
|
6289
6936
|
[name: string]: unknown;
|
|
6290
6937
|
};
|
|
@@ -6339,27 +6986,33 @@ interface operations {
|
|
|
6339
6986
|
};
|
|
6340
6987
|
};
|
|
6341
6988
|
};
|
|
6342
|
-
|
|
6989
|
+
listProjectContributors: {
|
|
6343
6990
|
parameters: {
|
|
6344
|
-
query?:
|
|
6991
|
+
query?: {
|
|
6992
|
+
/** @description Number of items per page (max 100) */
|
|
6993
|
+
perPage?: string;
|
|
6994
|
+
/** @description Page number */
|
|
6995
|
+
page?: string;
|
|
6996
|
+
};
|
|
6345
6997
|
header?: never;
|
|
6346
6998
|
path: {
|
|
6347
6999
|
owner: string;
|
|
6348
7000
|
project: string;
|
|
6349
|
-
/** @description Identifier of the automation rule. */
|
|
6350
|
-
ruleId: string;
|
|
6351
7001
|
};
|
|
6352
7002
|
cookie?: never;
|
|
6353
7003
|
};
|
|
6354
7004
|
requestBody?: never;
|
|
6355
7005
|
responses: {
|
|
6356
|
-
/** @description
|
|
7006
|
+
/** @description List of contributors */
|
|
6357
7007
|
200: {
|
|
6358
7008
|
headers: {
|
|
6359
7009
|
[name: string]: unknown;
|
|
6360
7010
|
};
|
|
6361
7011
|
content: {
|
|
6362
|
-
"application/json":
|
|
7012
|
+
"application/json": {
|
|
7013
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
7014
|
+
results: components["schemas"]["ProjectContributor"][];
|
|
7015
|
+
};
|
|
6363
7016
|
};
|
|
6364
7017
|
};
|
|
6365
7018
|
/** @description Invalid parameters */
|
|
@@ -6409,37 +7062,33 @@ interface operations {
|
|
|
6409
7062
|
};
|
|
6410
7063
|
};
|
|
6411
7064
|
};
|
|
6412
|
-
|
|
7065
|
+
setProjectContributor: {
|
|
6413
7066
|
parameters: {
|
|
6414
7067
|
query?: never;
|
|
6415
7068
|
header?: never;
|
|
6416
7069
|
path: {
|
|
6417
7070
|
owner: string;
|
|
6418
7071
|
project: string;
|
|
6419
|
-
/** @description Identifier of the
|
|
6420
|
-
|
|
7072
|
+
/** @description Identifier of the user: the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
7073
|
+
userId: string;
|
|
6421
7074
|
};
|
|
6422
7075
|
cookie?: never;
|
|
6423
7076
|
};
|
|
6424
7077
|
requestBody: {
|
|
6425
7078
|
content: {
|
|
6426
7079
|
"application/json": {
|
|
6427
|
-
|
|
6428
|
-
events: components["schemas"]["AutomationEvent"][];
|
|
6429
|
-
/** @default [] */
|
|
6430
|
-
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6431
|
-
actions: components["schemas"]["AutomationActionInput"][];
|
|
7080
|
+
level: components["schemas"]["ProjectUserLevel"];
|
|
6432
7081
|
};
|
|
6433
7082
|
};
|
|
6434
7083
|
};
|
|
6435
7084
|
responses: {
|
|
6436
|
-
/** @description The
|
|
7085
|
+
/** @description The granted access */
|
|
6437
7086
|
200: {
|
|
6438
7087
|
headers: {
|
|
6439
7088
|
[name: string]: unknown;
|
|
6440
7089
|
};
|
|
6441
7090
|
content: {
|
|
6442
|
-
"application/json": components["schemas"]["
|
|
7091
|
+
"application/json": components["schemas"]["ProjectContributor"];
|
|
6443
7092
|
};
|
|
6444
7093
|
};
|
|
6445
7094
|
/** @description Invalid parameters */
|
|
@@ -6489,28 +7138,26 @@ interface operations {
|
|
|
6489
7138
|
};
|
|
6490
7139
|
};
|
|
6491
7140
|
};
|
|
6492
|
-
|
|
7141
|
+
removeProjectContributor: {
|
|
6493
7142
|
parameters: {
|
|
6494
7143
|
query?: never;
|
|
6495
7144
|
header?: never;
|
|
6496
7145
|
path: {
|
|
6497
7146
|
owner: string;
|
|
6498
7147
|
project: string;
|
|
6499
|
-
/** @description Identifier of the
|
|
6500
|
-
|
|
7148
|
+
/** @description Identifier of the user: the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
7149
|
+
userId: string;
|
|
6501
7150
|
};
|
|
6502
7151
|
cookie?: never;
|
|
6503
7152
|
};
|
|
6504
7153
|
requestBody?: never;
|
|
6505
7154
|
responses: {
|
|
6506
|
-
/** @description
|
|
6507
|
-
|
|
7155
|
+
/** @description Access revoked */
|
|
7156
|
+
204: {
|
|
6508
7157
|
headers: {
|
|
6509
7158
|
[name: string]: unknown;
|
|
6510
7159
|
};
|
|
6511
|
-
content
|
|
6512
|
-
"application/json": components["schemas"]["AutomationRule"];
|
|
6513
|
-
};
|
|
7160
|
+
content?: never;
|
|
6514
7161
|
};
|
|
6515
7162
|
/** @description Invalid parameters */
|
|
6516
7163
|
400: {
|
|
@@ -6559,14 +7206,9 @@ interface operations {
|
|
|
6559
7206
|
};
|
|
6560
7207
|
};
|
|
6561
7208
|
};
|
|
6562
|
-
|
|
7209
|
+
listProjectTokens: {
|
|
6563
7210
|
parameters: {
|
|
6564
|
-
query?:
|
|
6565
|
-
/** @description Number of items per page (max 100) */
|
|
6566
|
-
perPage?: string;
|
|
6567
|
-
/** @description Page number */
|
|
6568
|
-
page?: string;
|
|
6569
|
-
};
|
|
7211
|
+
query?: never;
|
|
6570
7212
|
header?: never;
|
|
6571
7213
|
path: {
|
|
6572
7214
|
owner: string;
|
|
@@ -6576,16 +7218,13 @@ interface operations {
|
|
|
6576
7218
|
};
|
|
6577
7219
|
requestBody?: never;
|
|
6578
7220
|
responses: {
|
|
6579
|
-
/** @description
|
|
7221
|
+
/** @description The project's tokens, newest first */
|
|
6580
7222
|
200: {
|
|
6581
7223
|
headers: {
|
|
6582
7224
|
[name: string]: unknown;
|
|
6583
7225
|
};
|
|
6584
7226
|
content: {
|
|
6585
|
-
"application/json":
|
|
6586
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
6587
|
-
results: components["schemas"]["ProjectContributor"][];
|
|
6588
|
-
};
|
|
7227
|
+
"application/json": components["schemas"]["ProjectToken"][];
|
|
6589
7228
|
};
|
|
6590
7229
|
};
|
|
6591
7230
|
/** @description Invalid parameters */
|
|
@@ -6635,33 +7274,45 @@ interface operations {
|
|
|
6635
7274
|
};
|
|
6636
7275
|
};
|
|
6637
7276
|
};
|
|
6638
|
-
|
|
7277
|
+
createProjectToken: {
|
|
6639
7278
|
parameters: {
|
|
6640
7279
|
query?: never;
|
|
6641
7280
|
header?: never;
|
|
6642
7281
|
path: {
|
|
6643
7282
|
owner: string;
|
|
6644
7283
|
project: string;
|
|
6645
|
-
/** @description Identifier of the user — the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
6646
|
-
userId: string;
|
|
6647
7284
|
};
|
|
6648
7285
|
cookie?: never;
|
|
6649
7286
|
};
|
|
6650
7287
|
requestBody: {
|
|
6651
7288
|
content: {
|
|
6652
7289
|
"application/json": {
|
|
6653
|
-
|
|
7290
|
+
/** @description A name to recognize the token, e.g. `GitHub Actions`. */
|
|
7291
|
+
name: string;
|
|
7292
|
+
/**
|
|
7293
|
+
* @description What the token can do. Defaults to every permission.
|
|
7294
|
+
* @default [
|
|
7295
|
+
* "builds:write",
|
|
7296
|
+
* "deployments:write",
|
|
7297
|
+
* "projects:read",
|
|
7298
|
+
* "media:read",
|
|
7299
|
+
* "media:write"
|
|
7300
|
+
* ]
|
|
7301
|
+
*/
|
|
7302
|
+
permissions?: components["schemas"]["ProjectTokenPermission"][];
|
|
7303
|
+
/** @description When the token stops working, or `null` for a token that never expires. */
|
|
7304
|
+
expireAt: string | null;
|
|
6654
7305
|
};
|
|
6655
7306
|
};
|
|
6656
7307
|
};
|
|
6657
7308
|
responses: {
|
|
6658
|
-
/** @description The
|
|
6659
|
-
|
|
7309
|
+
/** @description The created token, with its value */
|
|
7310
|
+
201: {
|
|
6660
7311
|
headers: {
|
|
6661
7312
|
[name: string]: unknown;
|
|
6662
7313
|
};
|
|
6663
7314
|
content: {
|
|
6664
|
-
"application/json": components["schemas"]["
|
|
7315
|
+
"application/json": components["schemas"]["CreatedProjectToken"];
|
|
6665
7316
|
};
|
|
6666
7317
|
};
|
|
6667
7318
|
/** @description Invalid parameters */
|
|
@@ -6711,21 +7362,21 @@ interface operations {
|
|
|
6711
7362
|
};
|
|
6712
7363
|
};
|
|
6713
7364
|
};
|
|
6714
|
-
|
|
7365
|
+
deleteProjectToken: {
|
|
6715
7366
|
parameters: {
|
|
6716
7367
|
query?: never;
|
|
6717
7368
|
header?: never;
|
|
6718
7369
|
path: {
|
|
6719
7370
|
owner: string;
|
|
6720
7371
|
project: string;
|
|
6721
|
-
/** @description
|
|
6722
|
-
|
|
7372
|
+
/** @description ID of the token. */
|
|
7373
|
+
tokenId: string;
|
|
6723
7374
|
};
|
|
6724
7375
|
cookie?: never;
|
|
6725
7376
|
};
|
|
6726
7377
|
requestBody?: never;
|
|
6727
7378
|
responses: {
|
|
6728
|
-
/** @description
|
|
7379
|
+
/** @description Token revoked */
|
|
6729
7380
|
204: {
|
|
6730
7381
|
headers: {
|
|
6731
7382
|
[name: string]: unknown;
|
|
@@ -7147,6 +7798,15 @@ interface operations {
|
|
|
7147
7798
|
"application/json": components["schemas"]["Error"];
|
|
7148
7799
|
};
|
|
7149
7800
|
};
|
|
7801
|
+
/** @description Forbidden */
|
|
7802
|
+
403: {
|
|
7803
|
+
headers: {
|
|
7804
|
+
[name: string]: unknown;
|
|
7805
|
+
};
|
|
7806
|
+
content: {
|
|
7807
|
+
"application/json": components["schemas"]["Error"];
|
|
7808
|
+
};
|
|
7809
|
+
};
|
|
7150
7810
|
/** @description Not found */
|
|
7151
7811
|
404: {
|
|
7152
7812
|
headers: {
|
|
@@ -7184,7 +7844,7 @@ interface operations {
|
|
|
7184
7844
|
};
|
|
7185
7845
|
requestBody?: never;
|
|
7186
7846
|
responses: {
|
|
7187
|
-
/** @description
|
|
7847
|
+
/** @description The ignored change */
|
|
7188
7848
|
200: {
|
|
7189
7849
|
headers: {
|
|
7190
7850
|
[name: string]: unknown;
|
|
@@ -7257,7 +7917,7 @@ interface operations {
|
|
|
7257
7917
|
};
|
|
7258
7918
|
requestBody?: never;
|
|
7259
7919
|
responses: {
|
|
7260
|
-
/** @description
|
|
7920
|
+
/** @description The unignored change */
|
|
7261
7921
|
200: {
|
|
7262
7922
|
headers: {
|
|
7263
7923
|
[name: string]: unknown;
|
|
@@ -7428,7 +8088,7 @@ interface operations {
|
|
|
7428
8088
|
};
|
|
7429
8089
|
};
|
|
7430
8090
|
responses: {
|
|
7431
|
-
/** @description
|
|
8091
|
+
/** @description The submitted review */
|
|
7432
8092
|
200: {
|
|
7433
8093
|
headers: {
|
|
7434
8094
|
[name: string]: unknown;
|
|
@@ -7569,7 +8229,7 @@ interface operations {
|
|
|
7569
8229
|
requestBody: {
|
|
7570
8230
|
content: {
|
|
7571
8231
|
"application/json": {
|
|
7572
|
-
/** @description Identifiers of the users to act on
|
|
8232
|
+
/** @description Identifiers of the users to act on: the `id` of a user as returned by `listBuildReviewers` or `getMe`. */
|
|
7573
8233
|
userIds: string[];
|
|
7574
8234
|
};
|
|
7575
8235
|
};
|
|
@@ -7646,7 +8306,7 @@ interface operations {
|
|
|
7646
8306
|
requestBody: {
|
|
7647
8307
|
content: {
|
|
7648
8308
|
"application/json": {
|
|
7649
|
-
/** @description Identifiers of the users to act on
|
|
8309
|
+
/** @description Identifiers of the users to act on: the `id` of a user as returned by `listBuildReviewers` or `getMe`. */
|
|
7650
8310
|
userIds: string[];
|
|
7651
8311
|
};
|
|
7652
8312
|
};
|
|
@@ -8004,7 +8664,7 @@ interface operations {
|
|
|
8004
8664
|
};
|
|
8005
8665
|
requestBody?: never;
|
|
8006
8666
|
responses: {
|
|
8007
|
-
/** @description
|
|
8667
|
+
/** @description The dismissed review */
|
|
8008
8668
|
200: {
|
|
8009
8669
|
headers: {
|
|
8010
8670
|
[name: string]: unknown;
|
|
@@ -8153,7 +8813,7 @@ interface operations {
|
|
|
8153
8813
|
threadId?: string;
|
|
8154
8814
|
/** @description Screenshot diff to anchor the comment to. Required when anchor is set. */
|
|
8155
8815
|
screenshotDiffId?: string;
|
|
8156
|
-
/** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0
|
|
8816
|
+
/** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0-1) coordinates; lines is a 1-based inclusive range. */
|
|
8157
8817
|
anchor?: {
|
|
8158
8818
|
/** @constant */
|
|
8159
8819
|
type: "point";
|
|
@@ -8171,7 +8831,7 @@ interface operations {
|
|
|
8171
8831
|
};
|
|
8172
8832
|
};
|
|
8173
8833
|
responses: {
|
|
8174
|
-
/** @description
|
|
8834
|
+
/** @description The created comment */
|
|
8175
8835
|
201: {
|
|
8176
8836
|
headers: {
|
|
8177
8837
|
[name: string]: unknown;
|
|
@@ -8315,7 +8975,7 @@ interface operations {
|
|
|
8315
8975
|
};
|
|
8316
8976
|
requestBody?: never;
|
|
8317
8977
|
responses: {
|
|
8318
|
-
/** @description
|
|
8978
|
+
/** @description The deleted comment */
|
|
8319
8979
|
200: {
|
|
8320
8980
|
headers: {
|
|
8321
8981
|
[name: string]: unknown;
|
|
@@ -8396,7 +9056,7 @@ interface operations {
|
|
|
8396
9056
|
};
|
|
8397
9057
|
};
|
|
8398
9058
|
responses: {
|
|
8399
|
-
/** @description
|
|
9059
|
+
/** @description The updated comment */
|
|
8400
9060
|
200: {
|
|
8401
9061
|
headers: {
|
|
8402
9062
|
[name: string]: unknown;
|
|
@@ -8475,7 +9135,7 @@ interface operations {
|
|
|
8475
9135
|
};
|
|
8476
9136
|
};
|
|
8477
9137
|
responses: {
|
|
8478
|
-
/** @description
|
|
9138
|
+
/** @description The comment, with the reaction added */
|
|
8479
9139
|
200: {
|
|
8480
9140
|
headers: {
|
|
8481
9141
|
[name: string]: unknown;
|
|
@@ -8550,7 +9210,7 @@ interface operations {
|
|
|
8550
9210
|
};
|
|
8551
9211
|
requestBody?: never;
|
|
8552
9212
|
responses: {
|
|
8553
|
-
/** @description
|
|
9213
|
+
/** @description The comment, with the reaction removed */
|
|
8554
9214
|
200: {
|
|
8555
9215
|
headers: {
|
|
8556
9216
|
[name: string]: unknown;
|
|
@@ -8622,7 +9282,7 @@ interface operations {
|
|
|
8622
9282
|
};
|
|
8623
9283
|
requestBody?: never;
|
|
8624
9284
|
responses: {
|
|
8625
|
-
/** @description
|
|
9285
|
+
/** @description The root comment of the resolved thread */
|
|
8626
9286
|
200: {
|
|
8627
9287
|
headers: {
|
|
8628
9288
|
[name: string]: unknown;
|
|
@@ -8694,7 +9354,7 @@ interface operations {
|
|
|
8694
9354
|
};
|
|
8695
9355
|
requestBody?: never;
|
|
8696
9356
|
responses: {
|
|
8697
|
-
/** @description
|
|
9357
|
+
/** @description The root comment of the reopened thread */
|
|
8698
9358
|
200: {
|
|
8699
9359
|
headers: {
|
|
8700
9360
|
[name: string]: unknown;
|
|
@@ -8766,7 +9426,7 @@ interface operations {
|
|
|
8766
9426
|
};
|
|
8767
9427
|
requestBody?: never;
|
|
8768
9428
|
responses: {
|
|
8769
|
-
/** @description
|
|
9429
|
+
/** @description The root comment of the subscribed thread */
|
|
8770
9430
|
200: {
|
|
8771
9431
|
headers: {
|
|
8772
9432
|
[name: string]: unknown;
|
|
@@ -8838,7 +9498,7 @@ interface operations {
|
|
|
8838
9498
|
};
|
|
8839
9499
|
requestBody?: never;
|
|
8840
9500
|
responses: {
|
|
8841
|
-
/** @description
|
|
9501
|
+
/** @description The root comment of the unsubscribed thread */
|
|
8842
9502
|
200: {
|
|
8843
9503
|
headers: {
|
|
8844
9504
|
[name: string]: unknown;
|
|
@@ -8947,6 +9607,15 @@ interface operations {
|
|
|
8947
9607
|
"application/json": components["schemas"]["Error"];
|
|
8948
9608
|
};
|
|
8949
9609
|
};
|
|
9610
|
+
/** @description Forbidden */
|
|
9611
|
+
403: {
|
|
9612
|
+
headers: {
|
|
9613
|
+
[name: string]: unknown;
|
|
9614
|
+
};
|
|
9615
|
+
content: {
|
|
9616
|
+
"application/json": components["schemas"]["Error"];
|
|
9617
|
+
};
|
|
9618
|
+
};
|
|
8950
9619
|
/** @description Not found */
|
|
8951
9620
|
404: {
|
|
8952
9621
|
headers: {
|
|
@@ -9027,6 +9696,15 @@ interface operations {
|
|
|
9027
9696
|
"application/json": components["schemas"]["Error"];
|
|
9028
9697
|
};
|
|
9029
9698
|
};
|
|
9699
|
+
/** @description Forbidden */
|
|
9700
|
+
403: {
|
|
9701
|
+
headers: {
|
|
9702
|
+
[name: string]: unknown;
|
|
9703
|
+
};
|
|
9704
|
+
content: {
|
|
9705
|
+
"application/json": components["schemas"]["Error"];
|
|
9706
|
+
};
|
|
9707
|
+
};
|
|
9030
9708
|
/** @description Not found */
|
|
9031
9709
|
404: {
|
|
9032
9710
|
headers: {
|
|
@@ -9086,6 +9764,15 @@ interface operations {
|
|
|
9086
9764
|
"application/json": components["schemas"]["Error"];
|
|
9087
9765
|
};
|
|
9088
9766
|
};
|
|
9767
|
+
/** @description Forbidden */
|
|
9768
|
+
403: {
|
|
9769
|
+
headers: {
|
|
9770
|
+
[name: string]: unknown;
|
|
9771
|
+
};
|
|
9772
|
+
content: {
|
|
9773
|
+
"application/json": components["schemas"]["Error"];
|
|
9774
|
+
};
|
|
9775
|
+
};
|
|
9089
9776
|
/** @description Not found */
|
|
9090
9777
|
404: {
|
|
9091
9778
|
headers: {
|
|
@@ -9120,7 +9807,7 @@ interface operations {
|
|
|
9120
9807
|
content: {
|
|
9121
9808
|
"application/json": {
|
|
9122
9809
|
/**
|
|
9123
|
-
* @description The full domain to serve production deployments on, under the Argos deployments domain
|
|
9810
|
+
* @description The full domain to serve production deployments on, under the Argos deployments domain (e.g. `acme-web.argos-ci.live`).
|
|
9124
9811
|
* @example acme-web.argos-ci.live
|
|
9125
9812
|
*/
|
|
9126
9813
|
domain: string;
|
|
@@ -9231,6 +9918,15 @@ interface operations {
|
|
|
9231
9918
|
"application/json": components["schemas"]["Error"];
|
|
9232
9919
|
};
|
|
9233
9920
|
};
|
|
9921
|
+
/** @description Forbidden */
|
|
9922
|
+
403: {
|
|
9923
|
+
headers: {
|
|
9924
|
+
[name: string]: unknown;
|
|
9925
|
+
};
|
|
9926
|
+
content: {
|
|
9927
|
+
"application/json": components["schemas"]["Error"];
|
|
9928
|
+
};
|
|
9929
|
+
};
|
|
9234
9930
|
/** @description Not found */
|
|
9235
9931
|
404: {
|
|
9236
9932
|
headers: {
|
|
@@ -9295,6 +9991,15 @@ interface operations {
|
|
|
9295
9991
|
"application/json": components["schemas"]["Error"];
|
|
9296
9992
|
};
|
|
9297
9993
|
};
|
|
9994
|
+
/** @description Forbidden */
|
|
9995
|
+
403: {
|
|
9996
|
+
headers: {
|
|
9997
|
+
[name: string]: unknown;
|
|
9998
|
+
};
|
|
9999
|
+
content: {
|
|
10000
|
+
"application/json": components["schemas"]["Error"];
|
|
10001
|
+
};
|
|
10002
|
+
};
|
|
9298
10003
|
/** @description Not found */
|
|
9299
10004
|
404: {
|
|
9300
10005
|
headers: {
|
|
@@ -9368,6 +10073,15 @@ interface operations {
|
|
|
9368
10073
|
"application/json": components["schemas"]["Error"];
|
|
9369
10074
|
};
|
|
9370
10075
|
};
|
|
10076
|
+
/** @description Forbidden */
|
|
10077
|
+
403: {
|
|
10078
|
+
headers: {
|
|
10079
|
+
[name: string]: unknown;
|
|
10080
|
+
};
|
|
10081
|
+
content: {
|
|
10082
|
+
"application/json": components["schemas"]["Error"];
|
|
10083
|
+
};
|
|
10084
|
+
};
|
|
9371
10085
|
/** @description Not found */
|
|
9372
10086
|
404: {
|
|
9373
10087
|
headers: {
|
|
@@ -9483,7 +10197,7 @@ interface operations {
|
|
|
9483
10197
|
};
|
|
9484
10198
|
};
|
|
9485
10199
|
responses: {
|
|
9486
|
-
/** @description
|
|
10200
|
+
/** @description The created comment */
|
|
9487
10201
|
201: {
|
|
9488
10202
|
headers: {
|
|
9489
10203
|
[name: string]: unknown;
|
|
@@ -9627,7 +10341,7 @@ interface operations {
|
|
|
9627
10341
|
};
|
|
9628
10342
|
requestBody?: never;
|
|
9629
10343
|
responses: {
|
|
9630
|
-
/** @description
|
|
10344
|
+
/** @description The deleted comment */
|
|
9631
10345
|
200: {
|
|
9632
10346
|
headers: {
|
|
9633
10347
|
[name: string]: unknown;
|
|
@@ -9708,7 +10422,7 @@ interface operations {
|
|
|
9708
10422
|
};
|
|
9709
10423
|
};
|
|
9710
10424
|
responses: {
|
|
9711
|
-
/** @description
|
|
10425
|
+
/** @description The updated comment */
|
|
9712
10426
|
200: {
|
|
9713
10427
|
headers: {
|
|
9714
10428
|
[name: string]: unknown;
|
|
@@ -9787,7 +10501,7 @@ interface operations {
|
|
|
9787
10501
|
};
|
|
9788
10502
|
};
|
|
9789
10503
|
responses: {
|
|
9790
|
-
/** @description
|
|
10504
|
+
/** @description The comment, with the reaction added */
|
|
9791
10505
|
200: {
|
|
9792
10506
|
headers: {
|
|
9793
10507
|
[name: string]: unknown;
|
|
@@ -9862,7 +10576,7 @@ interface operations {
|
|
|
9862
10576
|
};
|
|
9863
10577
|
requestBody?: never;
|
|
9864
10578
|
responses: {
|
|
9865
|
-
/** @description
|
|
10579
|
+
/** @description The comment, with the reaction removed */
|
|
9866
10580
|
200: {
|
|
9867
10581
|
headers: {
|
|
9868
10582
|
[name: string]: unknown;
|
|
@@ -9934,7 +10648,7 @@ interface operations {
|
|
|
9934
10648
|
};
|
|
9935
10649
|
requestBody?: never;
|
|
9936
10650
|
responses: {
|
|
9937
|
-
/** @description
|
|
10651
|
+
/** @description The root comment of the resolved thread */
|
|
9938
10652
|
200: {
|
|
9939
10653
|
headers: {
|
|
9940
10654
|
[name: string]: unknown;
|
|
@@ -10006,7 +10720,7 @@ interface operations {
|
|
|
10006
10720
|
};
|
|
10007
10721
|
requestBody?: never;
|
|
10008
10722
|
responses: {
|
|
10009
|
-
/** @description
|
|
10723
|
+
/** @description The root comment of the reopened thread */
|
|
10010
10724
|
200: {
|
|
10011
10725
|
headers: {
|
|
10012
10726
|
[name: string]: unknown;
|
|
@@ -10078,7 +10792,7 @@ interface operations {
|
|
|
10078
10792
|
};
|
|
10079
10793
|
requestBody?: never;
|
|
10080
10794
|
responses: {
|
|
10081
|
-
/** @description
|
|
10795
|
+
/** @description The root comment of the subscribed thread */
|
|
10082
10796
|
200: {
|
|
10083
10797
|
headers: {
|
|
10084
10798
|
[name: string]: unknown;
|
|
@@ -10150,7 +10864,7 @@ interface operations {
|
|
|
10150
10864
|
};
|
|
10151
10865
|
requestBody?: never;
|
|
10152
10866
|
responses: {
|
|
10153
|
-
/** @description
|
|
10867
|
+
/** @description The root comment of the unsubscribed thread */
|
|
10154
10868
|
200: {
|
|
10155
10869
|
headers: {
|
|
10156
10870
|
[name: string]: unknown;
|
|
@@ -10207,8 +10921,6 @@ interface operations {
|
|
|
10207
10921
|
};
|
|
10208
10922
|
};
|
|
10209
10923
|
}
|
|
10210
|
-
//#endregion
|
|
10211
|
-
//#region src/fetch.d.ts
|
|
10212
10924
|
export declare class APIError extends Error {
|
|
10213
10925
|
/**
|
|
10214
10926
|
* HTTP status code of the response that triggered the error, when available.
|
|
@@ -10225,8 +10937,6 @@ export declare class APIError extends Error {
|
|
|
10225
10937
|
cause?: unknown;
|
|
10226
10938
|
});
|
|
10227
10939
|
}
|
|
10228
|
-
//#endregion
|
|
10229
|
-
//#region src/index.d.ts
|
|
10230
10940
|
export type ArgosAPIClient = ReturnType<typeof createClient>;
|
|
10231
10941
|
/**
|
|
10232
10942
|
* A `User-Agent` value, or a resolver for it. The resolver may be async and is
|
|
@@ -10258,5 +10968,4 @@ export declare function formatAPIError(error: unknown, response?: Response): str
|
|
|
10258
10968
|
* Handle API errors.
|
|
10259
10969
|
*/
|
|
10260
10970
|
export declare function throwAPIError(error: unknown, response?: Response): never;
|
|
10261
|
-
//#endregion
|
|
10262
10971
|
export { schema_d_exports as ArgosAPISchema };
|