@epilot/blueprint-manifest-client 3.0.0-beta.1 → 3.0.0-beta.3

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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={914:function(e,t,n){var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=r(n(240));t.default=s.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/installations":{"post":{"operationId":"createInstallationJob","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}":{"get":{"operationId":"getInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/installations/{job_id}:cancel":{"operationId":"cancelInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{"200":{"description":"Installation job cancelled","content":{"application/json":{}}}}},"/v2/blueprint-manifest/installations/{job_id}/events":{"get":{"operationId":"getInstallationJobEvents","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},t={},n=function n(r){var s=t[r];if(void 0!==s)return s.exports;var i=t[r]={exports:{}};return e[r].call(i.exports,i,i.exports,n),i.exports}(914),r=exports;for(var s in n)r[s]=n[s];n.__esModule&&Object.defineProperty(r,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprint:install":{"post":{"operationId":"installBlueprint","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs":{"get":{"operationId":"listBlueprintJobs","responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:cancel":{"post":{"operationId":"cancelBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')},757:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(466));t.default=s.default}},t={},r=function r(n){var s=t[n];if(void 0!==s)return s.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,r),i.exports}(757),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
@@ -147,6 +147,18 @@
147
147
  "responses": {}
148
148
  }
149
149
  },
150
+ "/v2/blueprint-manifest/blueprint:install": {
151
+ "post": {
152
+ "operationId": "installBlueprint",
153
+ "requestBody": {
154
+ "required": true,
155
+ "content": {
156
+ "application/json": {}
157
+ }
158
+ },
159
+ "responses": {}
160
+ }
161
+ },
150
162
  "/v2/blueprint-manifest/blueprints/{blueprint_id}": {
151
163
  "get": {
152
164
  "operationId": "getBlueprint",
@@ -328,21 +340,15 @@
328
340
  "responses": {}
329
341
  }
330
342
  },
331
- "/v2/blueprint-manifest/installations": {
332
- "post": {
333
- "operationId": "createInstallationJob",
334
- "requestBody": {
335
- "required": true,
336
- "content": {
337
- "application/json": {}
338
- }
339
- },
343
+ "/v2/blueprint-manifest/jobs": {
344
+ "get": {
345
+ "operationId": "listBlueprintJobs",
340
346
  "responses": {}
341
347
  }
342
348
  },
343
- "/v2/blueprint-manifest/installations/{job_id}": {
349
+ "/v2/blueprint-manifest/jobs/{job_id}": {
344
350
  "get": {
345
- "operationId": "getInstallationJob",
351
+ "operationId": "getBlueprintJob",
346
352
  "parameters": [
347
353
  {
348
354
  "in": "path",
@@ -353,7 +359,7 @@
353
359
  "responses": {}
354
360
  }
355
361
  },
356
- "/v2/blueprint-manifest/installations/{job_id}:continue": {
362
+ "/v2/blueprint-manifest/jobs/{job_id}:continue": {
357
363
  "post": {
358
364
  "operationId": "continueInstallationJob",
359
365
  "parameters": [
@@ -366,27 +372,9 @@
366
372
  "responses": {}
367
373
  }
368
374
  },
369
- "/v2/blueprint-manifest/installations/{job_id}:cancel": {
370
- "operationId": "cancelInstallationJob",
371
- "parameters": [
372
- {
373
- "in": "path",
374
- "required": true,
375
- "name": "job_id"
376
- }
377
- ],
378
- "responses": {
379
- "200": {
380
- "description": "Installation job cancelled",
381
- "content": {
382
- "application/json": {}
383
- }
384
- }
385
- }
386
- },
387
- "/v2/blueprint-manifest/installations/{job_id}/events": {
388
- "get": {
389
- "operationId": "getInstallationJobEvents",
375
+ "/v2/blueprint-manifest/jobs/{job_id}:cancel": {
376
+ "post": {
377
+ "operationId": "cancelBlueprintJob",
390
378
  "parameters": [
391
379
  {
392
380
  "in": "path",
package/dist/openapi.d.ts CHANGED
@@ -47,6 +47,7 @@ declare namespace Components {
47
47
  postinstall?: string;
48
48
  };
49
49
  version?: string;
50
+ latest_download_file?: S3Reference;
50
51
  created_at?: string; // date-time
51
52
  updated_at?: string; // date-time
52
53
  created_by?: CallerIdentity;
@@ -59,6 +60,25 @@ declare namespace Components {
59
60
  resources?: InstalledBlueprintResource[];
60
61
  }
61
62
  export type Blueprint = CustomBlueprint | FileBlueprint | MarketplaceBlueprint | DeployedBlueprint | AppBlueprint;
63
+ export interface BlueprintExportJob {
64
+ id?: /**
65
+ * ID of a job
66
+ * example:
67
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
68
+ */
69
+ BlueprintJobID;
70
+ events?: BlueprintJobEvent[];
71
+ triggered_at?: string; // date-time
72
+ created_by?: CallerIdentity;
73
+ blueprint_id?: /**
74
+ * ID of a blueprint
75
+ * example:
76
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
77
+ */
78
+ BlueprintID;
79
+ status?: "IN_PROGRESS" | "SUCCESS" | "FAILED" | "CANCELED";
80
+ download_file?: S3Reference;
81
+ }
62
82
  /**
63
83
  * ID of a blueprint
64
84
  * example:
@@ -66,6 +86,50 @@ declare namespace Components {
66
86
  */
67
87
  export type BlueprintID = string;
68
88
  export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
89
+ export interface BlueprintInstallationJob {
90
+ id?: /**
91
+ * ID of a job
92
+ * example:
93
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
94
+ */
95
+ BlueprintJobID;
96
+ events?: BlueprintJobEvent[];
97
+ triggered_at?: string; // date-time
98
+ created_by?: CallerIdentity;
99
+ source_blueprint_id?: /**
100
+ * ID of a blueprint
101
+ * example:
102
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
103
+ */
104
+ BlueprintID;
105
+ source_blueprint_type?: "custom" | "file" | "marketplace" | "deploy" | "app";
106
+ source_org_id?: string;
107
+ source_blueprint_file?: string;
108
+ destination_blueprint_id?: /**
109
+ * ID of a blueprint
110
+ * example:
111
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
112
+ */
113
+ BlueprintID;
114
+ destination_org_id?: string;
115
+ status?: "IN_PROGRESS" | "WAITING_USER_ACTION" | "CANCELED" | "SUCCESS" | "FAILED";
116
+ }
117
+ export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob;
118
+ export interface BlueprintJobEvent {
119
+ timestamp?: string; // date-time
120
+ message?: string;
121
+ errors?: FormattedError[];
122
+ level?: "info" | "warning" | "error";
123
+ data?: {
124
+ [name: string]: any;
125
+ };
126
+ }
127
+ /**
128
+ * ID of a job
129
+ * example:
130
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
131
+ */
132
+ export type BlueprintJobID = string;
69
133
  export interface BlueprintResource {
70
134
  id: /**
71
135
  * ID of a blueprint resource
@@ -143,11 +207,23 @@ declare namespace Components {
143
207
  postinstall?: string;
144
208
  };
145
209
  version?: string;
210
+ latest_download_file?: S3Reference;
146
211
  created_at?: string; // date-time
147
212
  updated_at?: string; // date-time
148
213
  created_by?: CallerIdentity;
149
214
  updated_by?: CallerIdentity;
150
215
  }
216
+ export interface CommonBlueprintJobFields {
217
+ id?: /**
218
+ * ID of a job
219
+ * example:
220
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
221
+ */
222
+ BlueprintJobID;
223
+ events?: BlueprintJobEvent[];
224
+ triggered_at?: string; // date-time
225
+ created_by?: CallerIdentity;
226
+ }
151
227
  export interface CommonImportFields {
152
228
  source_type?: ManifestSource;
153
229
  /**
@@ -339,6 +415,7 @@ declare namespace Components {
339
415
  postinstall?: string;
340
416
  };
341
417
  version?: string;
418
+ latest_download_file?: S3Reference;
342
419
  created_at?: string; // date-time
343
420
  updated_at?: string; // date-time
344
421
  created_by?: CallerIdentity;
@@ -372,6 +449,7 @@ declare namespace Components {
372
449
  postinstall?: string;
373
450
  };
374
451
  version?: string;
452
+ latest_download_file?: S3Reference;
375
453
  created_at?: string; // date-time
376
454
  updated_at?: string; // date-time
377
455
  created_by?: CallerIdentity;
@@ -428,6 +506,7 @@ declare namespace Components {
428
506
  postinstall?: string;
429
507
  };
430
508
  version?: string;
509
+ latest_download_file?: S3Reference;
431
510
  created_at?: string; // date-time
432
511
  updated_at?: string; // date-time
433
512
  created_by?: CallerIdentity;
@@ -454,47 +533,6 @@ declare namespace Components {
454
533
  type?: string;
455
534
  };
456
535
  }
457
- export interface InstallationJob {
458
- id?: /**
459
- * ID of an installation job
460
- * example:
461
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
462
- */
463
- InstallationJobID;
464
- source_blueprint_id?: /**
465
- * ID of a blueprint
466
- * example:
467
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
468
- */
469
- BlueprintID;
470
- source_blueprint_type?: "file" | "marketplace" | "deploy" | "app";
471
- source_org_id?: string;
472
- destination_blueprint_id?: /**
473
- * ID of a blueprint
474
- * example:
475
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
476
- */
477
- BlueprintID;
478
- destination_org_id?: string;
479
- status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
480
- triggered_at?: string; // date-time
481
- created_by?: CallerIdentity;
482
- updated_by?: CallerIdentity;
483
- }
484
- export interface InstallationJobEvent {
485
- timestamp?: string; // date-time
486
- message?: string;
487
- level?: "info" | "warning" | "error";
488
- data?: {
489
- [name: string]: any;
490
- };
491
- }
492
- /**
493
- * ID of an installation job
494
- * example:
495
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
496
- */
497
- export type InstallationJobID = string;
498
536
  export interface InstalledBlueprintResource {
499
537
  id: /**
500
538
  * ID of a blueprint resource
@@ -1017,6 +1055,7 @@ declare namespace Components {
1017
1055
  postinstall?: string;
1018
1056
  };
1019
1057
  version?: string;
1058
+ latest_download_file?: S3Reference;
1020
1059
  created_at?: string; // date-time
1021
1060
  updated_at?: string; // date-time
1022
1061
  created_by?: CallerIdentity;
@@ -1322,20 +1361,36 @@ declare namespace Paths {
1322
1361
  }
1323
1362
  }
1324
1363
  }
1364
+ namespace CancelBlueprintJob {
1365
+ namespace Parameters {
1366
+ export type JobId = /**
1367
+ * ID of a job
1368
+ * example:
1369
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1370
+ */
1371
+ Components.Schemas.BlueprintJobID;
1372
+ }
1373
+ export interface PathParameters {
1374
+ job_id: Parameters.JobId;
1375
+ }
1376
+ namespace Responses {
1377
+ export type $200 = Components.Schemas.BlueprintJob;
1378
+ }
1379
+ }
1325
1380
  namespace ContinueInstallationJob {
1326
1381
  namespace Parameters {
1327
1382
  export type JobId = /**
1328
- * ID of an installation job
1383
+ * ID of a job
1329
1384
  * example:
1330
1385
  * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1331
1386
  */
1332
- Components.Schemas.InstallationJobID;
1387
+ Components.Schemas.BlueprintJobID;
1333
1388
  }
1334
1389
  export interface PathParameters {
1335
1390
  job_id: Parameters.JobId;
1336
1391
  }
1337
1392
  namespace Responses {
1338
- export type $200 = Components.Schemas.InstallationJob;
1393
+ export type $200 = Components.Schemas.BlueprintInstallationJob;
1339
1394
  }
1340
1395
  }
1341
1396
  namespace CreateBlueprint {
@@ -1386,34 +1441,6 @@ declare namespace Paths {
1386
1441
  }
1387
1442
  }
1388
1443
  }
1389
- namespace CreateInstallationJob {
1390
- export interface RequestBody {
1391
- source_blueprint_id: /**
1392
- * ID of a blueprint
1393
- * example:
1394
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1395
- */
1396
- Components.Schemas.BlueprintID;
1397
- /**
1398
- * Destination organization ID
1399
- */
1400
- destination_org_id: string;
1401
- /**
1402
- * Installation mode
1403
- */
1404
- mode: "simple" | "advanced";
1405
- }
1406
- namespace Responses {
1407
- export interface $202 {
1408
- job_id?: /**
1409
- * ID of an installation job
1410
- * example:
1411
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1412
- */
1413
- Components.Schemas.InstallationJobID;
1414
- }
1415
- }
1416
- }
1417
1444
  namespace CreatePlan {
1418
1445
  export type RequestBody = {
1419
1446
  /**
@@ -1575,8 +1602,13 @@ declare namespace Paths {
1575
1602
  blueprint_id: Parameters.BlueprintId;
1576
1603
  }
1577
1604
  namespace Responses {
1578
- export interface $200 {
1579
- url?: string;
1605
+ export interface $202 {
1606
+ job_id?: /**
1607
+ * ID of a job
1608
+ * example:
1609
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1610
+ */
1611
+ Components.Schemas.BlueprintJobID;
1580
1612
  }
1581
1613
  }
1582
1614
  }
@@ -1647,45 +1679,20 @@ declare namespace Paths {
1647
1679
  export type $200 = Components.Schemas.Blueprint;
1648
1680
  }
1649
1681
  }
1650
- namespace GetInstallationJob {
1682
+ namespace GetBlueprintJob {
1651
1683
  namespace Parameters {
1652
1684
  export type JobId = /**
1653
- * ID of an installation job
1685
+ * ID of a job
1654
1686
  * example:
1655
1687
  * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1656
1688
  */
1657
- Components.Schemas.InstallationJobID;
1689
+ Components.Schemas.BlueprintJobID;
1658
1690
  }
1659
1691
  export interface PathParameters {
1660
1692
  job_id: Parameters.JobId;
1661
1693
  }
1662
1694
  namespace Responses {
1663
- export type $200 = Components.Schemas.InstallationJob;
1664
- }
1665
- }
1666
- namespace GetInstallationJobEvents {
1667
- namespace Parameters {
1668
- export type JobId = /**
1669
- * ID of an installation job
1670
- * example:
1671
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1672
- */
1673
- Components.Schemas.InstallationJobID;
1674
- }
1675
- export interface PathParameters {
1676
- job_id: Parameters.JobId;
1677
- }
1678
- namespace Responses {
1679
- export interface $200 {
1680
- created_at?: string; // date-time
1681
- status?: "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
1682
- errors?: Components.Schemas.FormattedError[];
1683
- /**
1684
- * Progress completion (0-100)
1685
- */
1686
- progress?: number; // float
1687
- events?: Components.Schemas.InstallationJobEvent[];
1688
- }
1695
+ export type $200 = Components.Schemas.BlueprintJob;
1689
1696
  }
1690
1697
  }
1691
1698
  namespace GetJob {
@@ -1720,6 +1727,54 @@ declare namespace Paths {
1720
1727
  export type $200 = Components.Schemas.Manifest;
1721
1728
  }
1722
1729
  }
1730
+ namespace InstallBlueprint {
1731
+ export interface RequestBody {
1732
+ source_org_id?: string;
1733
+ source_blueprint_id?: /**
1734
+ * ID of a blueprint
1735
+ * example:
1736
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1737
+ */
1738
+ Components.Schemas.BlueprintID;
1739
+ /**
1740
+ * URL to the blueprint zip file
1741
+ */
1742
+ source_blueprint_file?: string;
1743
+ destination_org_id?: string;
1744
+ destination_blueprint_id?: /**
1745
+ * ID of a blueprint
1746
+ * example:
1747
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1748
+ */
1749
+ Components.Schemas.BlueprintID;
1750
+ /**
1751
+ * Installation mode
1752
+ */
1753
+ mode: "simple" | "advanced";
1754
+ }
1755
+ namespace Responses {
1756
+ export interface $202 {
1757
+ job_id?: /**
1758
+ * ID of a job
1759
+ * example:
1760
+ * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1761
+ */
1762
+ Components.Schemas.BlueprintJobID;
1763
+ }
1764
+ }
1765
+ }
1766
+ namespace ListBlueprintJobs {
1767
+ namespace Responses {
1768
+ export interface $200 {
1769
+ /**
1770
+ * example:
1771
+ * 1
1772
+ */
1773
+ total?: number;
1774
+ results?: Components.Schemas.BlueprintJob[];
1775
+ }
1776
+ }
1777
+ }
1723
1778
  namespace ListBlueprints {
1724
1779
  namespace Responses {
1725
1780
  export interface $200 {
@@ -1835,21 +1890,9 @@ declare namespace Paths {
1835
1890
  }
1836
1891
  }
1837
1892
  }
1838
- namespace V2BlueprintManifestInstallations$JobIdCancel {
1839
- namespace Parameters {
1840
- export type JobId = /**
1841
- * ID of an installation job
1842
- * example:
1843
- * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
1844
- */
1845
- Components.Schemas.InstallationJobID;
1846
- }
1847
- export interface PathParameters {
1848
- job_id: Parameters.JobId;
1849
- }
1850
- }
1851
1893
  }
1852
1894
 
1895
+
1853
1896
  export interface OperationMethods {
1854
1897
  /**
1855
1898
  * getJob - getJob
@@ -1982,6 +2025,17 @@ export interface OperationMethods {
1982
2025
  data?: Paths.CreateBlueprint.RequestBody,
1983
2026
  config?: AxiosRequestConfig
1984
2027
  ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
2028
+ /**
2029
+ * installBlueprint - installBlueprint
2030
+ *
2031
+ * Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
2032
+ *
2033
+ */
2034
+ 'installBlueprint'(
2035
+ parameters?: Parameters<UnknownParamsObject> | null,
2036
+ data?: Paths.InstallBlueprint.RequestBody,
2037
+ config?: AxiosRequestConfig
2038
+ ): OperationResponse<Paths.InstallBlueprint.Responses.$202>
1985
2039
  /**
1986
2040
  * getBlueprint - getBlueprint
1987
2041
  *
@@ -2015,13 +2069,14 @@ export interface OperationMethods {
2015
2069
  /**
2016
2070
  * exportBlueprint - exportBlueprint
2017
2071
  *
2018
- * Zip the blueprint content and return the url to download it
2072
+ * Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
2073
+ *
2019
2074
  */
2020
2075
  'exportBlueprint'(
2021
2076
  parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
2022
2077
  data?: any,
2023
2078
  config?: AxiosRequestConfig
2024
- ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
2079
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$202>
2025
2080
  /**
2026
2081
  * addBlueprintResource - addBlueprintResource
2027
2082
  *
@@ -2093,26 +2148,25 @@ export interface OperationMethods {
2093
2148
  config?: AxiosRequestConfig
2094
2149
  ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2095
2150
  /**
2096
- * createInstallationJob - Create Installation Job
2097
- *
2098
- * Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
2151
+ * listBlueprintJobs - List Blueprint Jobs
2099
2152
  *
2153
+ * List all blueprint jobs
2100
2154
  */
2101
- 'createInstallationJob'(
2155
+ 'listBlueprintJobs'(
2102
2156
  parameters?: Parameters<UnknownParamsObject> | null,
2103
- data?: Paths.CreateInstallationJob.RequestBody,
2157
+ data?: any,
2104
2158
  config?: AxiosRequestConfig
2105
- ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2159
+ ): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
2106
2160
  /**
2107
- * getInstallationJob - Get Installation Job
2161
+ * getBlueprintJob - Get Job
2108
2162
  *
2109
- * Poll current state of an installation job.
2163
+ * Poll current state of a job.
2110
2164
  */
2111
- 'getInstallationJob'(
2112
- parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2165
+ 'getBlueprintJob'(
2166
+ parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
2113
2167
  data?: any,
2114
2168
  config?: AxiosRequestConfig
2115
- ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2169
+ ): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
2116
2170
  /**
2117
2171
  * continueInstallationJob - Continue Installation Job
2118
2172
  *
@@ -2124,15 +2178,15 @@ export interface OperationMethods {
2124
2178
  config?: AxiosRequestConfig
2125
2179
  ): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
2126
2180
  /**
2127
- * getInstallationJobEvents - Get Installation Job Events
2181
+ * cancelBlueprintJob - Cancel Blueprint Job
2128
2182
  *
2129
- * Event log for an installation job.
2183
+ * Cancel a blueprint job if it is still running.
2130
2184
  */
2131
- 'getInstallationJobEvents'(
2132
- parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
2185
+ 'cancelBlueprintJob'(
2186
+ parameters?: Parameters<Paths.CancelBlueprintJob.PathParameters> | null,
2133
2187
  data?: any,
2134
2188
  config?: AxiosRequestConfig
2135
- ): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
2189
+ ): OperationResponse<Paths.CancelBlueprintJob.Responses.$200>
2136
2190
  }
2137
2191
 
2138
2192
  export interface PathsDictionary {
@@ -2285,6 +2339,19 @@ export interface PathsDictionary {
2285
2339
  config?: AxiosRequestConfig
2286
2340
  ): OperationResponse<Paths.CreateBlueprint.Responses.$200>
2287
2341
  }
2342
+ ['/v2/blueprint-manifest/blueprint:install']: {
2343
+ /**
2344
+ * installBlueprint - installBlueprint
2345
+ *
2346
+ * Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource
2347
+ *
2348
+ */
2349
+ 'post'(
2350
+ parameters?: Parameters<UnknownParamsObject> | null,
2351
+ data?: Paths.InstallBlueprint.RequestBody,
2352
+ config?: AxiosRequestConfig
2353
+ ): OperationResponse<Paths.InstallBlueprint.Responses.$202>
2354
+ }
2288
2355
  ['/v2/blueprint-manifest/blueprints/{blueprint_id}']: {
2289
2356
  /**
2290
2357
  * getBlueprint - getBlueprint
@@ -2321,13 +2388,14 @@ export interface PathsDictionary {
2321
2388
  /**
2322
2389
  * exportBlueprint - exportBlueprint
2323
2390
  *
2324
- * Zip the blueprint content and return the url to download it
2391
+ * Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.
2392
+ *
2325
2393
  */
2326
2394
  'post'(
2327
2395
  parameters?: Parameters<Paths.ExportBlueprint.PathParameters> | null,
2328
2396
  data?: any,
2329
2397
  config?: AxiosRequestConfig
2330
- ): OperationResponse<Paths.ExportBlueprint.Responses.$200>
2398
+ ): OperationResponse<Paths.ExportBlueprint.Responses.$202>
2331
2399
  }
2332
2400
  ['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
2333
2401
  /**
@@ -2407,32 +2475,31 @@ export interface PathsDictionary {
2407
2475
  config?: AxiosRequestConfig
2408
2476
  ): OperationResponse<Paths.DeleteBlueprintResource.Responses.$200>
2409
2477
  }
2410
- ['/v2/blueprint-manifest/installations']: {
2478
+ ['/v2/blueprint-manifest/jobs']: {
2411
2479
  /**
2412
- * createInstallationJob - Create Installation Job
2413
- *
2414
- * Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.
2480
+ * listBlueprintJobs - List Blueprint Jobs
2415
2481
  *
2482
+ * List all blueprint jobs
2416
2483
  */
2417
- 'post'(
2484
+ 'get'(
2418
2485
  parameters?: Parameters<UnknownParamsObject> | null,
2419
- data?: Paths.CreateInstallationJob.RequestBody,
2486
+ data?: any,
2420
2487
  config?: AxiosRequestConfig
2421
- ): OperationResponse<Paths.CreateInstallationJob.Responses.$202>
2488
+ ): OperationResponse<Paths.ListBlueprintJobs.Responses.$200>
2422
2489
  }
2423
- ['/v2/blueprint-manifest/installations/{job_id}']: {
2490
+ ['/v2/blueprint-manifest/jobs/{job_id}']: {
2424
2491
  /**
2425
- * getInstallationJob - Get Installation Job
2492
+ * getBlueprintJob - Get Job
2426
2493
  *
2427
- * Poll current state of an installation job.
2494
+ * Poll current state of a job.
2428
2495
  */
2429
2496
  'get'(
2430
- parameters?: Parameters<Paths.GetInstallationJob.PathParameters> | null,
2497
+ parameters?: Parameters<Paths.GetBlueprintJob.PathParameters> | null,
2431
2498
  data?: any,
2432
2499
  config?: AxiosRequestConfig
2433
- ): OperationResponse<Paths.GetInstallationJob.Responses.$200>
2500
+ ): OperationResponse<Paths.GetBlueprintJob.Responses.$200>
2434
2501
  }
2435
- ['/v2/blueprint-manifest/installations/{job_id}:continue']: {
2502
+ ['/v2/blueprint-manifest/jobs/{job_id}:continue']: {
2436
2503
  /**
2437
2504
  * continueInstallationJob - Continue Installation Job
2438
2505
  *
@@ -2444,32 +2511,37 @@ export interface PathsDictionary {
2444
2511
  config?: AxiosRequestConfig
2445
2512
  ): OperationResponse<Paths.ContinueInstallationJob.Responses.$200>
2446
2513
  }
2447
- ['/v2/blueprint-manifest/installations/{job_id}:cancel']: {
2448
- }
2449
- ['/v2/blueprint-manifest/installations/{job_id}/events']: {
2514
+ ['/v2/blueprint-manifest/jobs/{job_id}:cancel']: {
2450
2515
  /**
2451
- * getInstallationJobEvents - Get Installation Job Events
2516
+ * cancelBlueprintJob - Cancel Blueprint Job
2452
2517
  *
2453
- * Event log for an installation job.
2518
+ * Cancel a blueprint job if it is still running.
2454
2519
  */
2455
- 'get'(
2456
- parameters?: Parameters<Paths.GetInstallationJobEvents.PathParameters> | null,
2520
+ 'post'(
2521
+ parameters?: Parameters<Paths.CancelBlueprintJob.PathParameters> | null,
2457
2522
  data?: any,
2458
2523
  config?: AxiosRequestConfig
2459
- ): OperationResponse<Paths.GetInstallationJobEvents.Responses.$200>
2524
+ ): OperationResponse<Paths.CancelBlueprintJob.Responses.$200>
2460
2525
  }
2461
2526
  }
2462
2527
 
2463
2528
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
2464
2529
 
2530
+
2465
2531
  export type AppBlueprint = Components.Schemas.AppBlueprint;
2466
2532
  export type Blueprint = Components.Schemas.Blueprint;
2533
+ export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
2467
2534
  export type BlueprintID = Components.Schemas.BlueprintID;
2468
2535
  export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
2536
+ export type BlueprintInstallationJob = Components.Schemas.BlueprintInstallationJob;
2537
+ export type BlueprintJob = Components.Schemas.BlueprintJob;
2538
+ export type BlueprintJobEvent = Components.Schemas.BlueprintJobEvent;
2539
+ export type BlueprintJobID = Components.Schemas.BlueprintJobID;
2469
2540
  export type BlueprintResource = Components.Schemas.BlueprintResource;
2470
2541
  export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
2471
2542
  export type CallerIdentity = Components.Schemas.CallerIdentity;
2472
2543
  export type CommonBlueprintFields = Components.Schemas.CommonBlueprintFields;
2544
+ export type CommonBlueprintJobFields = Components.Schemas.CommonBlueprintJobFields;
2473
2545
  export type CommonImportFields = Components.Schemas.CommonImportFields;
2474
2546
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
2475
2547
  export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
@@ -2481,9 +2553,6 @@ export type FileBlueprint = Components.Schemas.FileBlueprint;
2481
2553
  export type FormattedError = Components.Schemas.FormattedError;
2482
2554
  export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
2483
2555
  export type FormattedErrorData = Components.Schemas.FormattedErrorData;
2484
- export type InstallationJob = Components.Schemas.InstallationJob;
2485
- export type InstallationJobEvent = Components.Schemas.InstallationJobEvent;
2486
- export type InstallationJobID = Components.Schemas.InstallationJobID;
2487
2556
  export type InstalledBlueprintResource = Components.Schemas.InstalledBlueprintResource;
2488
2557
  export type Job = Components.Schemas.Job;
2489
2558
  export type JobID = Components.Schemas.JobID;
package/dist/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.1.0",
3
3
  "info": {
4
4
  "title": "Blueprint Manifest API",
5
- "version": "0.1.0",
5
+ "version": "1.0.0",
6
6
  "description": "Service to create and install Blueprint Manifest files"
7
7
  },
8
8
  "tags": [
@@ -751,6 +751,80 @@
751
751
  }
752
752
  }
753
753
  },
754
+ "/v2/blueprint-manifest/blueprint:install": {
755
+ "post": {
756
+ "operationId": "installBlueprint",
757
+ "summary": "installBlueprint",
758
+ "description": "Kick off a new blueprint installation job. Returns 202 Accepted with Location header pointing to the job resource\n",
759
+ "tags": [
760
+ "Blueprints"
761
+ ],
762
+ "requestBody": {
763
+ "required": true,
764
+ "content": {
765
+ "application/json": {
766
+ "schema": {
767
+ "type": "object",
768
+ "properties": {
769
+ "source_org_id": {
770
+ "type": "string"
771
+ },
772
+ "source_blueprint_id": {
773
+ "$ref": "#/components/schemas/BlueprintID"
774
+ },
775
+ "source_blueprint_file": {
776
+ "type": "string",
777
+ "description": "URL to the blueprint zip file"
778
+ },
779
+ "destination_org_id": {
780
+ "type": "string"
781
+ },
782
+ "destination_blueprint_id": {
783
+ "$ref": "#/components/schemas/BlueprintID"
784
+ },
785
+ "mode": {
786
+ "type": "string",
787
+ "enum": [
788
+ "simple",
789
+ "advanced"
790
+ ],
791
+ "description": "Installation mode"
792
+ }
793
+ },
794
+ "required": [
795
+ "mode"
796
+ ]
797
+ }
798
+ }
799
+ }
800
+ },
801
+ "responses": {
802
+ "202": {
803
+ "description": "Blueprint installation job started",
804
+ "headers": {
805
+ "Location": {
806
+ "description": "URL to poll the job",
807
+ "schema": {
808
+ "type": "string"
809
+ }
810
+ }
811
+ },
812
+ "content": {
813
+ "application/json": {
814
+ "schema": {
815
+ "type": "object",
816
+ "properties": {
817
+ "job_id": {
818
+ "$ref": "#/components/schemas/BlueprintJobID"
819
+ }
820
+ }
821
+ }
822
+ }
823
+ }
824
+ }
825
+ }
826
+ }
827
+ },
754
828
  "/v2/blueprint-manifest/blueprints/{blueprint_id}": {
755
829
  "get": {
756
830
  "operationId": "getBlueprint",
@@ -856,7 +930,7 @@
856
930
  "post": {
857
931
  "operationId": "exportBlueprint",
858
932
  "summary": "exportBlueprint",
859
- "description": "Zip the blueprint content and return the url to download it",
933
+ "description": "Kick off a new blueprint export job. Returns 202 Accepted with Location header pointing to the job resource.\n",
860
934
  "tags": [
861
935
  "Blueprints"
862
936
  ],
@@ -871,15 +945,23 @@
871
945
  }
872
946
  ],
873
947
  "responses": {
874
- "200": {
875
- "description": "Exported Blueprint",
948
+ "202": {
949
+ "description": "Blueprint export job started",
950
+ "headers": {
951
+ "Location": {
952
+ "description": "URL to poll the job",
953
+ "schema": {
954
+ "type": "string"
955
+ }
956
+ }
957
+ },
876
958
  "content": {
877
959
  "application/json": {
878
960
  "schema": {
879
961
  "type": "object",
880
962
  "properties": {
881
- "url": {
882
- "type": "string"
963
+ "job_id": {
964
+ "$ref": "#/components/schemas/BlueprintJobID"
883
965
  }
884
966
  }
885
967
  }
@@ -1328,70 +1410,31 @@
1328
1410
  }
1329
1411
  }
1330
1412
  },
1331
- "/v2/blueprint-manifest/installations": {
1332
- "post": {
1333
- "operationId": "createInstallationJob",
1334
- "summary": "Create Installation Job",
1335
- "description": "Kick off a new installation job. Returns 202 Accepted with Location header pointing to the job resource and a strict idempotency-key header.\n",
1413
+ "/v2/blueprint-manifest/jobs": {
1414
+ "get": {
1415
+ "operationId": "listBlueprintJobs",
1416
+ "summary": "List Blueprint Jobs",
1417
+ "description": "List all blueprint jobs",
1336
1418
  "tags": [
1337
- "Installations"
1419
+ "Jobs"
1338
1420
  ],
1339
- "requestBody": {
1340
- "required": true,
1341
- "content": {
1342
- "application/json": {
1343
- "schema": {
1344
- "type": "object",
1345
- "properties": {
1346
- "source_blueprint_id": {
1347
- "$ref": "#/components/schemas/BlueprintID"
1348
- },
1349
- "destination_org_id": {
1350
- "type": "string",
1351
- "description": "Destination organization ID"
1352
- },
1353
- "mode": {
1354
- "type": "string",
1355
- "enum": [
1356
- "simple",
1357
- "advanced"
1358
- ],
1359
- "description": "Installation mode"
1360
- }
1361
- },
1362
- "required": [
1363
- "source_blueprint_id",
1364
- "destination_org_id",
1365
- "mode"
1366
- ]
1367
- }
1368
- }
1369
- }
1370
- },
1371
1421
  "responses": {
1372
- "202": {
1373
- "description": "Installation job started",
1374
- "headers": {
1375
- "Location": {
1376
- "description": "URL to poll the job",
1377
- "schema": {
1378
- "type": "string"
1379
- }
1380
- },
1381
- "Idempotency-Key": {
1382
- "description": "Strict idempotency key",
1383
- "schema": {
1384
- "type": "string"
1385
- }
1386
- }
1387
- },
1422
+ "200": {
1423
+ "description": "Blueprint jobs",
1388
1424
  "content": {
1389
1425
  "application/json": {
1390
1426
  "schema": {
1391
1427
  "type": "object",
1392
1428
  "properties": {
1393
- "job_id": {
1394
- "$ref": "#/components/schemas/InstallationJobID"
1429
+ "total": {
1430
+ "type": "integer",
1431
+ "example": 1
1432
+ },
1433
+ "results": {
1434
+ "type": "array",
1435
+ "items": {
1436
+ "$ref": "#/components/schemas/BlueprintJob"
1437
+ }
1395
1438
  }
1396
1439
  }
1397
1440
  }
@@ -1401,13 +1444,13 @@
1401
1444
  }
1402
1445
  }
1403
1446
  },
1404
- "/v2/blueprint-manifest/installations/{job_id}": {
1447
+ "/v2/blueprint-manifest/jobs/{job_id}": {
1405
1448
  "get": {
1406
- "operationId": "getInstallationJob",
1407
- "summary": "Get Installation Job",
1408
- "description": "Poll current state of an installation job.",
1449
+ "operationId": "getBlueprintJob",
1450
+ "summary": "Get Job",
1451
+ "description": "Poll current state of a job.",
1409
1452
  "tags": [
1410
- "Installations"
1453
+ "Jobs"
1411
1454
  ],
1412
1455
  "parameters": [
1413
1456
  {
@@ -1415,17 +1458,17 @@
1415
1458
  "required": true,
1416
1459
  "name": "job_id",
1417
1460
  "schema": {
1418
- "$ref": "#/components/schemas/InstallationJobID"
1461
+ "$ref": "#/components/schemas/BlueprintJobID"
1419
1462
  }
1420
1463
  }
1421
1464
  ],
1422
1465
  "responses": {
1423
1466
  "200": {
1424
- "description": "Installation job status",
1467
+ "description": "Job status",
1425
1468
  "content": {
1426
1469
  "application/json": {
1427
1470
  "schema": {
1428
- "$ref": "#/components/schemas/InstallationJob"
1471
+ "$ref": "#/components/schemas/BlueprintJob"
1429
1472
  }
1430
1473
  }
1431
1474
  }
@@ -1433,13 +1476,13 @@
1433
1476
  }
1434
1477
  }
1435
1478
  },
1436
- "/v2/blueprint-manifest/installations/{job_id}:continue": {
1479
+ "/v2/blueprint-manifest/jobs/{job_id}:continue": {
1437
1480
  "post": {
1438
1481
  "operationId": "continueInstallationJob",
1439
1482
  "summary": "Continue Installation Job",
1440
1483
  "description": "Continue an installation job if it is waiting for user action.",
1441
1484
  "tags": [
1442
- "Installations"
1485
+ "Jobs"
1443
1486
  ],
1444
1487
  "parameters": [
1445
1488
  {
@@ -1447,17 +1490,17 @@
1447
1490
  "required": true,
1448
1491
  "name": "job_id",
1449
1492
  "schema": {
1450
- "$ref": "#/components/schemas/InstallationJobID"
1493
+ "$ref": "#/components/schemas/BlueprintJobID"
1451
1494
  }
1452
1495
  }
1453
1496
  ],
1454
1497
  "responses": {
1455
1498
  "200": {
1456
- "description": "Installation job continued",
1499
+ "description": "Blueprint installation job continued",
1457
1500
  "content": {
1458
1501
  "application/json": {
1459
1502
  "schema": {
1460
- "$ref": "#/components/schemas/InstallationJob"
1503
+ "$ref": "#/components/schemas/BlueprintInstallationJob"
1461
1504
  }
1462
1505
  }
1463
1506
  }
@@ -1465,43 +1508,13 @@
1465
1508
  }
1466
1509
  }
1467
1510
  },
1468
- "/v2/blueprint-manifest/installations/{job_id}:cancel": {
1469
- "operationId": "cancelInstallationJob",
1470
- "summary": "Cancel Installation Job",
1471
- "description": "Cancel an installation job if it is still running.",
1472
- "tags": [
1473
- "Installations"
1474
- ],
1475
- "parameters": [
1476
- {
1477
- "in": "path",
1478
- "required": true,
1479
- "name": "job_id",
1480
- "schema": {
1481
- "$ref": "#/components/schemas/InstallationJobID"
1482
- }
1483
- }
1484
- ],
1485
- "responses": {
1486
- "200": {
1487
- "description": "Installation job cancelled",
1488
- "content": {
1489
- "application/json": {
1490
- "schema": {
1491
- "$ref": "#/components/schemas/InstallationJob"
1492
- }
1493
- }
1494
- }
1495
- }
1496
- }
1497
- },
1498
- "/v2/blueprint-manifest/installations/{job_id}/events": {
1499
- "get": {
1500
- "operationId": "getInstallationJobEvents",
1501
- "summary": "Get Installation Job Events",
1502
- "description": "Event log for an installation job.",
1511
+ "/v2/blueprint-manifest/jobs/{job_id}:cancel": {
1512
+ "post": {
1513
+ "operationId": "cancelBlueprintJob",
1514
+ "summary": "Cancel Blueprint Job",
1515
+ "description": "Cancel a blueprint job if it is still running.",
1503
1516
  "tags": [
1504
- "Installations"
1517
+ "Jobs"
1505
1518
  ],
1506
1519
  "parameters": [
1507
1520
  {
@@ -1509,53 +1522,17 @@
1509
1522
  "required": true,
1510
1523
  "name": "job_id",
1511
1524
  "schema": {
1512
- "$ref": "#/components/schemas/InstallationJobID"
1525
+ "$ref": "#/components/schemas/BlueprintJobID"
1513
1526
  }
1514
1527
  }
1515
1528
  ],
1516
1529
  "responses": {
1517
1530
  "200": {
1518
- "description": "Event logs",
1531
+ "description": "Blueprint job cancelled",
1519
1532
  "content": {
1520
1533
  "application/json": {
1521
1534
  "schema": {
1522
- "type": "object",
1523
- "properties": {
1524
- "created_at": {
1525
- "type": "string",
1526
- "format": "date-time"
1527
- },
1528
- "status": {
1529
- "type": "string",
1530
- "enum": [
1531
- "STARTED",
1532
- "WAITING_USER_ACTION",
1533
- "CANCELED",
1534
- "IN_PROGRESS",
1535
- "SUCCESS",
1536
- "FAILED"
1537
- ]
1538
- },
1539
- "errors": {
1540
- "type": "array",
1541
- "items": {
1542
- "$ref": "#/components/schemas/FormattedError"
1543
- }
1544
- },
1545
- "progress": {
1546
- "type": "number",
1547
- "format": "float",
1548
- "minimum": 0,
1549
- "maximum": 100,
1550
- "description": "Progress completion (0-100)"
1551
- },
1552
- "events": {
1553
- "type": "array",
1554
- "items": {
1555
- "$ref": "#/components/schemas/InstallationJobEvent"
1556
- }
1557
- }
1558
- }
1535
+ "$ref": "#/components/schemas/BlueprintJob"
1559
1536
  }
1560
1537
  }
1561
1538
  }
@@ -1606,6 +1583,9 @@
1606
1583
  "version": {
1607
1584
  "type": "string"
1608
1585
  },
1586
+ "latest_download_file": {
1587
+ "$ref": "#/components/schemas/S3Reference"
1588
+ },
1609
1589
  "created_at": {
1610
1590
  "type": "string",
1611
1591
  "format": "date-time"
@@ -1851,48 +1831,22 @@
1851
1831
  }
1852
1832
  ]
1853
1833
  },
1854
- "InstallationJobID": {
1834
+ "BlueprintJobID": {
1855
1835
  "type": "string",
1856
- "description": "ID of an installation job",
1836
+ "description": "ID of a job",
1857
1837
  "example": "c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341"
1858
1838
  },
1859
- "InstallationJob": {
1839
+ "CommonBlueprintJobFields": {
1860
1840
  "type": "object",
1861
1841
  "properties": {
1862
1842
  "id": {
1863
- "$ref": "#/components/schemas/InstallationJobID"
1843
+ "$ref": "#/components/schemas/BlueprintJobID"
1864
1844
  },
1865
- "source_blueprint_id": {
1866
- "$ref": "#/components/schemas/BlueprintID"
1867
- },
1868
- "source_blueprint_type": {
1869
- "type": "string",
1870
- "enum": [
1871
- "file",
1872
- "marketplace",
1873
- "deploy",
1874
- "app"
1875
- ]
1876
- },
1877
- "source_org_id": {
1878
- "type": "string"
1879
- },
1880
- "destination_blueprint_id": {
1881
- "$ref": "#/components/schemas/BlueprintID"
1882
- },
1883
- "destination_org_id": {
1884
- "type": "string"
1885
- },
1886
- "status": {
1887
- "type": "string",
1888
- "enum": [
1889
- "STARTED",
1890
- "WAITING_USER_ACTION",
1891
- "CANCELED",
1892
- "IN_PROGRESS",
1893
- "SUCCESS",
1894
- "FAILED"
1895
- ]
1845
+ "events": {
1846
+ "type": "array",
1847
+ "items": {
1848
+ "$ref": "#/components/schemas/BlueprintJobEvent"
1849
+ }
1896
1850
  },
1897
1851
  "triggered_at": {
1898
1852
  "type": "string",
@@ -1900,13 +1854,94 @@
1900
1854
  },
1901
1855
  "created_by": {
1902
1856
  "$ref": "#/components/schemas/CallerIdentity"
1903
- },
1904
- "updated_by": {
1905
- "$ref": "#/components/schemas/CallerIdentity"
1906
1857
  }
1907
1858
  }
1908
1859
  },
1909
- "InstallationJobEvent": {
1860
+ "BlueprintExportJob": {
1861
+ "allOf": [
1862
+ {
1863
+ "$ref": "#/components/schemas/CommonBlueprintJobFields"
1864
+ },
1865
+ {
1866
+ "type": "object",
1867
+ "properties": {
1868
+ "blueprint_id": {
1869
+ "$ref": "#/components/schemas/BlueprintID"
1870
+ },
1871
+ "status": {
1872
+ "type": "string",
1873
+ "enum": [
1874
+ "IN_PROGRESS",
1875
+ "SUCCESS",
1876
+ "FAILED",
1877
+ "CANCELED"
1878
+ ]
1879
+ },
1880
+ "download_file": {
1881
+ "$ref": "#/components/schemas/S3Reference"
1882
+ }
1883
+ }
1884
+ }
1885
+ ]
1886
+ },
1887
+ "BlueprintInstallationJob": {
1888
+ "allOf": [
1889
+ {
1890
+ "$ref": "#/components/schemas/CommonBlueprintJobFields"
1891
+ },
1892
+ {
1893
+ "type": "object",
1894
+ "properties": {
1895
+ "source_blueprint_id": {
1896
+ "$ref": "#/components/schemas/BlueprintID"
1897
+ },
1898
+ "source_blueprint_type": {
1899
+ "type": "string",
1900
+ "enum": [
1901
+ "custom",
1902
+ "file",
1903
+ "marketplace",
1904
+ "deploy",
1905
+ "app"
1906
+ ]
1907
+ },
1908
+ "source_org_id": {
1909
+ "type": "string"
1910
+ },
1911
+ "source_blueprint_file": {
1912
+ "type": "string"
1913
+ },
1914
+ "destination_blueprint_id": {
1915
+ "$ref": "#/components/schemas/BlueprintID"
1916
+ },
1917
+ "destination_org_id": {
1918
+ "type": "string"
1919
+ },
1920
+ "status": {
1921
+ "type": "string",
1922
+ "enum": [
1923
+ "IN_PROGRESS",
1924
+ "WAITING_USER_ACTION",
1925
+ "CANCELED",
1926
+ "SUCCESS",
1927
+ "FAILED"
1928
+ ]
1929
+ }
1930
+ }
1931
+ }
1932
+ ]
1933
+ },
1934
+ "BlueprintJob": {
1935
+ "oneOf": [
1936
+ {
1937
+ "$ref": "#/components/schemas/BlueprintExportJob"
1938
+ },
1939
+ {
1940
+ "$ref": "#/components/schemas/BlueprintInstallationJob"
1941
+ }
1942
+ ]
1943
+ },
1944
+ "BlueprintJobEvent": {
1910
1945
  "type": "object",
1911
1946
  "properties": {
1912
1947
  "timestamp": {
@@ -1916,6 +1951,12 @@
1916
1951
  "message": {
1917
1952
  "type": "string"
1918
1953
  },
1954
+ "errors": {
1955
+ "type": "array",
1956
+ "items": {
1957
+ "$ref": "#/components/schemas/FormattedError"
1958
+ }
1959
+ },
1919
1960
  "level": {
1920
1961
  "type": "string",
1921
1962
  "enum": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "3.0.0-beta.1",
3
+ "version": "3.0.0-beta.3",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",