@epilot/blueprint-manifest-client 2.5.4 → 2.5.6

package/dist/openapi.d.ts

@@ -21,7 +21,34 @@ declare namespace Components {
         JobID?: Parameters.JobID;
     }
     namespace Schemas {
+        export interface CallerIdentity {
+            /**
+             * a human readable name of the caller (e.g. user name, token name or email address)
+             * example:
+             * manifest@epilot.cloud
+             */
+            name?: any;
+            /**
+             * epilot organization id
+             * example:
+             * 911690
+             */
+            org_id: string;
+            /**
+             * epilot user id, when called by a user
+             * example:
+             * 11001045
+             */
+            user_id?: string;
+            /**
+             * token id, when called by API token
+             * example:
+             * api_5ZugdRXasLfWBypHi93Fk
+             */
+            token_id?: string;
+        }
         export interface CommonImportFields {
+            source_type?: ManifestSource;
             /**
              * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
              */
@@ -57,10 +84,18 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            /**
+             * 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
+             */
+            source_blueprint_file?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
+            created_by?: CallerIdentity;
+            updated_by?: CallerIdentity;
         }
         export interface CommonMarkdownFields {
             /**
@@ -162,6 +197,7 @@ declare namespace Components {
              */
             is_verified?: boolean;
             errors?: FormattedError[];
+            source_type?: ManifestSource;
             /**
              * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
              */
@@ -221,6 +257,14 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            /**
+             * 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
+             */
+            source_blueprint_file?: string;
+            created_by?: CallerIdentity;
+            updated_by?: CallerIdentity;
         }
         /**
          * ID of an import or export job (state machine)
@@ -259,10 +303,18 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            /**
+             * 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
+             */
+            source_blueprint_file?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
+            created_by?: CallerIdentity;
+            updated_by?: CallerIdentity;
             /**
              * Markdown content part of a manifest file
              */
@@ -289,6 +341,7 @@ declare namespace Components {
                  */
                 postinstall?: string;
             };
+            source_type?: ManifestSource;
             /**
              * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
              */
@@ -338,10 +391,18 @@ declare namespace Components {
              * 1.0.0
              */
             source_blueprint_version?: string;
+            /**
+             * 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
+             */
+            source_blueprint_file?: string;
             /**
              * Whether the manifest comes from a trusted source and is signed by epilot
              */
             is_verified?: boolean;
+            created_by?: CallerIdentity;
+            updated_by?: CallerIdentity;
             /**
              * When the manifest was first installed (applied)
              */
@@ -351,6 +412,7 @@ declare namespace Components {
              */
             updated_at?: string; // date-time
         }
+        export type ManifestSource = "file" | "marketplace" | "sandbox";
         export interface ManifestTimestampFields {
             /**
              * When the manifest was first installed (applied)
@@ -479,10 +541,11 @@ declare namespace Paths {
         }
         export interface RequestBody {
             /**
+             * This is no longer used
              * example:
              * example.tf
              */
-            manifestFilePath?: string;
+            manifestFilePath?: string | null;
         }
         namespace Responses {
             export interface $200 {
@@ -570,6 +633,10 @@ declare namespace Paths {
              * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
              */
             manifest_id?: string;
+            /**
+             * Source of the manifest
+             */
+            source?: "file" | "marketplace" | "sandbox";
         } | {
             /**
              * Manifest s3 key uploaded via `uploadManifest`
@@ -581,6 +648,10 @@ declare namespace Paths {
              * c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
              */
             manifest_id?: string;
+            /**
+             * Source of the manifest
+             */
+            source?: "file" | "marketplace" | "sandbox";
         };
         namespace Responses {
             export interface $200 {
@@ -929,6 +1000,7 @@ export interface PathsDictionary {
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
+export type CallerIdentity = Components.Schemas.CallerIdentity;
 export type CommonImportFields = Components.Schemas.CommonImportFields;
 export type CommonManifestFields = Components.Schemas.CommonManifestFields;
 export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
@@ -942,6 +1014,7 @@ export type JobStatus = Components.Schemas.JobStatus;
 export type Manifest = Components.Schemas.Manifest;
 export type ManifestID = Components.Schemas.ManifestID;
 export type ManifestItem = Components.Schemas.ManifestItem;
+export type ManifestSource = Components.Schemas.ManifestSource;
 export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
 export type PlanChanges = Components.Schemas.PlanChanges;
 export type ResourceNode = Components.Schemas.ResourceNode;

package/dist/openapi.json

@@ -262,6 +262,16 @@
                             "$ref": "#/components/schemas/ManifestID"
                           }
                         ]
+                      },
+                      "source": {
+                        "allOf": [
+                          {
+                            "description": "Source of the manifest"
+                          },
+                          {
+                            "$ref": "#/components/schemas/ManifestSource"
+                          }
+                        ]
                       }
                     },
                     "required": [
@@ -286,6 +296,16 @@
                             "$ref": "#/components/schemas/ManifestID"
                           }
                         ]
+                      },
+                      "source": {
+                        "allOf": [
+                          {
+                            "description": "Source of the manifest"
+                          },
+                          {
+                            "$ref": "#/components/schemas/ManifestSource"
+                          }
+                        ]
                       }
                     },
                     "required": [
@@ -337,8 +357,11 @@
                 "type": "object",
                 "properties": {
                   "manifestFilePath": {
+                    "description": "This is no longer used",
                     "type": "string",
-                    "example": "example.tf"
+                    "example": "example.tf",
+                    "deprecated": true,
+                    "nullable": true
                   }
                 }
               }
@@ -473,6 +496,14 @@
         "description": "ID of an import or export job (state machine)",
         "example": "4854bb2a-94f9-424d-a968-3fb17fb0bf89"
       },
+      "ManifestSource": {
+        "type": "string",
+        "enum": [
+          "file",
+          "marketplace",
+          "sandbox"
+        ]
+      },
       "Manifest": {
         "allOf": [
           {
@@ -810,9 +841,20 @@
             "description": "Version of the blueprint (semver)",
             "example": "1.0.0"
           },
+          "source_blueprint_file": {
+            "type": "string",
+            "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"
+          },
           "is_verified": {
             "type": "boolean",
             "description": "Whether the manifest comes from a trusted source and is signed by epilot"
+          },
+          "created_by": {
+            "$ref": "#/components/schemas/CallerIdentity"
+          },
+          "updated_by": {
+            "$ref": "#/components/schemas/CallerIdentity"
           }
         }
       },
@@ -834,6 +876,9 @@
       "CommonImportFields": {
         "type": "object",
         "properties": {
+          "source_type": {
+            "$ref": "#/components/schemas/ManifestSource"
+          },
           "imported_resources": {
             "description": "An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import",
             "oneOf": [
@@ -937,6 +982,33 @@
             "$ref": "#/components/schemas/FormattedErrorData"
           }
         }
+      },
+      "CallerIdentity": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "description": "a human readable name of the caller (e.g. user name, token name or email address)",
+            "example": "manifest@epilot.cloud"
+          },
+          "org_id": {
+            "description": "epilot organization id",
+            "type": "string",
+            "example": "911690"
+          },
+          "user_id": {
+            "description": "epilot user id, when called by a user",
+            "type": "string",
+            "example": "11001045"
+          },
+          "token_id": {
+            "description": "token id, when called by API token",
+            "type": "string",
+            "example": "api_5ZugdRXasLfWBypHi93Fk"
+          }
+        },
+        "required": [
+          "org_id"
+        ]
       }
     },
     "parameters": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/blueprint-manifest-client",
-  "version": "2.5.4",
+  "version": "2.5.6",
   "description": "Client for epilot Terraform Blueprint Manifest API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
     "test": "jest",
     "bundle-definition": "webpack",
     "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
-    "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
+    "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprints-api/lambda/TerraformHandlerFunction/openapi.yml",
     "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
     "build": "tsc && npm run build:patch && npm run bundle-definition",
     "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",