@epilot/blueprint-manifest-client 2.5.0 → 2.5.2

package/dist/openapi.d.ts

@@ -112,6 +112,21 @@ declare namespace Components {
              */
             is_virtual?: boolean;
         }
+        export interface FormattedError {
+            error?: string | {
+                [key: string]: any;
+            };
+            code?: FormattedErrorCodes;
+            data?: FormattedErrorData;
+        }
+        export type FormattedErrorCodes = "dependency_extraction" | "resource_not_found" | "resource_fetch_api_error" | "resource_fetch_unknown_error" | "terraform_cli_process_error" | "terraform_import_block_process_error";
+        export interface FormattedErrorData {
+            resource?: {
+                id?: string;
+                name?: string;
+                type?: string;
+            };
+        }
         export interface Job {
             job_id?: /**
              * ID of an import or export job (state machine)
@@ -146,6 +161,7 @@ declare namespace Components {
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
+            errors?: FormattedError[];
             /**
              * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
              */
@@ -214,6 +230,12 @@ declare namespace Components {
         export type JobID = string;
         export type JobStatus = "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
         export interface Manifest {
+            import_job_id?: /**
+             * ID of an import or export job (state machine)
+             * example:
+             * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
+             */
+            JobID;
             manifest_id?: /**
              * ID of an imported / installed manifest
              * example:
@@ -372,7 +394,7 @@ declare namespace Components {
             }[];
             changes?: PlanChanges;
         }
-        export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "custom_variable";
+        export type ResourceNodeType = "designbuilder" | "journey" | "product" | "price" | "tax" | "automation_flow" | "entity_mapping" | "file" | "emailtemplate" | "schema" | "schema_attribute" | "schema_capability" | "schema_group" | "schema_group_headline" | "workflow_definition" | "closing_reason" | "taxonomy_classification" | "webhook" | "custom_variable";
         export interface RootResourceNode {
             /**
              * ID of the resource
@@ -911,6 +933,9 @@ export type CommonImportFields = Components.Schemas.CommonImportFields;
 export type CommonManifestFields = Components.Schemas.CommonManifestFields;
 export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
 export type CommonResourceNode = Components.Schemas.CommonResourceNode;
+export type FormattedError = Components.Schemas.FormattedError;
+export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
+export type FormattedErrorData = Components.Schemas.FormattedErrorData;
 export type Job = Components.Schemas.Job;
 export type JobID = Components.Schemas.JobID;
 export type JobStatus = Components.Schemas.JobStatus;

package/dist/openapi.json

@@ -32,9 +32,6 @@
     {
       "url": "https://blueprint-manifest.sls.epilot.io"
     },
-    {
-      "url": "https://blueprint-manifest.sls.epilot.io"
-    },
     {
       "url": "https://blueprint-manifest.sls.epilot.io"
     }
@@ -478,6 +475,14 @@
       },
       "Manifest": {
         "allOf": [
+          {
+            "type": "object",
+            "properties": {
+              "import_job_id": {
+                "$ref": "#/components/schemas/JobID"
+              }
+            }
+          },
           {
             "$ref": "#/components/schemas/CommonManifestFields"
           },
@@ -530,6 +535,7 @@
           "schema_attribute",
           "schema_capability",
           "schema_group",
+          "schema_group_headline",
           "workflow_definition",
           "closing_reason",
           "taxonomy_classification",
@@ -735,6 +741,12 @@
               "is_verified": {
                 "type": "boolean",
                 "description": "Whether the manifest comes from a trusted source and is signed by epilot"
+              },
+              "errors": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/FormattedError"
+                }
               }
             }
           },
@@ -870,6 +882,57 @@
             }
           }
         }
+      },
+      "FormattedErrorCodes": {
+        "type": "enum",
+        "enum": [
+          "dependency_extraction",
+          "resource_not_found",
+          "resource_fetch_api_error",
+          "resource_fetch_unknown_error",
+          "terraform_cli_process_error",
+          "terraform_import_block_process_error"
+        ]
+      },
+      "FormattedErrorData": {
+        "type": "object",
+        "properties": {
+          "resource": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "name": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      },
+      "FormattedError": {
+        "type": "object",
+        "properties": {
+          "error": {
+            "oneOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object"
+              }
+            ]
+          },
+          "code": {
+            "$ref": "#/components/schemas/FormattedErrorCodes"
+          },
+          "data": {
+            "$ref": "#/components/schemas/FormattedErrorData"
+          }
+        }
       }
     },
     "parameters": {

package/package.json

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