@argos-ci/api-client 0.31.3 → 0.32.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 +1088 -381
- 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,6 +1964,8 @@ interface components {
|
|
|
1877
1964
|
projects: {
|
|
1878
1965
|
[key: string]: number;
|
|
1879
1966
|
};
|
|
1967
|
+
/** @description Screenshots captured from Storybook stories. Already included in `total`, so the rest of the test suite is `total - storybook`. */
|
|
1968
|
+
storybook: number;
|
|
1880
1969
|
/** @description Unix timestamp in milliseconds at the start of the period. */
|
|
1881
1970
|
ts: number;
|
|
1882
1971
|
}[];
|
|
@@ -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;
|
|
@@ -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";
|
|
@@ -3105,7 +3250,7 @@ interface operations {
|
|
|
3105
3250
|
path: {
|
|
3106
3251
|
/** @description Slug of the team. */
|
|
3107
3252
|
accountSlug: string;
|
|
3108
|
-
/** @description Identifier of the user to act on
|
|
3253
|
+
/** @description Identifier of the user to act on: the `user.id` returned by `listAccountMembers`, which is the user's account id. */
|
|
3109
3254
|
userId: string;
|
|
3110
3255
|
};
|
|
3111
3256
|
cookie?: never;
|
|
@@ -3173,7 +3318,7 @@ interface operations {
|
|
|
3173
3318
|
path: {
|
|
3174
3319
|
/** @description Slug of the team. */
|
|
3175
3320
|
accountSlug: string;
|
|
3176
|
-
/** @description Identifier of the user to act on
|
|
3321
|
+
/** @description Identifier of the user to act on: the `user.id` returned by `listAccountMembers`, which is the user's account id. */
|
|
3177
3322
|
userId: string;
|
|
3178
3323
|
};
|
|
3179
3324
|
cookie?: never;
|
|
@@ -3678,25 +3823,25 @@ interface operations {
|
|
|
3678
3823
|
};
|
|
3679
3824
|
};
|
|
3680
3825
|
};
|
|
3681
|
-
|
|
3826
|
+
listAccountProjectTokens: {
|
|
3682
3827
|
parameters: {
|
|
3683
3828
|
query?: never;
|
|
3684
3829
|
header?: never;
|
|
3685
3830
|
path: {
|
|
3686
|
-
/** @description Slug of the
|
|
3831
|
+
/** @description Slug of the account. */
|
|
3687
3832
|
accountSlug: string;
|
|
3688
3833
|
};
|
|
3689
3834
|
cookie?: never;
|
|
3690
3835
|
};
|
|
3691
3836
|
requestBody?: never;
|
|
3692
3837
|
responses: {
|
|
3693
|
-
/** @description The
|
|
3838
|
+
/** @description The account's project tokens, newest first */
|
|
3694
3839
|
200: {
|
|
3695
3840
|
headers: {
|
|
3696
3841
|
[name: string]: unknown;
|
|
3697
3842
|
};
|
|
3698
3843
|
content: {
|
|
3699
|
-
"application/json": components["schemas"]["
|
|
3844
|
+
"application/json": components["schemas"]["ProjectToken"][];
|
|
3700
3845
|
};
|
|
3701
3846
|
};
|
|
3702
3847
|
/** @description Invalid parameters */
|
|
@@ -3746,55 +3891,47 @@ interface operations {
|
|
|
3746
3891
|
};
|
|
3747
3892
|
};
|
|
3748
3893
|
};
|
|
3749
|
-
|
|
3894
|
+
createAccountProjectToken: {
|
|
3750
3895
|
parameters: {
|
|
3751
3896
|
query?: never;
|
|
3752
3897
|
header?: never;
|
|
3753
|
-
path
|
|
3898
|
+
path: {
|
|
3899
|
+
/** @description Slug of the account. */
|
|
3900
|
+
accountSlug: string;
|
|
3901
|
+
};
|
|
3754
3902
|
cookie?: never;
|
|
3755
3903
|
};
|
|
3756
|
-
requestBody
|
|
3904
|
+
requestBody: {
|
|
3757
3905
|
content: {
|
|
3758
3906
|
"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
|
-
*/
|
|
3907
|
+
/** @description A name to recognize the token, e.g. `GitHub Actions`. */
|
|
3764
3908
|
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
3909
|
/**
|
|
3776
|
-
* @description
|
|
3777
|
-
* @
|
|
3910
|
+
* @description What the token can do. Defaults to every permission.
|
|
3911
|
+
* @default [
|
|
3912
|
+
* "builds:write",
|
|
3913
|
+
* "deployments:write",
|
|
3914
|
+
* "projects:read",
|
|
3915
|
+
* "media:read",
|
|
3916
|
+
* "media:write"
|
|
3917
|
+
* ]
|
|
3778
3918
|
*/
|
|
3779
|
-
|
|
3780
|
-
/** @description
|
|
3781
|
-
|
|
3782
|
-
|
|
3919
|
+
permissions?: components["schemas"]["ProjectTokenPermission"][];
|
|
3920
|
+
/** @description When the token stops working, or `null` for a token that never expires. */
|
|
3921
|
+
expireAt: string | null;
|
|
3922
|
+
/** @description Names of the projects of the account to link. */
|
|
3923
|
+
projects: string[];
|
|
3783
3924
|
};
|
|
3784
3925
|
};
|
|
3785
3926
|
};
|
|
3786
3927
|
responses: {
|
|
3787
|
-
/** @description The
|
|
3928
|
+
/** @description The created token, with its value */
|
|
3788
3929
|
201: {
|
|
3789
3930
|
headers: {
|
|
3790
3931
|
[name: string]: unknown;
|
|
3791
3932
|
};
|
|
3792
3933
|
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
|
-
};
|
|
3934
|
+
"application/json": components["schemas"]["CreatedProjectToken"];
|
|
3798
3935
|
};
|
|
3799
3936
|
};
|
|
3800
3937
|
/** @description Invalid parameters */
|
|
@@ -3844,26 +3981,26 @@ interface operations {
|
|
|
3844
3981
|
};
|
|
3845
3982
|
};
|
|
3846
3983
|
};
|
|
3847
|
-
|
|
3984
|
+
deleteAccountProjectToken: {
|
|
3848
3985
|
parameters: {
|
|
3849
3986
|
query?: never;
|
|
3850
3987
|
header?: never;
|
|
3851
3988
|
path: {
|
|
3852
|
-
/** @description
|
|
3853
|
-
|
|
3989
|
+
/** @description Slug of the account. */
|
|
3990
|
+
accountSlug: string;
|
|
3991
|
+
/** @description ID of the token. */
|
|
3992
|
+
tokenId: string;
|
|
3854
3993
|
};
|
|
3855
3994
|
cookie?: never;
|
|
3856
3995
|
};
|
|
3857
3996
|
requestBody?: never;
|
|
3858
3997
|
responses: {
|
|
3859
|
-
/** @description
|
|
3860
|
-
|
|
3998
|
+
/** @description Token revoked */
|
|
3999
|
+
204: {
|
|
3861
4000
|
headers: {
|
|
3862
4001
|
[name: string]: unknown;
|
|
3863
4002
|
};
|
|
3864
|
-
content
|
|
3865
|
-
"application/json": components["schemas"]["Media"];
|
|
3866
|
-
};
|
|
4003
|
+
content?: never;
|
|
3867
4004
|
};
|
|
3868
4005
|
/** @description Invalid parameters */
|
|
3869
4006
|
400: {
|
|
@@ -3912,24 +4049,26 @@ interface operations {
|
|
|
3912
4049
|
};
|
|
3913
4050
|
};
|
|
3914
4051
|
};
|
|
3915
|
-
|
|
4052
|
+
resetAccountInviteLink: {
|
|
3916
4053
|
parameters: {
|
|
3917
4054
|
query?: never;
|
|
3918
4055
|
header?: never;
|
|
3919
4056
|
path: {
|
|
3920
|
-
/** @description
|
|
3921
|
-
|
|
4057
|
+
/** @description Slug of the team. */
|
|
4058
|
+
accountSlug: string;
|
|
3922
4059
|
};
|
|
3923
4060
|
cookie?: never;
|
|
3924
4061
|
};
|
|
3925
4062
|
requestBody?: never;
|
|
3926
4063
|
responses: {
|
|
3927
|
-
/** @description
|
|
3928
|
-
|
|
4064
|
+
/** @description The new invite link */
|
|
4065
|
+
200: {
|
|
3929
4066
|
headers: {
|
|
3930
4067
|
[name: string]: unknown;
|
|
3931
4068
|
};
|
|
3932
|
-
content
|
|
4069
|
+
content: {
|
|
4070
|
+
"application/json": components["schemas"]["InviteLink"];
|
|
4071
|
+
};
|
|
3933
4072
|
};
|
|
3934
4073
|
/** @description Invalid parameters */
|
|
3935
4074
|
400: {
|
|
@@ -3978,14 +4117,11 @@ interface operations {
|
|
|
3978
4117
|
};
|
|
3979
4118
|
};
|
|
3980
4119
|
};
|
|
3981
|
-
|
|
4120
|
+
createMedia: {
|
|
3982
4121
|
parameters: {
|
|
3983
4122
|
query?: never;
|
|
3984
4123
|
header?: never;
|
|
3985
|
-
path
|
|
3986
|
-
/** @description The media ID */
|
|
3987
|
-
mediaId: string;
|
|
3988
|
-
};
|
|
4124
|
+
path?: never;
|
|
3989
4125
|
cookie?: never;
|
|
3990
4126
|
};
|
|
3991
4127
|
requestBody?: {
|
|
@@ -3996,21 +4132,41 @@ interface operations {
|
|
|
3996
4132
|
* @example before.png
|
|
3997
4133
|
* @example checkout-flow.mp4
|
|
3998
4134
|
*/
|
|
3999
|
-
name
|
|
4135
|
+
name: string;
|
|
4136
|
+
state?: ("before" | "after") | null;
|
|
4000
4137
|
/** @description Prose shown under the media in the managed pull request comment. */
|
|
4001
4138
|
description?: string | null;
|
|
4139
|
+
/** @description Content type of the media file */
|
|
4140
|
+
contentType: string;
|
|
4141
|
+
/** @description Size of the file in bytes. Checked against your plan's limit before the upload is signed. */
|
|
4142
|
+
size: number;
|
|
4143
|
+
/** @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. */
|
|
4144
|
+
hash: string;
|
|
4145
|
+
/** @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. */
|
|
4146
|
+
visibility?: ("team" | "public") | null;
|
|
4147
|
+
/**
|
|
4148
|
+
* @description Project to upload to, as `owner/project`. Required with a personal access token, and with a project token linked to several projects.
|
|
4149
|
+
* @example acme/web
|
|
4150
|
+
*/
|
|
4151
|
+
project?: string | null;
|
|
4152
|
+
/** @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. */
|
|
4153
|
+
prNumber?: number | null;
|
|
4002
4154
|
branch?: string | null;
|
|
4003
4155
|
};
|
|
4004
4156
|
};
|
|
4005
4157
|
};
|
|
4006
4158
|
responses: {
|
|
4007
|
-
/** @description The
|
|
4008
|
-
|
|
4159
|
+
/** @description The registered media and where to upload it */
|
|
4160
|
+
201: {
|
|
4009
4161
|
headers: {
|
|
4010
4162
|
[name: string]: unknown;
|
|
4011
4163
|
};
|
|
4012
4164
|
content: {
|
|
4013
|
-
"application/json":
|
|
4165
|
+
"application/json": {
|
|
4166
|
+
media: components["schemas"]["Media"];
|
|
4167
|
+
/** @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. */
|
|
4168
|
+
upload: components["schemas"]["MediaUploadTarget"] | null;
|
|
4169
|
+
};
|
|
4014
4170
|
};
|
|
4015
4171
|
};
|
|
4016
4172
|
/** @description Invalid parameters */
|
|
@@ -4060,7 +4216,7 @@ interface operations {
|
|
|
4060
4216
|
};
|
|
4061
4217
|
};
|
|
4062
4218
|
};
|
|
4063
|
-
|
|
4219
|
+
getMedia: {
|
|
4064
4220
|
parameters: {
|
|
4065
4221
|
query?: never;
|
|
4066
4222
|
header?: never;
|
|
@@ -4072,13 +4228,13 @@ interface operations {
|
|
|
4072
4228
|
};
|
|
4073
4229
|
requestBody?: never;
|
|
4074
4230
|
responses: {
|
|
4075
|
-
/** @description
|
|
4231
|
+
/** @description Media details */
|
|
4076
4232
|
200: {
|
|
4077
4233
|
headers: {
|
|
4078
4234
|
[name: string]: unknown;
|
|
4079
4235
|
};
|
|
4080
4236
|
content: {
|
|
4081
|
-
"application/json": components["schemas"]["
|
|
4237
|
+
"application/json": components["schemas"]["Media"];
|
|
4082
4238
|
};
|
|
4083
4239
|
};
|
|
4084
4240
|
/** @description Invalid parameters */
|
|
@@ -4128,7 +4284,7 @@ interface operations {
|
|
|
4128
4284
|
};
|
|
4129
4285
|
};
|
|
4130
4286
|
};
|
|
4131
|
-
|
|
4287
|
+
deleteMedia: {
|
|
4132
4288
|
parameters: {
|
|
4133
4289
|
query?: never;
|
|
4134
4290
|
header?: never;
|
|
@@ -4140,14 +4296,12 @@ interface operations {
|
|
|
4140
4296
|
};
|
|
4141
4297
|
requestBody?: never;
|
|
4142
4298
|
responses: {
|
|
4143
|
-
/** @description
|
|
4144
|
-
|
|
4299
|
+
/** @description Media deleted */
|
|
4300
|
+
204: {
|
|
4145
4301
|
headers: {
|
|
4146
4302
|
[name: string]: unknown;
|
|
4147
4303
|
};
|
|
4148
|
-
content
|
|
4149
|
-
"application/json": components["schemas"]["Media"];
|
|
4150
|
-
};
|
|
4304
|
+
content?: never;
|
|
4151
4305
|
};
|
|
4152
4306
|
/** @description Invalid parameters */
|
|
4153
4307
|
400: {
|
|
@@ -4196,7 +4350,7 @@ interface operations {
|
|
|
4196
4350
|
};
|
|
4197
4351
|
};
|
|
4198
4352
|
};
|
|
4199
|
-
|
|
4353
|
+
updateMedia: {
|
|
4200
4354
|
parameters: {
|
|
4201
4355
|
query?: never;
|
|
4202
4356
|
header?: never;
|
|
@@ -4206,15 +4360,29 @@ interface operations {
|
|
|
4206
4360
|
};
|
|
4207
4361
|
cookie?: never;
|
|
4208
4362
|
};
|
|
4209
|
-
requestBody?:
|
|
4363
|
+
requestBody?: {
|
|
4364
|
+
content: {
|
|
4365
|
+
"application/json": {
|
|
4366
|
+
/**
|
|
4367
|
+
* @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.
|
|
4368
|
+
* @example before.png
|
|
4369
|
+
* @example checkout-flow.mp4
|
|
4370
|
+
*/
|
|
4371
|
+
name?: string;
|
|
4372
|
+
/** @description Prose shown under the media in the managed pull request comment. */
|
|
4373
|
+
description?: string | null;
|
|
4374
|
+
branch?: string | null;
|
|
4375
|
+
};
|
|
4376
|
+
};
|
|
4377
|
+
};
|
|
4210
4378
|
responses: {
|
|
4211
|
-
/** @description
|
|
4379
|
+
/** @description The updated media */
|
|
4212
4380
|
200: {
|
|
4213
4381
|
headers: {
|
|
4214
4382
|
[name: string]: unknown;
|
|
4215
4383
|
};
|
|
4216
4384
|
content: {
|
|
4217
|
-
"application/json": components["schemas"]["
|
|
4385
|
+
"application/json": components["schemas"]["Media"];
|
|
4218
4386
|
};
|
|
4219
4387
|
};
|
|
4220
4388
|
/** @description Invalid parameters */
|
|
@@ -4264,7 +4432,7 @@ interface operations {
|
|
|
4264
4432
|
};
|
|
4265
4433
|
};
|
|
4266
4434
|
};
|
|
4267
|
-
|
|
4435
|
+
listMediaVersions: {
|
|
4268
4436
|
parameters: {
|
|
4269
4437
|
query?: never;
|
|
4270
4438
|
header?: never;
|
|
@@ -4274,32 +4442,236 @@ interface operations {
|
|
|
4274
4442
|
};
|
|
4275
4443
|
cookie?: never;
|
|
4276
4444
|
};
|
|
4277
|
-
requestBody
|
|
4278
|
-
|
|
4279
|
-
|
|
4280
|
-
|
|
4281
|
-
|
|
4282
|
-
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
|
|
4296
|
-
|
|
4445
|
+
requestBody?: never;
|
|
4446
|
+
responses: {
|
|
4447
|
+
/** @description The media's versions, newest first */
|
|
4448
|
+
200: {
|
|
4449
|
+
headers: {
|
|
4450
|
+
[name: string]: unknown;
|
|
4451
|
+
};
|
|
4452
|
+
content: {
|
|
4453
|
+
"application/json": components["schemas"]["MediaVersion"][];
|
|
4454
|
+
};
|
|
4455
|
+
};
|
|
4456
|
+
/** @description Invalid parameters */
|
|
4457
|
+
400: {
|
|
4458
|
+
headers: {
|
|
4459
|
+
[name: string]: unknown;
|
|
4460
|
+
};
|
|
4461
|
+
content: {
|
|
4462
|
+
"application/json": components["schemas"]["Error"];
|
|
4463
|
+
};
|
|
4464
|
+
};
|
|
4465
|
+
/** @description Unauthorized */
|
|
4466
|
+
401: {
|
|
4467
|
+
headers: {
|
|
4468
|
+
[name: string]: unknown;
|
|
4469
|
+
};
|
|
4470
|
+
content: {
|
|
4471
|
+
"application/json": components["schemas"]["Error"];
|
|
4472
|
+
};
|
|
4473
|
+
};
|
|
4474
|
+
/** @description Forbidden */
|
|
4475
|
+
403: {
|
|
4476
|
+
headers: {
|
|
4477
|
+
[name: string]: unknown;
|
|
4478
|
+
};
|
|
4479
|
+
content: {
|
|
4480
|
+
"application/json": components["schemas"]["Error"];
|
|
4481
|
+
};
|
|
4482
|
+
};
|
|
4483
|
+
/** @description Not found */
|
|
4484
|
+
404: {
|
|
4485
|
+
headers: {
|
|
4486
|
+
[name: string]: unknown;
|
|
4487
|
+
};
|
|
4488
|
+
content: {
|
|
4489
|
+
"application/json": components["schemas"]["Error"];
|
|
4490
|
+
};
|
|
4491
|
+
};
|
|
4492
|
+
/** @description Server error */
|
|
4493
|
+
500: {
|
|
4494
|
+
headers: {
|
|
4495
|
+
[name: string]: unknown;
|
|
4496
|
+
};
|
|
4497
|
+
content: {
|
|
4498
|
+
"application/json": components["schemas"]["Error"];
|
|
4499
|
+
};
|
|
4500
|
+
};
|
|
4501
|
+
};
|
|
4502
|
+
};
|
|
4503
|
+
finalizeMedia: {
|
|
4504
|
+
parameters: {
|
|
4505
|
+
query?: never;
|
|
4506
|
+
header?: never;
|
|
4507
|
+
path: {
|
|
4508
|
+
/** @description The media ID */
|
|
4509
|
+
mediaId: string;
|
|
4510
|
+
};
|
|
4511
|
+
cookie?: never;
|
|
4512
|
+
};
|
|
4513
|
+
requestBody?: never;
|
|
4514
|
+
responses: {
|
|
4515
|
+
/** @description The finalized media */
|
|
4516
|
+
200: {
|
|
4517
|
+
headers: {
|
|
4518
|
+
[name: string]: unknown;
|
|
4519
|
+
};
|
|
4520
|
+
content: {
|
|
4521
|
+
"application/json": components["schemas"]["Media"];
|
|
4522
|
+
};
|
|
4523
|
+
};
|
|
4524
|
+
/** @description Invalid parameters */
|
|
4525
|
+
400: {
|
|
4526
|
+
headers: {
|
|
4527
|
+
[name: string]: unknown;
|
|
4528
|
+
};
|
|
4529
|
+
content: {
|
|
4530
|
+
"application/json": components["schemas"]["Error"];
|
|
4531
|
+
};
|
|
4532
|
+
};
|
|
4533
|
+
/** @description Unauthorized */
|
|
4534
|
+
401: {
|
|
4535
|
+
headers: {
|
|
4536
|
+
[name: string]: unknown;
|
|
4537
|
+
};
|
|
4538
|
+
content: {
|
|
4539
|
+
"application/json": components["schemas"]["Error"];
|
|
4540
|
+
};
|
|
4541
|
+
};
|
|
4542
|
+
/** @description Forbidden */
|
|
4543
|
+
403: {
|
|
4544
|
+
headers: {
|
|
4545
|
+
[name: string]: unknown;
|
|
4546
|
+
};
|
|
4547
|
+
content: {
|
|
4548
|
+
"application/json": components["schemas"]["Error"];
|
|
4549
|
+
};
|
|
4550
|
+
};
|
|
4551
|
+
/** @description Not found */
|
|
4552
|
+
404: {
|
|
4553
|
+
headers: {
|
|
4554
|
+
[name: string]: unknown;
|
|
4555
|
+
};
|
|
4556
|
+
content: {
|
|
4557
|
+
"application/json": components["schemas"]["Error"];
|
|
4558
|
+
};
|
|
4559
|
+
};
|
|
4560
|
+
/** @description Server error */
|
|
4561
|
+
500: {
|
|
4562
|
+
headers: {
|
|
4563
|
+
[name: string]: unknown;
|
|
4564
|
+
};
|
|
4565
|
+
content: {
|
|
4566
|
+
"application/json": components["schemas"]["Error"];
|
|
4567
|
+
};
|
|
4568
|
+
};
|
|
4569
|
+
};
|
|
4570
|
+
};
|
|
4571
|
+
listMediaComments: {
|
|
4572
|
+
parameters: {
|
|
4573
|
+
query?: never;
|
|
4574
|
+
header?: never;
|
|
4575
|
+
path: {
|
|
4576
|
+
/** @description The media ID */
|
|
4577
|
+
mediaId: string;
|
|
4578
|
+
};
|
|
4579
|
+
cookie?: never;
|
|
4580
|
+
};
|
|
4581
|
+
requestBody?: never;
|
|
4582
|
+
responses: {
|
|
4583
|
+
/** @description Comments, oldest first. Replies carry a threadId pointing at their root comment. */
|
|
4584
|
+
200: {
|
|
4585
|
+
headers: {
|
|
4586
|
+
[name: string]: unknown;
|
|
4587
|
+
};
|
|
4588
|
+
content: {
|
|
4589
|
+
"application/json": components["schemas"]["Comment"][];
|
|
4590
|
+
};
|
|
4591
|
+
};
|
|
4592
|
+
/** @description Invalid parameters */
|
|
4593
|
+
400: {
|
|
4594
|
+
headers: {
|
|
4595
|
+
[name: string]: unknown;
|
|
4596
|
+
};
|
|
4597
|
+
content: {
|
|
4598
|
+
"application/json": components["schemas"]["Error"];
|
|
4599
|
+
};
|
|
4600
|
+
};
|
|
4601
|
+
/** @description Unauthorized */
|
|
4602
|
+
401: {
|
|
4603
|
+
headers: {
|
|
4604
|
+
[name: string]: unknown;
|
|
4605
|
+
};
|
|
4606
|
+
content: {
|
|
4607
|
+
"application/json": components["schemas"]["Error"];
|
|
4608
|
+
};
|
|
4609
|
+
};
|
|
4610
|
+
/** @description Forbidden */
|
|
4611
|
+
403: {
|
|
4612
|
+
headers: {
|
|
4613
|
+
[name: string]: unknown;
|
|
4614
|
+
};
|
|
4615
|
+
content: {
|
|
4616
|
+
"application/json": components["schemas"]["Error"];
|
|
4617
|
+
};
|
|
4618
|
+
};
|
|
4619
|
+
/** @description Not found */
|
|
4620
|
+
404: {
|
|
4621
|
+
headers: {
|
|
4622
|
+
[name: string]: unknown;
|
|
4623
|
+
};
|
|
4624
|
+
content: {
|
|
4625
|
+
"application/json": components["schemas"]["Error"];
|
|
4626
|
+
};
|
|
4627
|
+
};
|
|
4628
|
+
/** @description Server error */
|
|
4629
|
+
500: {
|
|
4630
|
+
headers: {
|
|
4631
|
+
[name: string]: unknown;
|
|
4632
|
+
};
|
|
4633
|
+
content: {
|
|
4634
|
+
"application/json": components["schemas"]["Error"];
|
|
4635
|
+
};
|
|
4636
|
+
};
|
|
4637
|
+
};
|
|
4638
|
+
};
|
|
4639
|
+
createMediaComment: {
|
|
4640
|
+
parameters: {
|
|
4641
|
+
query?: never;
|
|
4642
|
+
header?: never;
|
|
4643
|
+
path: {
|
|
4644
|
+
/** @description The media ID */
|
|
4645
|
+
mediaId: string;
|
|
4646
|
+
};
|
|
4647
|
+
cookie?: never;
|
|
4648
|
+
};
|
|
4649
|
+
requestBody: {
|
|
4650
|
+
content: {
|
|
4651
|
+
"application/json": {
|
|
4652
|
+
/** @description Comment content. Either Markdown text or the JSON representation of a rich-text document. */
|
|
4653
|
+
body: string | {
|
|
4654
|
+
[key: string]: unknown;
|
|
4655
|
+
};
|
|
4656
|
+
/** @description Public ID of the root comment to reply to (e.g. `comment-xf23d`). */
|
|
4657
|
+
threadId?: string;
|
|
4658
|
+
/** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0-1) coordinates; lines is a 1-based inclusive range. */
|
|
4659
|
+
anchor?: {
|
|
4660
|
+
/** @constant */
|
|
4661
|
+
type: "point";
|
|
4662
|
+
x: number;
|
|
4663
|
+
y: number;
|
|
4664
|
+
} | {
|
|
4665
|
+
/** @constant */
|
|
4666
|
+
type: "lines";
|
|
4667
|
+
from: number;
|
|
4668
|
+
to: number;
|
|
4297
4669
|
};
|
|
4298
4670
|
};
|
|
4299
4671
|
};
|
|
4300
4672
|
};
|
|
4301
4673
|
responses: {
|
|
4302
|
-
/** @description
|
|
4674
|
+
/** @description The created comment */
|
|
4303
4675
|
201: {
|
|
4304
4676
|
headers: {
|
|
4305
4677
|
[name: string]: unknown;
|
|
@@ -4439,7 +4811,7 @@ interface operations {
|
|
|
4439
4811
|
};
|
|
4440
4812
|
requestBody?: never;
|
|
4441
4813
|
responses: {
|
|
4442
|
-
/** @description
|
|
4814
|
+
/** @description The deleted comment */
|
|
4443
4815
|
200: {
|
|
4444
4816
|
headers: {
|
|
4445
4817
|
[name: string]: unknown;
|
|
@@ -4518,7 +4890,7 @@ interface operations {
|
|
|
4518
4890
|
};
|
|
4519
4891
|
};
|
|
4520
4892
|
responses: {
|
|
4521
|
-
/** @description
|
|
4893
|
+
/** @description The updated comment */
|
|
4522
4894
|
200: {
|
|
4523
4895
|
headers: {
|
|
4524
4896
|
[name: string]: unknown;
|
|
@@ -4595,7 +4967,7 @@ interface operations {
|
|
|
4595
4967
|
};
|
|
4596
4968
|
};
|
|
4597
4969
|
responses: {
|
|
4598
|
-
/** @description
|
|
4970
|
+
/** @description The comment, with the reaction added */
|
|
4599
4971
|
200: {
|
|
4600
4972
|
headers: {
|
|
4601
4973
|
[name: string]: unknown;
|
|
@@ -4668,7 +5040,7 @@ interface operations {
|
|
|
4668
5040
|
};
|
|
4669
5041
|
requestBody?: never;
|
|
4670
5042
|
responses: {
|
|
4671
|
-
/** @description
|
|
5043
|
+
/** @description The comment, with the reaction removed */
|
|
4672
5044
|
200: {
|
|
4673
5045
|
headers: {
|
|
4674
5046
|
[name: string]: unknown;
|
|
@@ -4738,7 +5110,7 @@ interface operations {
|
|
|
4738
5110
|
};
|
|
4739
5111
|
requestBody?: never;
|
|
4740
5112
|
responses: {
|
|
4741
|
-
/** @description
|
|
5113
|
+
/** @description The root comment of the resolved thread */
|
|
4742
5114
|
200: {
|
|
4743
5115
|
headers: {
|
|
4744
5116
|
[name: string]: unknown;
|
|
@@ -4808,7 +5180,7 @@ interface operations {
|
|
|
4808
5180
|
};
|
|
4809
5181
|
requestBody?: never;
|
|
4810
5182
|
responses: {
|
|
4811
|
-
/** @description
|
|
5183
|
+
/** @description The root comment of the reopened thread */
|
|
4812
5184
|
200: {
|
|
4813
5185
|
headers: {
|
|
4814
5186
|
[name: string]: unknown;
|
|
@@ -4878,7 +5250,7 @@ interface operations {
|
|
|
4878
5250
|
};
|
|
4879
5251
|
requestBody?: never;
|
|
4880
5252
|
responses: {
|
|
4881
|
-
/** @description
|
|
5253
|
+
/** @description The root comment of the subscribed thread */
|
|
4882
5254
|
200: {
|
|
4883
5255
|
headers: {
|
|
4884
5256
|
[name: string]: unknown;
|
|
@@ -4948,7 +5320,7 @@ interface operations {
|
|
|
4948
5320
|
};
|
|
4949
5321
|
requestBody?: never;
|
|
4950
5322
|
responses: {
|
|
4951
|
-
/** @description
|
|
5323
|
+
/** @description The root comment of the unsubscribed thread */
|
|
4952
5324
|
200: {
|
|
4953
5325
|
headers: {
|
|
4954
5326
|
[name: string]: unknown;
|
|
@@ -5014,6 +5386,8 @@ interface operations {
|
|
|
5014
5386
|
requestBody?: {
|
|
5015
5387
|
content: {
|
|
5016
5388
|
"application/json": {
|
|
5389
|
+
/** @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. */
|
|
5390
|
+
project?: string | null;
|
|
5017
5391
|
/** @description The commit the build is running on */
|
|
5018
5392
|
commit: components["schemas"]["Sha1Hash"];
|
|
5019
5393
|
/** @description The branch the build is running on */
|
|
@@ -5057,7 +5431,6 @@ interface operations {
|
|
|
5057
5431
|
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
5058
5432
|
*/
|
|
5059
5433
|
subset?: boolean | null;
|
|
5060
|
-
} & ({
|
|
5061
5434
|
/**
|
|
5062
5435
|
* @deprecated
|
|
5063
5436
|
* @description Keys of screenshot files
|
|
@@ -5065,39 +5438,84 @@ interface operations {
|
|
|
5065
5438
|
screenshotKeys: components["schemas"]["Sha256Hash"][];
|
|
5066
5439
|
screenshots?: unknown;
|
|
5067
5440
|
} | {
|
|
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
|
-
|
|
5441
|
+
/** @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. */
|
|
5442
|
+
project?: string | null;
|
|
5443
|
+
/** @description The commit the build is running on */
|
|
5444
|
+
commit: components["schemas"]["Sha1Hash"];
|
|
5445
|
+
/** @description The branch the build is running on */
|
|
5446
|
+
branch: components["schemas"]["GitBranch"];
|
|
5447
|
+
/** @description Keys of Playwright trace files */
|
|
5448
|
+
pwTraceKeys?: components["schemas"]["Sha256Hash"][];
|
|
5449
|
+
/** @description The name of the build (for multi-build setups) */
|
|
5450
|
+
name?: string | null;
|
|
5451
|
+
/** @description Whether to run the build in parallel */
|
|
5452
|
+
parallel?: boolean | null;
|
|
5453
|
+
/** @description A unique nonce for the parallel build */
|
|
5454
|
+
parallelNonce?: string | null;
|
|
5455
|
+
/** @description The pull request number */
|
|
5456
|
+
prNumber?: number | null;
|
|
5457
|
+
/** @description The head commit of the pull request */
|
|
5458
|
+
prHeadCommit?: components["schemas"]["Sha1Hash"] | null;
|
|
5459
|
+
/** @description The commit to use as a reference for the build */
|
|
5460
|
+
referenceCommit?: components["schemas"]["Sha1Hash"] | null;
|
|
5461
|
+
/** @description The branch to use as a reference for the build */
|
|
5462
|
+
referenceBranch?: string | null;
|
|
5463
|
+
/** @description The parent commits of the build */
|
|
5464
|
+
parentCommits?: components["schemas"]["Sha1Hash"][] | null;
|
|
5465
|
+
/** @description The mode in which the build is running */
|
|
5466
|
+
mode?: ("ci" | "monitoring") | null;
|
|
5467
|
+
/** @description The CI provider being used */
|
|
5468
|
+
ciProvider?: string | null;
|
|
5469
|
+
/** @description The version of the Argos SDK being used */
|
|
5470
|
+
argosSdk?: string | null;
|
|
5471
|
+
/** @description The ID of the current run */
|
|
5472
|
+
runId?: string | null;
|
|
5473
|
+
/** @description The attempt number of the current run */
|
|
5474
|
+
runAttempt?: number | null;
|
|
5475
|
+
/** @description Whether the build was skipped, not comparing anything and always succeeding */
|
|
5476
|
+
skipped?: boolean | null;
|
|
5477
|
+
/** @description Whether the build has been created in a merge queue */
|
|
5478
|
+
mergeQueue?: boolean | null;
|
|
5479
|
+
/** @description Pull request numbers aggregated by the merge queue build. Requires `mergeQueue` to be `true`. */
|
|
5480
|
+
mergeQueuePrNumbers?: number[] | null;
|
|
5481
|
+
/**
|
|
5482
|
+
* @description Indicates whether this build contains only a subset of screenshots.
|
|
5483
|
+
* This is useful when a build is created from an incomplete test suite where some tests are skipped.
|
|
5484
|
+
*/
|
|
5485
|
+
subset?: boolean | null;
|
|
5486
|
+
/** @description Screenshot files to upload */
|
|
5487
|
+
screenshots: components["schemas"]["ScreenshotUploadRequest"][];
|
|
5488
|
+
screenshotKeys?: unknown;
|
|
5489
|
+
};
|
|
5490
|
+
};
|
|
5491
|
+
};
|
|
5492
|
+
responses: {
|
|
5493
|
+
/** @description Result of build creation */
|
|
5494
|
+
201: {
|
|
5495
|
+
headers: {
|
|
5496
|
+
[name: string]: unknown;
|
|
5497
|
+
};
|
|
5498
|
+
content: {
|
|
5499
|
+
"application/json": {
|
|
5500
|
+
build: components["schemas"]["Build"];
|
|
5501
|
+
screenshots: ({
|
|
5502
|
+
key: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* Format: uri
|
|
5505
|
+
* @deprecated
|
|
5506
|
+
* @description Deprecated. Use postUrl and fields instead.
|
|
5507
|
+
*/
|
|
5508
|
+
putUrl: string;
|
|
5509
|
+
} | {
|
|
5510
|
+
key: string;
|
|
5511
|
+
/** Format: uri */
|
|
5512
|
+
postUrl: string;
|
|
5513
|
+
fields: {
|
|
5514
|
+
[key: string]: string;
|
|
5515
|
+
};
|
|
5516
|
+
})[];
|
|
5517
|
+
pwTraces: ({
|
|
5518
|
+
key: string;
|
|
5101
5519
|
/**
|
|
5102
5520
|
* Format: uri
|
|
5103
5521
|
* @deprecated
|
|
@@ -5133,6 +5551,15 @@ interface operations {
|
|
|
5133
5551
|
"application/json": components["schemas"]["Error"];
|
|
5134
5552
|
};
|
|
5135
5553
|
};
|
|
5554
|
+
/** @description Forbidden */
|
|
5555
|
+
403: {
|
|
5556
|
+
headers: {
|
|
5557
|
+
[name: string]: unknown;
|
|
5558
|
+
};
|
|
5559
|
+
content: {
|
|
5560
|
+
"application/json": components["schemas"]["Error"];
|
|
5561
|
+
};
|
|
5562
|
+
};
|
|
5136
5563
|
/** @description Conflict */
|
|
5137
5564
|
409: {
|
|
5138
5565
|
headers: {
|
|
@@ -5163,6 +5590,8 @@ interface operations {
|
|
|
5163
5590
|
requestBody?: {
|
|
5164
5591
|
content: {
|
|
5165
5592
|
"application/json": {
|
|
5593
|
+
/** @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. */
|
|
5594
|
+
project?: string | null;
|
|
5166
5595
|
/** @description The commit SHA */
|
|
5167
5596
|
commit: components["schemas"]["Sha1Hash"];
|
|
5168
5597
|
/** @description The branch name */
|
|
@@ -5222,6 +5651,15 @@ interface operations {
|
|
|
5222
5651
|
"application/json": components["schemas"]["Error"];
|
|
5223
5652
|
};
|
|
5224
5653
|
};
|
|
5654
|
+
/** @description Forbidden */
|
|
5655
|
+
403: {
|
|
5656
|
+
headers: {
|
|
5657
|
+
[name: string]: unknown;
|
|
5658
|
+
};
|
|
5659
|
+
content: {
|
|
5660
|
+
"application/json": components["schemas"]["Error"];
|
|
5661
|
+
};
|
|
5662
|
+
};
|
|
5225
5663
|
/** @description Server error */
|
|
5226
5664
|
500: {
|
|
5227
5665
|
headers: {
|
|
@@ -5283,6 +5721,15 @@ interface operations {
|
|
|
5283
5721
|
"application/json": components["schemas"]["Error"];
|
|
5284
5722
|
};
|
|
5285
5723
|
};
|
|
5724
|
+
/** @description Forbidden */
|
|
5725
|
+
403: {
|
|
5726
|
+
headers: {
|
|
5727
|
+
[name: string]: unknown;
|
|
5728
|
+
};
|
|
5729
|
+
content: {
|
|
5730
|
+
"application/json": components["schemas"]["Error"];
|
|
5731
|
+
};
|
|
5732
|
+
};
|
|
5286
5733
|
/** @description Not found */
|
|
5287
5734
|
404: {
|
|
5288
5735
|
headers: {
|
|
@@ -5353,6 +5800,15 @@ interface operations {
|
|
|
5353
5800
|
"application/json": components["schemas"]["Error"];
|
|
5354
5801
|
};
|
|
5355
5802
|
};
|
|
5803
|
+
/** @description Forbidden */
|
|
5804
|
+
403: {
|
|
5805
|
+
headers: {
|
|
5806
|
+
[name: string]: unknown;
|
|
5807
|
+
};
|
|
5808
|
+
content: {
|
|
5809
|
+
"application/json": components["schemas"]["Error"];
|
|
5810
|
+
};
|
|
5811
|
+
};
|
|
5356
5812
|
/** @description Not found */
|
|
5357
5813
|
404: {
|
|
5358
5814
|
headers: {
|
|
@@ -5441,6 +5897,8 @@ interface operations {
|
|
|
5441
5897
|
content: {
|
|
5442
5898
|
"application/json": {
|
|
5443
5899
|
parallelNonce: string;
|
|
5900
|
+
/** @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. */
|
|
5901
|
+
project?: string | null;
|
|
5444
5902
|
};
|
|
5445
5903
|
};
|
|
5446
5904
|
};
|
|
@@ -5522,6 +5980,8 @@ interface operations {
|
|
|
5522
5980
|
requestBody?: {
|
|
5523
5981
|
content: {
|
|
5524
5982
|
"application/json": {
|
|
5983
|
+
/** @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. */
|
|
5984
|
+
project?: string | null;
|
|
5525
5985
|
/** @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
5986
|
commits: components["schemas"]["Sha1Hash"][];
|
|
5527
5987
|
/**
|
|
@@ -5569,58 +6029,8 @@ interface operations {
|
|
|
5569
6029
|
"application/json": components["schemas"]["Error"];
|
|
5570
6030
|
};
|
|
5571
6031
|
};
|
|
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: {
|
|
6032
|
+
/** @description Forbidden */
|
|
6033
|
+
403: {
|
|
5624
6034
|
headers: {
|
|
5625
6035
|
[name: string]: unknown;
|
|
5626
6036
|
};
|
|
@@ -5841,7 +6251,10 @@ interface operations {
|
|
|
5841
6251
|
};
|
|
5842
6252
|
getAuthProject: {
|
|
5843
6253
|
parameters: {
|
|
5844
|
-
query?:
|
|
6254
|
+
query?: {
|
|
6255
|
+
/** @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. */
|
|
6256
|
+
project?: string | null;
|
|
6257
|
+
};
|
|
5845
6258
|
header?: never;
|
|
5846
6259
|
path?: never;
|
|
5847
6260
|
cookie?: never;
|
|
@@ -5857,6 +6270,15 @@ interface operations {
|
|
|
5857
6270
|
"application/json": components["schemas"]["Project"];
|
|
5858
6271
|
};
|
|
5859
6272
|
};
|
|
6273
|
+
/** @description Invalid parameters */
|
|
6274
|
+
400: {
|
|
6275
|
+
headers: {
|
|
6276
|
+
[name: string]: unknown;
|
|
6277
|
+
};
|
|
6278
|
+
content: {
|
|
6279
|
+
"application/json": components["schemas"]["Error"];
|
|
6280
|
+
};
|
|
6281
|
+
};
|
|
5860
6282
|
/** @description Unauthorized */
|
|
5861
6283
|
401: {
|
|
5862
6284
|
headers: {
|
|
@@ -5986,7 +6408,7 @@ interface operations {
|
|
|
5986
6408
|
};
|
|
5987
6409
|
};
|
|
5988
6410
|
responses: {
|
|
5989
|
-
/** @description
|
|
6411
|
+
/** @description The created project */
|
|
5990
6412
|
201: {
|
|
5991
6413
|
headers: {
|
|
5992
6414
|
[name: string]: unknown;
|
|
@@ -6013,8 +6435,239 @@ interface operations {
|
|
|
6013
6435
|
"application/json": components["schemas"]["Error"];
|
|
6014
6436
|
};
|
|
6015
6437
|
};
|
|
6016
|
-
/** @description Forbidden */
|
|
6017
|
-
403: {
|
|
6438
|
+
/** @description Forbidden */
|
|
6439
|
+
403: {
|
|
6440
|
+
headers: {
|
|
6441
|
+
[name: string]: unknown;
|
|
6442
|
+
};
|
|
6443
|
+
content: {
|
|
6444
|
+
"application/json": components["schemas"]["Error"];
|
|
6445
|
+
};
|
|
6446
|
+
};
|
|
6447
|
+
/** @description Server error */
|
|
6448
|
+
500: {
|
|
6449
|
+
headers: {
|
|
6450
|
+
[name: string]: unknown;
|
|
6451
|
+
};
|
|
6452
|
+
content: {
|
|
6453
|
+
"application/json": components["schemas"]["Error"];
|
|
6454
|
+
};
|
|
6455
|
+
};
|
|
6456
|
+
};
|
|
6457
|
+
};
|
|
6458
|
+
getProject: {
|
|
6459
|
+
parameters: {
|
|
6460
|
+
query?: never;
|
|
6461
|
+
header?: never;
|
|
6462
|
+
path: {
|
|
6463
|
+
owner: string;
|
|
6464
|
+
project: string;
|
|
6465
|
+
};
|
|
6466
|
+
cookie?: never;
|
|
6467
|
+
};
|
|
6468
|
+
requestBody?: never;
|
|
6469
|
+
responses: {
|
|
6470
|
+
/** @description Project */
|
|
6471
|
+
200: {
|
|
6472
|
+
headers: {
|
|
6473
|
+
[name: string]: unknown;
|
|
6474
|
+
};
|
|
6475
|
+
content: {
|
|
6476
|
+
"application/json": components["schemas"]["Project"];
|
|
6477
|
+
};
|
|
6478
|
+
};
|
|
6479
|
+
/** @description Unauthorized */
|
|
6480
|
+
401: {
|
|
6481
|
+
headers: {
|
|
6482
|
+
[name: string]: unknown;
|
|
6483
|
+
};
|
|
6484
|
+
content: {
|
|
6485
|
+
"application/json": components["schemas"]["Error"];
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
/** @description Forbidden */
|
|
6489
|
+
403: {
|
|
6490
|
+
headers: {
|
|
6491
|
+
[name: string]: unknown;
|
|
6492
|
+
};
|
|
6493
|
+
content: {
|
|
6494
|
+
"application/json": components["schemas"]["Error"];
|
|
6495
|
+
};
|
|
6496
|
+
};
|
|
6497
|
+
/** @description Not found */
|
|
6498
|
+
404: {
|
|
6499
|
+
headers: {
|
|
6500
|
+
[name: string]: unknown;
|
|
6501
|
+
};
|
|
6502
|
+
content: {
|
|
6503
|
+
"application/json": components["schemas"]["Error"];
|
|
6504
|
+
};
|
|
6505
|
+
};
|
|
6506
|
+
/** @description Server error */
|
|
6507
|
+
500: {
|
|
6508
|
+
headers: {
|
|
6509
|
+
[name: string]: unknown;
|
|
6510
|
+
};
|
|
6511
|
+
content: {
|
|
6512
|
+
"application/json": components["schemas"]["Error"];
|
|
6513
|
+
};
|
|
6514
|
+
};
|
|
6515
|
+
};
|
|
6516
|
+
};
|
|
6517
|
+
updateProject: {
|
|
6518
|
+
parameters: {
|
|
6519
|
+
query?: never;
|
|
6520
|
+
header?: never;
|
|
6521
|
+
path: {
|
|
6522
|
+
owner: string;
|
|
6523
|
+
project: string;
|
|
6524
|
+
};
|
|
6525
|
+
cookie?: never;
|
|
6526
|
+
};
|
|
6527
|
+
requestBody: {
|
|
6528
|
+
content: {
|
|
6529
|
+
"application/json": {
|
|
6530
|
+
/** @description New name for the project. Must be unique within the owning account (case-insensitive). */
|
|
6531
|
+
name?: string;
|
|
6532
|
+
/** @description Branch used as the baseline when no better one applies. `null` falls back to the repository's default branch. */
|
|
6533
|
+
defaultBaseBranch?: string | null;
|
|
6534
|
+
/** @description Glob matching the branches whose builds are approved automatically. `null` falls back to the default base branch. */
|
|
6535
|
+
autoApprovedBranchGlob?: string | null;
|
|
6536
|
+
/** @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. */
|
|
6537
|
+
autoApprovalEnabled?: boolean;
|
|
6538
|
+
/** @description Glob matching the branches whose deployments count as production. `null` falls back to the repository's default branch. */
|
|
6539
|
+
deploymentProductionBranchGlob?: string | null;
|
|
6540
|
+
/** @description Force the project's privacy. `null` inherits it from the linked repository. */
|
|
6541
|
+
private?: boolean | null;
|
|
6542
|
+
summaryCheck?: components["schemas"]["SummaryCheck"];
|
|
6543
|
+
awaitingReviewStatus?: components["schemas"]["AwaitingReviewStatus"];
|
|
6544
|
+
/** @description Access given to team members that are not contributors on this project. `null` gives them none. */
|
|
6545
|
+
defaultUserLevel?: components["schemas"]["ProjectUserLevel"] | null;
|
|
6546
|
+
ignoreConfig?: components["schemas"]["IgnoreConfig"];
|
|
6547
|
+
deploymentEnabled?: boolean;
|
|
6548
|
+
deploymentAuth?: components["schemas"]["DeploymentAuth"];
|
|
6549
|
+
githubActionsOidcEnabled?: boolean;
|
|
6550
|
+
tokenlessAuthEnabled?: boolean;
|
|
6551
|
+
};
|
|
6552
|
+
};
|
|
6553
|
+
};
|
|
6554
|
+
responses: {
|
|
6555
|
+
/** @description The updated project */
|
|
6556
|
+
200: {
|
|
6557
|
+
headers: {
|
|
6558
|
+
[name: string]: unknown;
|
|
6559
|
+
};
|
|
6560
|
+
content: {
|
|
6561
|
+
"application/json": components["schemas"]["Project"];
|
|
6562
|
+
};
|
|
6563
|
+
};
|
|
6564
|
+
/** @description Invalid parameters */
|
|
6565
|
+
400: {
|
|
6566
|
+
headers: {
|
|
6567
|
+
[name: string]: unknown;
|
|
6568
|
+
};
|
|
6569
|
+
content: {
|
|
6570
|
+
"application/json": components["schemas"]["Error"];
|
|
6571
|
+
};
|
|
6572
|
+
};
|
|
6573
|
+
/** @description Unauthorized */
|
|
6574
|
+
401: {
|
|
6575
|
+
headers: {
|
|
6576
|
+
[name: string]: unknown;
|
|
6577
|
+
};
|
|
6578
|
+
content: {
|
|
6579
|
+
"application/json": components["schemas"]["Error"];
|
|
6580
|
+
};
|
|
6581
|
+
};
|
|
6582
|
+
/** @description Forbidden */
|
|
6583
|
+
403: {
|
|
6584
|
+
headers: {
|
|
6585
|
+
[name: string]: unknown;
|
|
6586
|
+
};
|
|
6587
|
+
content: {
|
|
6588
|
+
"application/json": components["schemas"]["Error"];
|
|
6589
|
+
};
|
|
6590
|
+
};
|
|
6591
|
+
/** @description Not found */
|
|
6592
|
+
404: {
|
|
6593
|
+
headers: {
|
|
6594
|
+
[name: string]: unknown;
|
|
6595
|
+
};
|
|
6596
|
+
content: {
|
|
6597
|
+
"application/json": components["schemas"]["Error"];
|
|
6598
|
+
};
|
|
6599
|
+
};
|
|
6600
|
+
/** @description Server error */
|
|
6601
|
+
500: {
|
|
6602
|
+
headers: {
|
|
6603
|
+
[name: string]: unknown;
|
|
6604
|
+
};
|
|
6605
|
+
content: {
|
|
6606
|
+
"application/json": components["schemas"]["Error"];
|
|
6607
|
+
};
|
|
6608
|
+
};
|
|
6609
|
+
};
|
|
6610
|
+
};
|
|
6611
|
+
listAutomationRules: {
|
|
6612
|
+
parameters: {
|
|
6613
|
+
query?: {
|
|
6614
|
+
/** @description Number of items per page (max 100) */
|
|
6615
|
+
perPage?: string;
|
|
6616
|
+
/** @description Page number */
|
|
6617
|
+
page?: string;
|
|
6618
|
+
/** @description Restrict to rules that still fire (`true`) or to deactivated ones (`false`). Omit for both. */
|
|
6619
|
+
active?: "true" | "false";
|
|
6620
|
+
};
|
|
6621
|
+
header?: never;
|
|
6622
|
+
path: {
|
|
6623
|
+
owner: string;
|
|
6624
|
+
project: string;
|
|
6625
|
+
};
|
|
6626
|
+
cookie?: never;
|
|
6627
|
+
};
|
|
6628
|
+
requestBody?: never;
|
|
6629
|
+
responses: {
|
|
6630
|
+
/** @description List of automation rules */
|
|
6631
|
+
200: {
|
|
6632
|
+
headers: {
|
|
6633
|
+
[name: string]: unknown;
|
|
6634
|
+
};
|
|
6635
|
+
content: {
|
|
6636
|
+
"application/json": {
|
|
6637
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
6638
|
+
results: components["schemas"]["AutomationRule"][];
|
|
6639
|
+
};
|
|
6640
|
+
};
|
|
6641
|
+
};
|
|
6642
|
+
/** @description Invalid parameters */
|
|
6643
|
+
400: {
|
|
6644
|
+
headers: {
|
|
6645
|
+
[name: string]: unknown;
|
|
6646
|
+
};
|
|
6647
|
+
content: {
|
|
6648
|
+
"application/json": components["schemas"]["Error"];
|
|
6649
|
+
};
|
|
6650
|
+
};
|
|
6651
|
+
/** @description Unauthorized */
|
|
6652
|
+
401: {
|
|
6653
|
+
headers: {
|
|
6654
|
+
[name: string]: unknown;
|
|
6655
|
+
};
|
|
6656
|
+
content: {
|
|
6657
|
+
"application/json": components["schemas"]["Error"];
|
|
6658
|
+
};
|
|
6659
|
+
};
|
|
6660
|
+
/** @description Forbidden */
|
|
6661
|
+
403: {
|
|
6662
|
+
headers: {
|
|
6663
|
+
[name: string]: unknown;
|
|
6664
|
+
};
|
|
6665
|
+
content: {
|
|
6666
|
+
"application/json": components["schemas"]["Error"];
|
|
6667
|
+
};
|
|
6668
|
+
};
|
|
6669
|
+
/** @description Not found */
|
|
6670
|
+
404: {
|
|
6018
6671
|
headers: {
|
|
6019
6672
|
[name: string]: unknown;
|
|
6020
6673
|
};
|
|
@@ -6033,7 +6686,7 @@ interface operations {
|
|
|
6033
6686
|
};
|
|
6034
6687
|
};
|
|
6035
6688
|
};
|
|
6036
|
-
|
|
6689
|
+
createAutomationRule: {
|
|
6037
6690
|
parameters: {
|
|
6038
6691
|
query?: never;
|
|
6039
6692
|
header?: never;
|
|
@@ -6043,15 +6696,34 @@ interface operations {
|
|
|
6043
6696
|
};
|
|
6044
6697
|
cookie?: never;
|
|
6045
6698
|
};
|
|
6046
|
-
requestBody
|
|
6699
|
+
requestBody: {
|
|
6700
|
+
content: {
|
|
6701
|
+
"application/json": {
|
|
6702
|
+
name: string;
|
|
6703
|
+
events: components["schemas"]["AutomationEvent"][];
|
|
6704
|
+
/** @default [] */
|
|
6705
|
+
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6706
|
+
actions: components["schemas"]["AutomationActionInput"][];
|
|
6707
|
+
};
|
|
6708
|
+
};
|
|
6709
|
+
};
|
|
6047
6710
|
responses: {
|
|
6048
|
-
/** @description
|
|
6049
|
-
|
|
6711
|
+
/** @description The created rule */
|
|
6712
|
+
201: {
|
|
6050
6713
|
headers: {
|
|
6051
6714
|
[name: string]: unknown;
|
|
6052
6715
|
};
|
|
6053
6716
|
content: {
|
|
6054
|
-
"application/json": components["schemas"]["
|
|
6717
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6718
|
+
};
|
|
6719
|
+
};
|
|
6720
|
+
/** @description Invalid parameters */
|
|
6721
|
+
400: {
|
|
6722
|
+
headers: {
|
|
6723
|
+
[name: string]: unknown;
|
|
6724
|
+
};
|
|
6725
|
+
content: {
|
|
6726
|
+
"application/json": components["schemas"]["Error"];
|
|
6055
6727
|
};
|
|
6056
6728
|
};
|
|
6057
6729
|
/** @description Unauthorized */
|
|
@@ -6092,48 +6764,27 @@ interface operations {
|
|
|
6092
6764
|
};
|
|
6093
6765
|
};
|
|
6094
6766
|
};
|
|
6095
|
-
|
|
6767
|
+
getAutomationRule: {
|
|
6096
6768
|
parameters: {
|
|
6097
6769
|
query?: never;
|
|
6098
6770
|
header?: never;
|
|
6099
6771
|
path: {
|
|
6100
6772
|
owner: string;
|
|
6101
6773
|
project: string;
|
|
6774
|
+
/** @description Identifier of the automation rule. */
|
|
6775
|
+
ruleId: string;
|
|
6102
6776
|
};
|
|
6103
6777
|
cookie?: never;
|
|
6104
6778
|
};
|
|
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
|
-
};
|
|
6779
|
+
requestBody?: never;
|
|
6129
6780
|
responses: {
|
|
6130
|
-
/** @description The
|
|
6781
|
+
/** @description The automation rule */
|
|
6131
6782
|
200: {
|
|
6132
6783
|
headers: {
|
|
6133
6784
|
[name: string]: unknown;
|
|
6134
6785
|
};
|
|
6135
6786
|
content: {
|
|
6136
|
-
"application/json": components["schemas"]["
|
|
6787
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6137
6788
|
};
|
|
6138
6789
|
};
|
|
6139
6790
|
/** @description Invalid parameters */
|
|
@@ -6183,35 +6834,37 @@ interface operations {
|
|
|
6183
6834
|
};
|
|
6184
6835
|
};
|
|
6185
6836
|
};
|
|
6186
|
-
|
|
6837
|
+
updateAutomationRule: {
|
|
6187
6838
|
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
|
-
};
|
|
6839
|
+
query?: never;
|
|
6196
6840
|
header?: never;
|
|
6197
6841
|
path: {
|
|
6198
6842
|
owner: string;
|
|
6199
6843
|
project: string;
|
|
6844
|
+
/** @description Identifier of the automation rule. */
|
|
6845
|
+
ruleId: string;
|
|
6200
6846
|
};
|
|
6201
6847
|
cookie?: never;
|
|
6202
6848
|
};
|
|
6203
|
-
requestBody
|
|
6849
|
+
requestBody: {
|
|
6850
|
+
content: {
|
|
6851
|
+
"application/json": {
|
|
6852
|
+
name: string;
|
|
6853
|
+
events: components["schemas"]["AutomationEvent"][];
|
|
6854
|
+
/** @default [] */
|
|
6855
|
+
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6856
|
+
actions: components["schemas"]["AutomationActionInput"][];
|
|
6857
|
+
};
|
|
6858
|
+
};
|
|
6859
|
+
};
|
|
6204
6860
|
responses: {
|
|
6205
|
-
/** @description
|
|
6861
|
+
/** @description The updated rule */
|
|
6206
6862
|
200: {
|
|
6207
6863
|
headers: {
|
|
6208
6864
|
[name: string]: unknown;
|
|
6209
6865
|
};
|
|
6210
6866
|
content: {
|
|
6211
|
-
"application/json":
|
|
6212
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
6213
|
-
results: components["schemas"]["AutomationRule"][];
|
|
6214
|
-
};
|
|
6867
|
+
"application/json": components["schemas"]["AutomationRule"];
|
|
6215
6868
|
};
|
|
6216
6869
|
};
|
|
6217
6870
|
/** @description Invalid parameters */
|
|
@@ -6261,30 +6914,22 @@ interface operations {
|
|
|
6261
6914
|
};
|
|
6262
6915
|
};
|
|
6263
6916
|
};
|
|
6264
|
-
|
|
6917
|
+
deactivateAutomationRule: {
|
|
6265
6918
|
parameters: {
|
|
6266
6919
|
query?: never;
|
|
6267
6920
|
header?: never;
|
|
6268
6921
|
path: {
|
|
6269
6922
|
owner: string;
|
|
6270
6923
|
project: string;
|
|
6924
|
+
/** @description Identifier of the automation rule. */
|
|
6925
|
+
ruleId: string;
|
|
6271
6926
|
};
|
|
6272
6927
|
cookie?: never;
|
|
6273
6928
|
};
|
|
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
|
-
};
|
|
6929
|
+
requestBody?: never;
|
|
6285
6930
|
responses: {
|
|
6286
|
-
/** @description The
|
|
6287
|
-
|
|
6931
|
+
/** @description The deactivated rule */
|
|
6932
|
+
200: {
|
|
6288
6933
|
headers: {
|
|
6289
6934
|
[name: string]: unknown;
|
|
6290
6935
|
};
|
|
@@ -6339,27 +6984,33 @@ interface operations {
|
|
|
6339
6984
|
};
|
|
6340
6985
|
};
|
|
6341
6986
|
};
|
|
6342
|
-
|
|
6987
|
+
listProjectContributors: {
|
|
6343
6988
|
parameters: {
|
|
6344
|
-
query?:
|
|
6989
|
+
query?: {
|
|
6990
|
+
/** @description Number of items per page (max 100) */
|
|
6991
|
+
perPage?: string;
|
|
6992
|
+
/** @description Page number */
|
|
6993
|
+
page?: string;
|
|
6994
|
+
};
|
|
6345
6995
|
header?: never;
|
|
6346
6996
|
path: {
|
|
6347
6997
|
owner: string;
|
|
6348
6998
|
project: string;
|
|
6349
|
-
/** @description Identifier of the automation rule. */
|
|
6350
|
-
ruleId: string;
|
|
6351
6999
|
};
|
|
6352
7000
|
cookie?: never;
|
|
6353
7001
|
};
|
|
6354
7002
|
requestBody?: never;
|
|
6355
7003
|
responses: {
|
|
6356
|
-
/** @description
|
|
7004
|
+
/** @description List of contributors */
|
|
6357
7005
|
200: {
|
|
6358
7006
|
headers: {
|
|
6359
7007
|
[name: string]: unknown;
|
|
6360
7008
|
};
|
|
6361
7009
|
content: {
|
|
6362
|
-
"application/json":
|
|
7010
|
+
"application/json": {
|
|
7011
|
+
pageInfo: components["schemas"]["PageInfo"];
|
|
7012
|
+
results: components["schemas"]["ProjectContributor"][];
|
|
7013
|
+
};
|
|
6363
7014
|
};
|
|
6364
7015
|
};
|
|
6365
7016
|
/** @description Invalid parameters */
|
|
@@ -6409,37 +7060,33 @@ interface operations {
|
|
|
6409
7060
|
};
|
|
6410
7061
|
};
|
|
6411
7062
|
};
|
|
6412
|
-
|
|
7063
|
+
setProjectContributor: {
|
|
6413
7064
|
parameters: {
|
|
6414
7065
|
query?: never;
|
|
6415
7066
|
header?: never;
|
|
6416
7067
|
path: {
|
|
6417
7068
|
owner: string;
|
|
6418
7069
|
project: string;
|
|
6419
|
-
/** @description Identifier of the
|
|
6420
|
-
|
|
7070
|
+
/** @description Identifier of the user: the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
7071
|
+
userId: string;
|
|
6421
7072
|
};
|
|
6422
7073
|
cookie?: never;
|
|
6423
7074
|
};
|
|
6424
7075
|
requestBody: {
|
|
6425
7076
|
content: {
|
|
6426
7077
|
"application/json": {
|
|
6427
|
-
|
|
6428
|
-
events: components["schemas"]["AutomationEvent"][];
|
|
6429
|
-
/** @default [] */
|
|
6430
|
-
conditions?: components["schemas"]["AutomationCondition"][];
|
|
6431
|
-
actions: components["schemas"]["AutomationActionInput"][];
|
|
7078
|
+
level: components["schemas"]["ProjectUserLevel"];
|
|
6432
7079
|
};
|
|
6433
7080
|
};
|
|
6434
7081
|
};
|
|
6435
7082
|
responses: {
|
|
6436
|
-
/** @description The
|
|
7083
|
+
/** @description The granted access */
|
|
6437
7084
|
200: {
|
|
6438
7085
|
headers: {
|
|
6439
7086
|
[name: string]: unknown;
|
|
6440
7087
|
};
|
|
6441
7088
|
content: {
|
|
6442
|
-
"application/json": components["schemas"]["
|
|
7089
|
+
"application/json": components["schemas"]["ProjectContributor"];
|
|
6443
7090
|
};
|
|
6444
7091
|
};
|
|
6445
7092
|
/** @description Invalid parameters */
|
|
@@ -6489,28 +7136,26 @@ interface operations {
|
|
|
6489
7136
|
};
|
|
6490
7137
|
};
|
|
6491
7138
|
};
|
|
6492
|
-
|
|
7139
|
+
removeProjectContributor: {
|
|
6493
7140
|
parameters: {
|
|
6494
7141
|
query?: never;
|
|
6495
7142
|
header?: never;
|
|
6496
7143
|
path: {
|
|
6497
7144
|
owner: string;
|
|
6498
7145
|
project: string;
|
|
6499
|
-
/** @description Identifier of the
|
|
6500
|
-
|
|
7146
|
+
/** @description Identifier of the user: the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
7147
|
+
userId: string;
|
|
6501
7148
|
};
|
|
6502
7149
|
cookie?: never;
|
|
6503
7150
|
};
|
|
6504
7151
|
requestBody?: never;
|
|
6505
7152
|
responses: {
|
|
6506
|
-
/** @description
|
|
6507
|
-
|
|
7153
|
+
/** @description Access revoked */
|
|
7154
|
+
204: {
|
|
6508
7155
|
headers: {
|
|
6509
7156
|
[name: string]: unknown;
|
|
6510
7157
|
};
|
|
6511
|
-
content
|
|
6512
|
-
"application/json": components["schemas"]["AutomationRule"];
|
|
6513
|
-
};
|
|
7158
|
+
content?: never;
|
|
6514
7159
|
};
|
|
6515
7160
|
/** @description Invalid parameters */
|
|
6516
7161
|
400: {
|
|
@@ -6559,14 +7204,9 @@ interface operations {
|
|
|
6559
7204
|
};
|
|
6560
7205
|
};
|
|
6561
7206
|
};
|
|
6562
|
-
|
|
7207
|
+
listProjectTokens: {
|
|
6563
7208
|
parameters: {
|
|
6564
|
-
query?:
|
|
6565
|
-
/** @description Number of items per page (max 100) */
|
|
6566
|
-
perPage?: string;
|
|
6567
|
-
/** @description Page number */
|
|
6568
|
-
page?: string;
|
|
6569
|
-
};
|
|
7209
|
+
query?: never;
|
|
6570
7210
|
header?: never;
|
|
6571
7211
|
path: {
|
|
6572
7212
|
owner: string;
|
|
@@ -6576,16 +7216,13 @@ interface operations {
|
|
|
6576
7216
|
};
|
|
6577
7217
|
requestBody?: never;
|
|
6578
7218
|
responses: {
|
|
6579
|
-
/** @description
|
|
7219
|
+
/** @description The project's tokens, newest first */
|
|
6580
7220
|
200: {
|
|
6581
7221
|
headers: {
|
|
6582
7222
|
[name: string]: unknown;
|
|
6583
7223
|
};
|
|
6584
7224
|
content: {
|
|
6585
|
-
"application/json":
|
|
6586
|
-
pageInfo: components["schemas"]["PageInfo"];
|
|
6587
|
-
results: components["schemas"]["ProjectContributor"][];
|
|
6588
|
-
};
|
|
7225
|
+
"application/json": components["schemas"]["ProjectToken"][];
|
|
6589
7226
|
};
|
|
6590
7227
|
};
|
|
6591
7228
|
/** @description Invalid parameters */
|
|
@@ -6635,33 +7272,45 @@ interface operations {
|
|
|
6635
7272
|
};
|
|
6636
7273
|
};
|
|
6637
7274
|
};
|
|
6638
|
-
|
|
7275
|
+
createProjectToken: {
|
|
6639
7276
|
parameters: {
|
|
6640
7277
|
query?: never;
|
|
6641
7278
|
header?: never;
|
|
6642
7279
|
path: {
|
|
6643
7280
|
owner: string;
|
|
6644
7281
|
project: string;
|
|
6645
|
-
/** @description Identifier of the user — the `user.id` returned by `listAccountMembers` or `listProjectContributors`. */
|
|
6646
|
-
userId: string;
|
|
6647
7282
|
};
|
|
6648
7283
|
cookie?: never;
|
|
6649
7284
|
};
|
|
6650
7285
|
requestBody: {
|
|
6651
7286
|
content: {
|
|
6652
7287
|
"application/json": {
|
|
6653
|
-
|
|
7288
|
+
/** @description A name to recognize the token, e.g. `GitHub Actions`. */
|
|
7289
|
+
name: string;
|
|
7290
|
+
/**
|
|
7291
|
+
* @description What the token can do. Defaults to every permission.
|
|
7292
|
+
* @default [
|
|
7293
|
+
* "builds:write",
|
|
7294
|
+
* "deployments:write",
|
|
7295
|
+
* "projects:read",
|
|
7296
|
+
* "media:read",
|
|
7297
|
+
* "media:write"
|
|
7298
|
+
* ]
|
|
7299
|
+
*/
|
|
7300
|
+
permissions?: components["schemas"]["ProjectTokenPermission"][];
|
|
7301
|
+
/** @description When the token stops working, or `null` for a token that never expires. */
|
|
7302
|
+
expireAt: string | null;
|
|
6654
7303
|
};
|
|
6655
7304
|
};
|
|
6656
7305
|
};
|
|
6657
7306
|
responses: {
|
|
6658
|
-
/** @description The
|
|
6659
|
-
|
|
7307
|
+
/** @description The created token, with its value */
|
|
7308
|
+
201: {
|
|
6660
7309
|
headers: {
|
|
6661
7310
|
[name: string]: unknown;
|
|
6662
7311
|
};
|
|
6663
7312
|
content: {
|
|
6664
|
-
"application/json": components["schemas"]["
|
|
7313
|
+
"application/json": components["schemas"]["CreatedProjectToken"];
|
|
6665
7314
|
};
|
|
6666
7315
|
};
|
|
6667
7316
|
/** @description Invalid parameters */
|
|
@@ -6711,21 +7360,21 @@ interface operations {
|
|
|
6711
7360
|
};
|
|
6712
7361
|
};
|
|
6713
7362
|
};
|
|
6714
|
-
|
|
7363
|
+
deleteProjectToken: {
|
|
6715
7364
|
parameters: {
|
|
6716
7365
|
query?: never;
|
|
6717
7366
|
header?: never;
|
|
6718
7367
|
path: {
|
|
6719
7368
|
owner: string;
|
|
6720
7369
|
project: string;
|
|
6721
|
-
/** @description
|
|
6722
|
-
|
|
7370
|
+
/** @description ID of the token. */
|
|
7371
|
+
tokenId: string;
|
|
6723
7372
|
};
|
|
6724
7373
|
cookie?: never;
|
|
6725
7374
|
};
|
|
6726
7375
|
requestBody?: never;
|
|
6727
7376
|
responses: {
|
|
6728
|
-
/** @description
|
|
7377
|
+
/** @description Token revoked */
|
|
6729
7378
|
204: {
|
|
6730
7379
|
headers: {
|
|
6731
7380
|
[name: string]: unknown;
|
|
@@ -7147,6 +7796,15 @@ interface operations {
|
|
|
7147
7796
|
"application/json": components["schemas"]["Error"];
|
|
7148
7797
|
};
|
|
7149
7798
|
};
|
|
7799
|
+
/** @description Forbidden */
|
|
7800
|
+
403: {
|
|
7801
|
+
headers: {
|
|
7802
|
+
[name: string]: unknown;
|
|
7803
|
+
};
|
|
7804
|
+
content: {
|
|
7805
|
+
"application/json": components["schemas"]["Error"];
|
|
7806
|
+
};
|
|
7807
|
+
};
|
|
7150
7808
|
/** @description Not found */
|
|
7151
7809
|
404: {
|
|
7152
7810
|
headers: {
|
|
@@ -7184,7 +7842,7 @@ interface operations {
|
|
|
7184
7842
|
};
|
|
7185
7843
|
requestBody?: never;
|
|
7186
7844
|
responses: {
|
|
7187
|
-
/** @description
|
|
7845
|
+
/** @description The ignored change */
|
|
7188
7846
|
200: {
|
|
7189
7847
|
headers: {
|
|
7190
7848
|
[name: string]: unknown;
|
|
@@ -7257,7 +7915,7 @@ interface operations {
|
|
|
7257
7915
|
};
|
|
7258
7916
|
requestBody?: never;
|
|
7259
7917
|
responses: {
|
|
7260
|
-
/** @description
|
|
7918
|
+
/** @description The unignored change */
|
|
7261
7919
|
200: {
|
|
7262
7920
|
headers: {
|
|
7263
7921
|
[name: string]: unknown;
|
|
@@ -7428,7 +8086,7 @@ interface operations {
|
|
|
7428
8086
|
};
|
|
7429
8087
|
};
|
|
7430
8088
|
responses: {
|
|
7431
|
-
/** @description
|
|
8089
|
+
/** @description The submitted review */
|
|
7432
8090
|
200: {
|
|
7433
8091
|
headers: {
|
|
7434
8092
|
[name: string]: unknown;
|
|
@@ -7569,7 +8227,7 @@ interface operations {
|
|
|
7569
8227
|
requestBody: {
|
|
7570
8228
|
content: {
|
|
7571
8229
|
"application/json": {
|
|
7572
|
-
/** @description Identifiers of the users to act on
|
|
8230
|
+
/** @description Identifiers of the users to act on: the `id` of a user as returned by `listBuildReviewers` or `getMe`. */
|
|
7573
8231
|
userIds: string[];
|
|
7574
8232
|
};
|
|
7575
8233
|
};
|
|
@@ -7646,7 +8304,7 @@ interface operations {
|
|
|
7646
8304
|
requestBody: {
|
|
7647
8305
|
content: {
|
|
7648
8306
|
"application/json": {
|
|
7649
|
-
/** @description Identifiers of the users to act on
|
|
8307
|
+
/** @description Identifiers of the users to act on: the `id` of a user as returned by `listBuildReviewers` or `getMe`. */
|
|
7650
8308
|
userIds: string[];
|
|
7651
8309
|
};
|
|
7652
8310
|
};
|
|
@@ -8004,7 +8662,7 @@ interface operations {
|
|
|
8004
8662
|
};
|
|
8005
8663
|
requestBody?: never;
|
|
8006
8664
|
responses: {
|
|
8007
|
-
/** @description
|
|
8665
|
+
/** @description The dismissed review */
|
|
8008
8666
|
200: {
|
|
8009
8667
|
headers: {
|
|
8010
8668
|
[name: string]: unknown;
|
|
@@ -8153,7 +8811,7 @@ interface operations {
|
|
|
8153
8811
|
threadId?: string;
|
|
8154
8812
|
/** @description Screenshot diff to anchor the comment to. Required when anchor is set. */
|
|
8155
8813
|
screenshotDiffId?: string;
|
|
8156
|
-
/** @description Where on the referenced screenshot diff the comment points. A point uses normalized (0
|
|
8814
|
+
/** @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
8815
|
anchor?: {
|
|
8158
8816
|
/** @constant */
|
|
8159
8817
|
type: "point";
|
|
@@ -8171,7 +8829,7 @@ interface operations {
|
|
|
8171
8829
|
};
|
|
8172
8830
|
};
|
|
8173
8831
|
responses: {
|
|
8174
|
-
/** @description
|
|
8832
|
+
/** @description The created comment */
|
|
8175
8833
|
201: {
|
|
8176
8834
|
headers: {
|
|
8177
8835
|
[name: string]: unknown;
|
|
@@ -8315,7 +8973,7 @@ interface operations {
|
|
|
8315
8973
|
};
|
|
8316
8974
|
requestBody?: never;
|
|
8317
8975
|
responses: {
|
|
8318
|
-
/** @description
|
|
8976
|
+
/** @description The deleted comment */
|
|
8319
8977
|
200: {
|
|
8320
8978
|
headers: {
|
|
8321
8979
|
[name: string]: unknown;
|
|
@@ -8396,7 +9054,7 @@ interface operations {
|
|
|
8396
9054
|
};
|
|
8397
9055
|
};
|
|
8398
9056
|
responses: {
|
|
8399
|
-
/** @description
|
|
9057
|
+
/** @description The updated comment */
|
|
8400
9058
|
200: {
|
|
8401
9059
|
headers: {
|
|
8402
9060
|
[name: string]: unknown;
|
|
@@ -8475,7 +9133,7 @@ interface operations {
|
|
|
8475
9133
|
};
|
|
8476
9134
|
};
|
|
8477
9135
|
responses: {
|
|
8478
|
-
/** @description
|
|
9136
|
+
/** @description The comment, with the reaction added */
|
|
8479
9137
|
200: {
|
|
8480
9138
|
headers: {
|
|
8481
9139
|
[name: string]: unknown;
|
|
@@ -8550,7 +9208,7 @@ interface operations {
|
|
|
8550
9208
|
};
|
|
8551
9209
|
requestBody?: never;
|
|
8552
9210
|
responses: {
|
|
8553
|
-
/** @description
|
|
9211
|
+
/** @description The comment, with the reaction removed */
|
|
8554
9212
|
200: {
|
|
8555
9213
|
headers: {
|
|
8556
9214
|
[name: string]: unknown;
|
|
@@ -8622,7 +9280,7 @@ interface operations {
|
|
|
8622
9280
|
};
|
|
8623
9281
|
requestBody?: never;
|
|
8624
9282
|
responses: {
|
|
8625
|
-
/** @description
|
|
9283
|
+
/** @description The root comment of the resolved thread */
|
|
8626
9284
|
200: {
|
|
8627
9285
|
headers: {
|
|
8628
9286
|
[name: string]: unknown;
|
|
@@ -8694,7 +9352,7 @@ interface operations {
|
|
|
8694
9352
|
};
|
|
8695
9353
|
requestBody?: never;
|
|
8696
9354
|
responses: {
|
|
8697
|
-
/** @description
|
|
9355
|
+
/** @description The root comment of the reopened thread */
|
|
8698
9356
|
200: {
|
|
8699
9357
|
headers: {
|
|
8700
9358
|
[name: string]: unknown;
|
|
@@ -8766,7 +9424,7 @@ interface operations {
|
|
|
8766
9424
|
};
|
|
8767
9425
|
requestBody?: never;
|
|
8768
9426
|
responses: {
|
|
8769
|
-
/** @description
|
|
9427
|
+
/** @description The root comment of the subscribed thread */
|
|
8770
9428
|
200: {
|
|
8771
9429
|
headers: {
|
|
8772
9430
|
[name: string]: unknown;
|
|
@@ -8838,7 +9496,7 @@ interface operations {
|
|
|
8838
9496
|
};
|
|
8839
9497
|
requestBody?: never;
|
|
8840
9498
|
responses: {
|
|
8841
|
-
/** @description
|
|
9499
|
+
/** @description The root comment of the unsubscribed thread */
|
|
8842
9500
|
200: {
|
|
8843
9501
|
headers: {
|
|
8844
9502
|
[name: string]: unknown;
|
|
@@ -8947,6 +9605,15 @@ interface operations {
|
|
|
8947
9605
|
"application/json": components["schemas"]["Error"];
|
|
8948
9606
|
};
|
|
8949
9607
|
};
|
|
9608
|
+
/** @description Forbidden */
|
|
9609
|
+
403: {
|
|
9610
|
+
headers: {
|
|
9611
|
+
[name: string]: unknown;
|
|
9612
|
+
};
|
|
9613
|
+
content: {
|
|
9614
|
+
"application/json": components["schemas"]["Error"];
|
|
9615
|
+
};
|
|
9616
|
+
};
|
|
8950
9617
|
/** @description Not found */
|
|
8951
9618
|
404: {
|
|
8952
9619
|
headers: {
|
|
@@ -9027,6 +9694,15 @@ interface operations {
|
|
|
9027
9694
|
"application/json": components["schemas"]["Error"];
|
|
9028
9695
|
};
|
|
9029
9696
|
};
|
|
9697
|
+
/** @description Forbidden */
|
|
9698
|
+
403: {
|
|
9699
|
+
headers: {
|
|
9700
|
+
[name: string]: unknown;
|
|
9701
|
+
};
|
|
9702
|
+
content: {
|
|
9703
|
+
"application/json": components["schemas"]["Error"];
|
|
9704
|
+
};
|
|
9705
|
+
};
|
|
9030
9706
|
/** @description Not found */
|
|
9031
9707
|
404: {
|
|
9032
9708
|
headers: {
|
|
@@ -9086,6 +9762,15 @@ interface operations {
|
|
|
9086
9762
|
"application/json": components["schemas"]["Error"];
|
|
9087
9763
|
};
|
|
9088
9764
|
};
|
|
9765
|
+
/** @description Forbidden */
|
|
9766
|
+
403: {
|
|
9767
|
+
headers: {
|
|
9768
|
+
[name: string]: unknown;
|
|
9769
|
+
};
|
|
9770
|
+
content: {
|
|
9771
|
+
"application/json": components["schemas"]["Error"];
|
|
9772
|
+
};
|
|
9773
|
+
};
|
|
9089
9774
|
/** @description Not found */
|
|
9090
9775
|
404: {
|
|
9091
9776
|
headers: {
|
|
@@ -9120,7 +9805,7 @@ interface operations {
|
|
|
9120
9805
|
content: {
|
|
9121
9806
|
"application/json": {
|
|
9122
9807
|
/**
|
|
9123
|
-
* @description The full domain to serve production deployments on, under the Argos deployments domain
|
|
9808
|
+
* @description The full domain to serve production deployments on, under the Argos deployments domain (e.g. `acme-web.argos-ci.live`).
|
|
9124
9809
|
* @example acme-web.argos-ci.live
|
|
9125
9810
|
*/
|
|
9126
9811
|
domain: string;
|
|
@@ -9231,6 +9916,15 @@ interface operations {
|
|
|
9231
9916
|
"application/json": components["schemas"]["Error"];
|
|
9232
9917
|
};
|
|
9233
9918
|
};
|
|
9919
|
+
/** @description Forbidden */
|
|
9920
|
+
403: {
|
|
9921
|
+
headers: {
|
|
9922
|
+
[name: string]: unknown;
|
|
9923
|
+
};
|
|
9924
|
+
content: {
|
|
9925
|
+
"application/json": components["schemas"]["Error"];
|
|
9926
|
+
};
|
|
9927
|
+
};
|
|
9234
9928
|
/** @description Not found */
|
|
9235
9929
|
404: {
|
|
9236
9930
|
headers: {
|
|
@@ -9295,6 +9989,15 @@ interface operations {
|
|
|
9295
9989
|
"application/json": components["schemas"]["Error"];
|
|
9296
9990
|
};
|
|
9297
9991
|
};
|
|
9992
|
+
/** @description Forbidden */
|
|
9993
|
+
403: {
|
|
9994
|
+
headers: {
|
|
9995
|
+
[name: string]: unknown;
|
|
9996
|
+
};
|
|
9997
|
+
content: {
|
|
9998
|
+
"application/json": components["schemas"]["Error"];
|
|
9999
|
+
};
|
|
10000
|
+
};
|
|
9298
10001
|
/** @description Not found */
|
|
9299
10002
|
404: {
|
|
9300
10003
|
headers: {
|
|
@@ -9368,6 +10071,15 @@ interface operations {
|
|
|
9368
10071
|
"application/json": components["schemas"]["Error"];
|
|
9369
10072
|
};
|
|
9370
10073
|
};
|
|
10074
|
+
/** @description Forbidden */
|
|
10075
|
+
403: {
|
|
10076
|
+
headers: {
|
|
10077
|
+
[name: string]: unknown;
|
|
10078
|
+
};
|
|
10079
|
+
content: {
|
|
10080
|
+
"application/json": components["schemas"]["Error"];
|
|
10081
|
+
};
|
|
10082
|
+
};
|
|
9371
10083
|
/** @description Not found */
|
|
9372
10084
|
404: {
|
|
9373
10085
|
headers: {
|
|
@@ -9483,7 +10195,7 @@ interface operations {
|
|
|
9483
10195
|
};
|
|
9484
10196
|
};
|
|
9485
10197
|
responses: {
|
|
9486
|
-
/** @description
|
|
10198
|
+
/** @description The created comment */
|
|
9487
10199
|
201: {
|
|
9488
10200
|
headers: {
|
|
9489
10201
|
[name: string]: unknown;
|
|
@@ -9627,7 +10339,7 @@ interface operations {
|
|
|
9627
10339
|
};
|
|
9628
10340
|
requestBody?: never;
|
|
9629
10341
|
responses: {
|
|
9630
|
-
/** @description
|
|
10342
|
+
/** @description The deleted comment */
|
|
9631
10343
|
200: {
|
|
9632
10344
|
headers: {
|
|
9633
10345
|
[name: string]: unknown;
|
|
@@ -9708,7 +10420,7 @@ interface operations {
|
|
|
9708
10420
|
};
|
|
9709
10421
|
};
|
|
9710
10422
|
responses: {
|
|
9711
|
-
/** @description
|
|
10423
|
+
/** @description The updated comment */
|
|
9712
10424
|
200: {
|
|
9713
10425
|
headers: {
|
|
9714
10426
|
[name: string]: unknown;
|
|
@@ -9787,7 +10499,7 @@ interface operations {
|
|
|
9787
10499
|
};
|
|
9788
10500
|
};
|
|
9789
10501
|
responses: {
|
|
9790
|
-
/** @description
|
|
10502
|
+
/** @description The comment, with the reaction added */
|
|
9791
10503
|
200: {
|
|
9792
10504
|
headers: {
|
|
9793
10505
|
[name: string]: unknown;
|
|
@@ -9862,7 +10574,7 @@ interface operations {
|
|
|
9862
10574
|
};
|
|
9863
10575
|
requestBody?: never;
|
|
9864
10576
|
responses: {
|
|
9865
|
-
/** @description
|
|
10577
|
+
/** @description The comment, with the reaction removed */
|
|
9866
10578
|
200: {
|
|
9867
10579
|
headers: {
|
|
9868
10580
|
[name: string]: unknown;
|
|
@@ -9934,7 +10646,7 @@ interface operations {
|
|
|
9934
10646
|
};
|
|
9935
10647
|
requestBody?: never;
|
|
9936
10648
|
responses: {
|
|
9937
|
-
/** @description
|
|
10649
|
+
/** @description The root comment of the resolved thread */
|
|
9938
10650
|
200: {
|
|
9939
10651
|
headers: {
|
|
9940
10652
|
[name: string]: unknown;
|
|
@@ -10006,7 +10718,7 @@ interface operations {
|
|
|
10006
10718
|
};
|
|
10007
10719
|
requestBody?: never;
|
|
10008
10720
|
responses: {
|
|
10009
|
-
/** @description
|
|
10721
|
+
/** @description The root comment of the reopened thread */
|
|
10010
10722
|
200: {
|
|
10011
10723
|
headers: {
|
|
10012
10724
|
[name: string]: unknown;
|
|
@@ -10078,7 +10790,7 @@ interface operations {
|
|
|
10078
10790
|
};
|
|
10079
10791
|
requestBody?: never;
|
|
10080
10792
|
responses: {
|
|
10081
|
-
/** @description
|
|
10793
|
+
/** @description The root comment of the subscribed thread */
|
|
10082
10794
|
200: {
|
|
10083
10795
|
headers: {
|
|
10084
10796
|
[name: string]: unknown;
|
|
@@ -10150,7 +10862,7 @@ interface operations {
|
|
|
10150
10862
|
};
|
|
10151
10863
|
requestBody?: never;
|
|
10152
10864
|
responses: {
|
|
10153
|
-
/** @description
|
|
10865
|
+
/** @description The root comment of the unsubscribed thread */
|
|
10154
10866
|
200: {
|
|
10155
10867
|
headers: {
|
|
10156
10868
|
[name: string]: unknown;
|
|
@@ -10207,8 +10919,6 @@ interface operations {
|
|
|
10207
10919
|
};
|
|
10208
10920
|
};
|
|
10209
10921
|
}
|
|
10210
|
-
//#endregion
|
|
10211
|
-
//#region src/fetch.d.ts
|
|
10212
10922
|
export declare class APIError extends Error {
|
|
10213
10923
|
/**
|
|
10214
10924
|
* HTTP status code of the response that triggered the error, when available.
|
|
@@ -10225,8 +10935,6 @@ export declare class APIError extends Error {
|
|
|
10225
10935
|
cause?: unknown;
|
|
10226
10936
|
});
|
|
10227
10937
|
}
|
|
10228
|
-
//#endregion
|
|
10229
|
-
//#region src/index.d.ts
|
|
10230
10938
|
export type ArgosAPIClient = ReturnType<typeof createClient>;
|
|
10231
10939
|
/**
|
|
10232
10940
|
* A `User-Agent` value, or a resolver for it. The resolver may be async and is
|
|
@@ -10258,5 +10966,4 @@ export declare function formatAPIError(error: unknown, response?: Response): str
|
|
|
10258
10966
|
* Handle API errors.
|
|
10259
10967
|
*/
|
|
10260
10968
|
export declare function throwAPIError(error: unknown, response?: Response): never;
|
|
10261
|
-
//#endregion
|
|
10262
10969
|
export { schema_d_exports as ArgosAPISchema };
|