@argos-ci/api-client 0.11.1 → 0.12.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +26 -2
  2. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -104,6 +104,11 @@ interface components {
104
104
  name: string;
105
105
  baseName?: string | null;
106
106
  metadata?: {
107
+ /**
108
+ * @description Ignored. Can be set to get completions, validations and documentation in some editors.
109
+ * @example https://api.argos-ci.com/v2/screenshot-metadata.json
110
+ */
111
+ $schema?: string;
107
112
  /** @description The URL of the page that was screenshotted */
108
113
  url?: string | null;
109
114
  /** @description An URL to an accessible preview of the screenshot */
@@ -259,23 +264,42 @@ interface operations {
259
264
  requestBody?: {
260
265
  content: {
261
266
  "application/json": {
267
+ /** @description The commit the build is running on */
262
268
  commit: components["schemas"]["Sha1Hash"];
269
+ /** @description The branch the build is running on */
263
270
  branch: string;
271
+ /** @description Keys of screenshot files */
264
272
  screenshotKeys: components["schemas"]["Sha256Hash"][];
273
+ /** @description Keys of Playwright trace files */
265
274
  pwTraceKeys?: components["schemas"]["Sha256Hash"][];
275
+ /** @description The name of the build (for multi-build setups) */
266
276
  name?: string | null;
277
+ /** @description Whether to run the build in parallel */
267
278
  parallel?: boolean | null;
279
+ /** @description A unique nonce for the parallel build */
268
280
  parallelNonce?: string | null;
281
+ /** @description The pull request number */
269
282
  prNumber?: number | null;
270
- prHeadCommit?: string | null;
271
- referenceCommit?: string | null;
283
+ /** @description The head commit of the pull request */
284
+ prHeadCommit?: components["schemas"]["Sha1Hash"] | null;
285
+ /** @description The commit to use as a reference for the build */
286
+ referenceCommit?: components["schemas"]["Sha1Hash"] | null;
287
+ /** @description The branch to use as a reference for the build */
272
288
  referenceBranch?: string | null;
289
+ /** @description The parent commits of the build */
273
290
  parentCommits?: components["schemas"]["Sha1Hash"][] | null;
291
+ /** @description The mode in which the build is running */
274
292
  mode?: ("ci" | "monitoring") | null;
293
+ /** @description The CI provider being used */
275
294
  ciProvider?: string | null;
295
+ /** @description The version of the Argos SDK being used */
276
296
  argosSdk?: string | null;
297
+ /** @description The ID of the current run */
277
298
  runId?: string | null;
299
+ /** @description The attempt number of the current run */
278
300
  runAttempt?: number | null;
301
+ /** @description Whether the build was skipped, not comparing anything and always succeeding */
302
+ skipped?: boolean | null;
279
303
  };
280
304
  };
281
305
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@argos-ci/api-client",
3
3
  "description": "Argos API Client library.",
4
- "version": "0.11.1",
4
+ "version": "0.12.0",
5
5
  "author": "Smooth Code",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -50,7 +50,7 @@
50
50
  },
51
51
  "dependencies": {
52
52
  "debug": "^4.4.3",
53
- "openapi-fetch": "^0.14.0"
53
+ "openapi-fetch": "^0.14.1"
54
54
  },
55
- "gitHead": "00f28041a847158e437aaab5fc9e816f6b609021"
55
+ "gitHead": "867a93c5ffc01d55c7385d3ac3903c4c3ab270b6"
56
56
  }