@argos-ci/api-client 0.1.1-alpha.35 → 0.2.1-alpha.5

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +367 -8
  2. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -3,6 +3,54 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
  interface paths {
6
+ "/builds": {
7
+ parameters: {
8
+ query?: never;
9
+ header?: never;
10
+ path?: never;
11
+ cookie?: never;
12
+ };
13
+ get?: never;
14
+ put?: never;
15
+ post: operations["createBuild"];
16
+ delete?: never;
17
+ options?: never;
18
+ head?: never;
19
+ patch?: never;
20
+ trace?: never;
21
+ };
22
+ "/builds/finalize": {
23
+ parameters: {
24
+ query?: never;
25
+ header?: never;
26
+ path?: never;
27
+ cookie?: never;
28
+ };
29
+ get?: never;
30
+ put?: never;
31
+ post: operations["finalizeBuilds"];
32
+ delete?: never;
33
+ options?: never;
34
+ head?: never;
35
+ patch?: never;
36
+ trace?: never;
37
+ };
38
+ "/builds/{buildId}": {
39
+ parameters: {
40
+ query?: never;
41
+ header?: never;
42
+ path?: never;
43
+ cookie?: never;
44
+ };
45
+ get?: never;
46
+ put: operations["updateBuild"];
47
+ post?: never;
48
+ delete?: never;
49
+ options?: never;
50
+ head?: never;
51
+ patch?: never;
52
+ trace?: never;
53
+ };
6
54
  "/project": {
7
55
  parameters: {
8
56
  query?: never;
@@ -38,15 +86,12 @@ interface paths {
38
86
  }
39
87
  interface components {
40
88
  schemas: {
41
- /** @description Error response */
42
- Error: {
43
- error: string;
44
- details: {
45
- message: string;
46
- }[];
47
- };
48
89
  /** @description Build */
49
90
  Build: {
91
+ /**
92
+ * @description A unique identifier for the build
93
+ * @example 12345
94
+ */
50
95
  id: string;
51
96
  number: number;
52
97
  status: ("accepted" | "rejected") | ("stable" | "diffDetected") | ("expired" | "pending" | "progress" | "error" | "aborted");
@@ -65,6 +110,18 @@ interface components {
65
110
  };
66
111
  } | null;
67
112
  };
113
+ /** @description Error response */
114
+ Error: {
115
+ error: string;
116
+ details: {
117
+ message: string;
118
+ }[];
119
+ };
120
+ /**
121
+ * @description A unique identifier for the build
122
+ * @example 12345
123
+ */
124
+ buildId: string;
68
125
  };
69
126
  responses: never;
70
127
  parameters: never;
@@ -73,6 +130,308 @@ interface components {
73
130
  pathItems: never;
74
131
  }
75
132
  interface operations {
133
+ createBuild: {
134
+ parameters: {
135
+ query?: never;
136
+ header?: never;
137
+ path?: never;
138
+ cookie?: never;
139
+ };
140
+ requestBody?: {
141
+ content: {
142
+ "application/json": {
143
+ commit: string;
144
+ branch: string;
145
+ screenshotKeys: string[];
146
+ pwTraceKeys?: string[];
147
+ name?: string | null;
148
+ parallel?: boolean | null;
149
+ parallelNonce?: string | null;
150
+ prNumber?: number | null;
151
+ prHeadCommit?: string | null;
152
+ referenceCommit?: string | null;
153
+ referenceBranch?: string | null;
154
+ /** @enum {string|null} */
155
+ mode?: "ci" | "monitoring" | null;
156
+ ciProvider?: string | null;
157
+ argosSdk?: string | null;
158
+ runId?: string | null;
159
+ runAttempt?: number | null;
160
+ };
161
+ };
162
+ };
163
+ responses: {
164
+ /** @description Result of build creation */
165
+ 201: {
166
+ headers: {
167
+ [name: string]: unknown;
168
+ };
169
+ content: {
170
+ "application/json": {
171
+ build: components["schemas"]["Build"];
172
+ screenshots: {
173
+ key: string;
174
+ /** Format: uri */
175
+ putUrl: string;
176
+ }[];
177
+ pwTraces: {
178
+ key: string;
179
+ /** Format: uri */
180
+ putUrl: string;
181
+ }[];
182
+ };
183
+ };
184
+ };
185
+ /** @description Invalid parameters */
186
+ 400: {
187
+ headers: {
188
+ [name: string]: unknown;
189
+ };
190
+ content: {
191
+ "application/json": components["schemas"]["Error"];
192
+ };
193
+ };
194
+ /** @description Unauthorized */
195
+ 401: {
196
+ headers: {
197
+ [name: string]: unknown;
198
+ };
199
+ content: {
200
+ "application/json": components["schemas"]["Error"];
201
+ };
202
+ };
203
+ /** @description Conflict */
204
+ 409: {
205
+ headers: {
206
+ [name: string]: unknown;
207
+ };
208
+ content: {
209
+ "application/json": components["schemas"]["Error"];
210
+ };
211
+ };
212
+ /** @description Server error */
213
+ 500: {
214
+ headers: {
215
+ [name: string]: unknown;
216
+ };
217
+ content: {
218
+ "application/json": components["schemas"]["Error"];
219
+ };
220
+ };
221
+ };
222
+ };
223
+ finalizeBuilds: {
224
+ parameters: {
225
+ query?: never;
226
+ header?: never;
227
+ path?: never;
228
+ cookie?: never;
229
+ };
230
+ requestBody?: {
231
+ content: {
232
+ "application/json": {
233
+ parallelNonce: string;
234
+ };
235
+ };
236
+ };
237
+ responses: {
238
+ /** @description Result of build finalization */
239
+ 200: {
240
+ headers: {
241
+ [name: string]: unknown;
242
+ };
243
+ content: {
244
+ "application/json": {
245
+ builds: components["schemas"]["Build"][];
246
+ };
247
+ };
248
+ };
249
+ /** @description Invalid parameters */
250
+ 400: {
251
+ headers: {
252
+ [name: string]: unknown;
253
+ };
254
+ content: {
255
+ "application/json": components["schemas"]["Error"];
256
+ };
257
+ };
258
+ /** @description Unauthorized */
259
+ 401: {
260
+ headers: {
261
+ [name: string]: unknown;
262
+ };
263
+ content: {
264
+ "application/json": components["schemas"]["Error"];
265
+ };
266
+ };
267
+ /** @description Forbidden */
268
+ 403: {
269
+ headers: {
270
+ [name: string]: unknown;
271
+ };
272
+ content: {
273
+ "application/json": components["schemas"]["Error"];
274
+ };
275
+ };
276
+ /** @description Not found */
277
+ 404: {
278
+ headers: {
279
+ [name: string]: unknown;
280
+ };
281
+ content: {
282
+ "application/json": components["schemas"]["Error"];
283
+ };
284
+ };
285
+ /** @description Conflict */
286
+ 409: {
287
+ headers: {
288
+ [name: string]: unknown;
289
+ };
290
+ content: {
291
+ "application/json": components["schemas"]["Error"];
292
+ };
293
+ };
294
+ /** @description Server error */
295
+ 500: {
296
+ headers: {
297
+ [name: string]: unknown;
298
+ };
299
+ content: {
300
+ "application/json": components["schemas"]["Error"];
301
+ };
302
+ };
303
+ };
304
+ };
305
+ updateBuild: {
306
+ parameters: {
307
+ query?: never;
308
+ header?: never;
309
+ path: {
310
+ /** @description A unique identifier for the build */
311
+ buildId: components["schemas"]["buildId"];
312
+ };
313
+ cookie?: never;
314
+ };
315
+ requestBody?: {
316
+ content: {
317
+ "application/json": {
318
+ screenshots: {
319
+ key: string;
320
+ name: string;
321
+ baseName?: string | null;
322
+ metadata?: {
323
+ url?: string;
324
+ viewport?: {
325
+ width: number;
326
+ height: number;
327
+ };
328
+ /** @enum {string} */
329
+ colorScheme?: "light" | "dark";
330
+ /** @enum {string} */
331
+ mediaType?: "screen" | "print";
332
+ test?: {
333
+ id?: string;
334
+ title: string;
335
+ titlePath: string[];
336
+ retries?: number;
337
+ retry?: number;
338
+ repeat?: number;
339
+ location?: {
340
+ file: string;
341
+ line: number;
342
+ column: number;
343
+ };
344
+ } | null;
345
+ browser?: {
346
+ name: string;
347
+ version: string;
348
+ };
349
+ automationLibrary: {
350
+ name: string;
351
+ version: string;
352
+ };
353
+ sdk: {
354
+ name: string;
355
+ version: string;
356
+ };
357
+ } | null;
358
+ pwTraceKey?: string | null;
359
+ threshold?: number | null;
360
+ }[];
361
+ parallel?: boolean | null;
362
+ parallelTotal?: number | null;
363
+ parallelIndex?: number | null;
364
+ };
365
+ };
366
+ };
367
+ responses: {
368
+ /** @description Result of build update */
369
+ 200: {
370
+ headers: {
371
+ [name: string]: unknown;
372
+ };
373
+ content: {
374
+ "application/json": {
375
+ build: components["schemas"]["Build"];
376
+ };
377
+ };
378
+ };
379
+ /** @description Invalid parameters */
380
+ 400: {
381
+ headers: {
382
+ [name: string]: unknown;
383
+ };
384
+ content: {
385
+ "application/json": components["schemas"]["Error"];
386
+ };
387
+ };
388
+ /** @description Unauthorized */
389
+ 401: {
390
+ headers: {
391
+ [name: string]: unknown;
392
+ };
393
+ content: {
394
+ "application/json": components["schemas"]["Error"];
395
+ };
396
+ };
397
+ /** @description Forbidden */
398
+ 403: {
399
+ headers: {
400
+ [name: string]: unknown;
401
+ };
402
+ content: {
403
+ "application/json": components["schemas"]["Error"];
404
+ };
405
+ };
406
+ /** @description Not found */
407
+ 404: {
408
+ headers: {
409
+ [name: string]: unknown;
410
+ };
411
+ content: {
412
+ "application/json": components["schemas"]["Error"];
413
+ };
414
+ };
415
+ /** @description Conflict */
416
+ 409: {
417
+ headers: {
418
+ [name: string]: unknown;
419
+ };
420
+ content: {
421
+ "application/json": components["schemas"]["Error"];
422
+ };
423
+ };
424
+ /** @description Server error */
425
+ 500: {
426
+ headers: {
427
+ [name: string]: unknown;
428
+ };
429
+ content: {
430
+ "application/json": components["schemas"]["Error"];
431
+ };
432
+ };
433
+ };
434
+ };
76
435
  getAuthProject: {
77
436
  parameters: {
78
437
  query?: never;
@@ -140,12 +499,12 @@ interface operations {
140
499
  };
141
500
  content: {
142
501
  "application/json": {
143
- results: components["schemas"]["Build"][];
144
502
  pageInfo: {
145
503
  total: number;
146
504
  page: number;
147
505
  perPage: number;
148
506
  };
507
+ results: components["schemas"]["Build"][];
149
508
  };
150
509
  };
151
510
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/api-client",
3
3
  "description": "Argos API client.",
4
- "version": "0.1.1-alpha.35+3eb419d",
4
+ "version": "0.2.1-alpha.5+fe38977",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -48,5 +48,5 @@
48
48
  "dependencies": {
49
49
  "openapi-fetch": "^0.11.1"
50
50
  },
51
- "gitHead": "3eb419d3b661bf705619e1ec869cc73e05165b53"
51
+ "gitHead": "fe389774403ee2b9857c38c02531ed0e79d6a4fd"
52
52
  }