@epilot/blueprint-manifest-client 2.5.8 → 2.5.10

package/dist/openapi.d.ts

@@ -21,6 +21,7 @@ declare namespace Components {
         JobID?: Parameters.JobID;
     }
     namespace Schemas {
+        export type BlueprintInstallStatus = "SUCCESS" | "PARTIAL" | "FAILED";
         export interface CallerIdentity {
             /**
              * a human readable name of the caller (e.g. user name, token name or email address)
@@ -91,13 +92,31 @@ declare namespace Components {
              * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
              */
             source_blueprint_file?: string;
+            /**
+             * Link to the blueprint documentation
+             * example:
+             * https://help.epilot.cloud
+             */
+            docs_link?: string;
             source_blueprint_file_ref?: S3Reference;
+            install_status?: BlueprintInstallStatus;
+            /**
+             * example:
+             * This blueprint installation resulted in a partial deployment; some resources were created successfully, but  failed to complete the full resource setup.
+             */
+            install_status_description?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            /**
+             * Version of the manifest (semver)
+             * example:
+             * 1.0.0
+             */
+            manifest_version?: string;
         }
         export interface CommonMarkdownFields {
             /**
@@ -265,9 +284,27 @@ declare namespace Components {
              * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
              */
             source_blueprint_file?: string;
+            /**
+             * Link to the blueprint documentation
+             * example:
+             * https://help.epilot.cloud
+             */
+            docs_link?: string;
             source_blueprint_file_ref?: S3Reference;
+            install_status?: BlueprintInstallStatus;
+            /**
+             * example:
+             * This blueprint installation resulted in a partial deployment; some resources were created successfully, but  failed to complete the full resource setup.
+             */
+            install_status_description?: string;
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            /**
+             * Version of the manifest (semver)
+             * example:
+             * 1.0.0
+             */
+            manifest_version?: string;
         }
         /**
          * ID of an import or export job (state machine)
@@ -283,6 +320,14 @@ declare namespace Components {
              * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
              */
             JobID;
+            /**
+             * List of job IDs that were used to install the manifest
+             */
+            previous_jobs_ids?: string[];
+            /**
+             * List of jobs that were used to install the manifest
+             */
+            previous_jobs?: Job[];
             manifest_id?: /**
              * ID of an imported / installed manifest
              * example:
@@ -313,13 +358,31 @@ declare namespace Components {
              * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
              */
             source_blueprint_file?: string;
+            /**
+             * Link to the blueprint documentation
+             * example:
+             * https://help.epilot.cloud
+             */
+            docs_link?: string;
             source_blueprint_file_ref?: S3Reference;
+            install_status?: BlueprintInstallStatus;
+            /**
+             * example:
+             * This blueprint installation resulted in a partial deployment; some resources were created successfully, but  failed to complete the full resource setup.
+             */
+            install_status_description?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            /**
+             * Version of the manifest (semver)
+             * example:
+             * 1.0.0
+             */
+            manifest_version?: string;
             /**
              * Markdown content part of a manifest file
              */
@@ -402,13 +465,31 @@ declare namespace Components {
              * https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip
              */
             source_blueprint_file?: string;
+            /**
+             * Link to the blueprint documentation
+             * example:
+             * https://help.epilot.cloud
+             */
+            docs_link?: string;
             source_blueprint_file_ref?: S3Reference;
+            install_status?: BlueprintInstallStatus;
+            /**
+             * example:
+             * This blueprint installation resulted in a partial deployment; some resources were created successfully, but  failed to complete the full resource setup.
+             */
+            install_status_description?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
             created_by?: CallerIdentity;
             updated_by?: CallerIdentity;
+            /**
+             * Version of the manifest (semver)
+             * example:
+             * 1.0.0
+             */
+            manifest_version?: string;
             /**
              * When the manifest was first installed (applied)
              */
@@ -711,6 +792,7 @@ declare namespace Paths {
              * Temporary flag to indicate if multiple resources are being exported
              */
             isExportingMultipleResources?: boolean;
+            generateAISummary?: boolean;
         }
         namespace Responses {
             export interface $200 {
@@ -1006,6 +1088,7 @@ export interface PathsDictionary {
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+export type BlueprintInstallStatus = Components.Schemas.BlueprintInstallStatus;
 export type CallerIdentity = Components.Schemas.CallerIdentity;
 export type CommonImportFields = Components.Schemas.CommonImportFields;
 export type CommonManifestFields = Components.Schemas.CommonManifestFields;

package/dist/openapi.json

@@ -157,6 +157,10 @@
                   "isExportingMultipleResources": {
                     "type": "boolean",
                     "description": "Temporary flag to indicate if multiple resources are being exported"
+                  },
+                  "generateAISummary": {
+                    "type": "boolean",
+                    "default": false
                   }
                 },
                 "required": [
@@ -511,6 +515,20 @@
             "properties": {
               "import_job_id": {
                 "$ref": "#/components/schemas/JobID"
+              },
+              "previous_jobs_ids": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "List of job IDs that were used to install the manifest"
+              },
+              "previous_jobs": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/Job"
+                },
+                "description": "List of jobs that were used to install the manifest"
               }
             }
           },
@@ -846,12 +864,25 @@
           },
           "source_blueprint_file": {
             "type": "string",
+            "deprecated": true,
             "description": "A URL to download the source blueprint file used to import the blueprint",
             "example": "https://blueprint-manifest-prod.s3.eu-central-1.amazonaws.com/manifest.zip"
           },
+          "docs_link": {
+            "type": "string",
+            "description": "Link to the blueprint documentation",
+            "example": "https://help.epilot.cloud"
+          },
           "source_blueprint_file_ref": {
             "$ref": "#/components/schemas/S3Reference"
           },
+          "install_status": {
+            "$ref": "#/components/schemas/BlueprintInstallStatus"
+          },
+          "install_status_description": {
+            "type": "string",
+            "example": "This blueprint installation resulted in a partial deployment; some resources were created successfully, but  failed to complete the full resource setup."
+          },
           "is_verified": {
             "type": "boolean",
             "description": "Whether the manifest comes from a trusted source and is signed by epilot"
@@ -861,6 +892,11 @@
           },
           "updated_by": {
             "$ref": "#/components/schemas/CallerIdentity"
+          },
+          "manifest_version": {
+            "type": "string",
+            "description": "Version of the manifest (semver)",
+            "example": "1.0.0"
           }
         }
       },
@@ -934,6 +970,14 @@
           }
         }
       },
+      "BlueprintInstallStatus": {
+        "type": "string",
+        "enum": [
+          "SUCCESS",
+          "PARTIAL",
+          "FAILED"
+        ]
+      },
       "FormattedErrorCodes": {
         "type": "string",
         "enum": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/blueprint-manifest-client",
-  "version": "2.5.8",
+  "version": "2.5.10",
   "description": "Client for epilot Terraform Blueprint Manifest API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",