@epilot/blueprint-manifest-client 2.5.9 → 2.6.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/openapi.d.ts CHANGED
@@ -21,6 +21,7 @@ declare namespace Components {
21
21
  JobID?: Parameters.JobID;
22
22
  }
23
23
  namespace Schemas {
24
+ export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
24
25
  export interface CallerIdentity {
25
26
  /**
26
27
  * a human readable name of the caller (e.g. user name, token name or email address)
@@ -59,6 +60,12 @@ declare namespace Components {
59
60
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
60
61
  */
61
62
  large_imported_resources_url?: string; // uri
63
+ install_status?: BlueprintInstallStatus;
64
+ /**
65
+ * example:
66
+ * This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
67
+ */
68
+ install_status_description?: string;
62
69
  }
63
70
  export interface CommonManifestFields {
64
71
  manifest_id?: /**
@@ -98,12 +105,6 @@ declare namespace Components {
98
105
  is_verified?: boolean;
99
106
  created_by?: CallerIdentity;
100
107
  updated_by?: CallerIdentity;
101
- /**
102
- * Version of the manifest (semver)
103
- * example:
104
- * 1.0.0
105
- */
106
- manifest_version?: string;
107
108
  }
108
109
  export interface CommonMarkdownFields {
109
110
  /**
@@ -216,6 +217,12 @@ declare namespace Components {
216
217
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
217
218
  */
218
219
  large_imported_resources_url?: string; // uri
220
+ install_status?: BlueprintInstallStatus;
221
+ /**
222
+ * example:
223
+ * This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
224
+ */
225
+ install_status_description?: string;
219
226
  /**
220
227
  * Markdown content part of a manifest file
221
228
  */
@@ -274,12 +281,6 @@ declare namespace Components {
274
281
  source_blueprint_file_ref?: S3Reference;
275
282
  created_by?: CallerIdentity;
276
283
  updated_by?: CallerIdentity;
277
- /**
278
- * Version of the manifest (semver)
279
- * example:
280
- * 1.0.0
281
- */
282
- manifest_version?: string;
283
284
  }
284
285
  /**
285
286
  * ID of an import or export job (state machine)
@@ -295,14 +296,6 @@ declare namespace Components {
295
296
  * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
296
297
  */
297
298
  JobID;
298
- /**
299
- * List of job IDs that were used to install the manifest
300
- */
301
- previous_jobs_ids?: string[];
302
- /**
303
- * List of jobs that were used to install the manifest
304
- */
305
- previous_jobs?: Job[];
306
299
  manifest_id?: /**
307
300
  * ID of an imported / installed manifest
308
301
  * example:
@@ -340,12 +333,6 @@ declare namespace Components {
340
333
  is_verified?: boolean;
341
334
  created_by?: CallerIdentity;
342
335
  updated_by?: CallerIdentity;
343
- /**
344
- * Version of the manifest (semver)
345
- * example:
346
- * 1.0.0
347
- */
348
- manifest_version?: string;
349
336
  /**
350
337
  * Markdown content part of a manifest file
351
338
  */
@@ -382,6 +369,12 @@ declare namespace Components {
382
369
  * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json
383
370
  */
384
371
  large_imported_resources_url?: string; // uri
372
+ install_status?: BlueprintInstallStatus;
373
+ /**
374
+ * example:
375
+ * This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup.
376
+ */
377
+ install_status_description?: string;
385
378
  /**
386
379
  * When the manifest was first installed (applied)
387
380
  */
@@ -435,12 +428,6 @@ declare namespace Components {
435
428
  is_verified?: boolean;
436
429
  created_by?: CallerIdentity;
437
430
  updated_by?: CallerIdentity;
438
- /**
439
- * Version of the manifest (semver)
440
- * example:
441
- * 1.0.0
442
- */
443
- manifest_version?: string;
444
431
  /**
445
432
  * When the manifest was first installed (applied)
446
433
  */
@@ -1038,6 +1025,7 @@ export interface PathsDictionary {
1038
1025
 
1039
1026
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1040
1027
 
1028
+ export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
1041
1029
  export type CallerIdentity = Components.Schemas.CallerIdentity;
1042
1030
  export type CommonImportFields = Components.Schemas.CommonImportFields;
1043
1031
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
package/dist/openapi.json CHANGED
@@ -511,20 +511,6 @@
511
511
  "properties": {
512
512
  "import_job_id": {
513
513
  "$ref": "#/components/schemas/JobID"
514
- },
515
- "previous_jobs_ids": {
516
- "type": "array",
517
- "items": {
518
- "type": "string"
519
- },
520
- "description": "List of job IDs that were used to install the manifest"
521
- },
522
- "previous_jobs": {
523
- "type": "array",
524
- "items": {
525
- "$ref": "#/components/schemas/Job"
526
- },
527
- "description": "List of jobs that were used to install the manifest"
528
514
  }
529
515
  }
530
516
  },
@@ -876,11 +862,6 @@
876
862
  },
877
863
  "updated_by": {
878
864
  "$ref": "#/components/schemas/CallerIdentity"
879
- },
880
- "manifest_version": {
881
- "type": "string",
882
- "description": "Version of the manifest (semver)",
883
- "example": "1.0.0"
884
865
  }
885
866
  }
886
867
  },
@@ -924,6 +905,13 @@
924
905
  "format": "uri",
925
906
  "description": "An URL to download the imported resources when the resources are too large to be included in the response",
926
907
  "example": "https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/large.json"
908
+ },
909
+ "install_status": {
910
+ "$ref": "#/components/schemas/BlueprintInstallStatus"
911
+ },
912
+ "install_status_description": {
913
+ "type": "string",
914
+ "example": "This blueprint installation resulted in a partial deployment; some resources were created successfully, but failed to complete the full resource setup."
927
915
  }
928
916
  }
929
917
  },
@@ -954,6 +942,14 @@
954
942
  }
955
943
  }
956
944
  },
945
+ "BlueprintInstallStatus": {
946
+ "type": "string",
947
+ "enum": [
948
+ "SUCCESS",
949
+ "PARTIAL",
950
+ "FAILED"
951
+ ]
952
+ },
957
953
  "FormattedErrorCodes": {
958
954
  "type": "string",
959
955
  "enum": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "2.5.9",
3
+ "version": "2.6.0",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",