@epilot/blueprint-manifest-client 2.5.1 → 2.5.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.
package/dist/openapi.d.ts CHANGED
@@ -112,6 +112,21 @@ declare namespace Components {
112
112
  */
113
113
  is_virtual?: boolean;
114
114
  }
115
+ export interface FormattedError {
116
+ error?: string | {
117
+ [key: string]: any;
118
+ };
119
+ code?: FormattedErrorCodes;
120
+ data?: FormattedErrorData;
121
+ }
122
+ 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";
123
+ export interface FormattedErrorData {
124
+ resource?: {
125
+ id?: string;
126
+ name?: string;
127
+ type?: string;
128
+ };
129
+ }
115
130
  export interface Job {
116
131
  job_id?: /**
117
132
  * ID of an import or export job (state machine)
@@ -146,6 +161,7 @@ declare namespace Components {
146
161
  * Whether the manifest comes from a trusted source and is signed by epilot
147
162
  */
148
163
  is_verified?: boolean;
164
+ errors?: FormattedError[];
149
165
  /**
150
166
  * An array of tree-like JSON objects or a singular tree-like JSON object representing the resources to import
151
167
  */
@@ -214,6 +230,12 @@ declare namespace Components {
214
230
  export type JobID = string;
215
231
  export type JobStatus = "PENDING" | "STARTED" | "WAITING_USER_ACTION" | "CANCELED" | "IN_PROGRESS" | "SUCCESS" | "FAILED";
216
232
  export interface Manifest {
233
+ import_job_id?: /**
234
+ * ID of an import or export job (state machine)
235
+ * example:
236
+ * 4854bb2a-94f9-424d-a968-3fb17fb0bf89
237
+ */
238
+ JobID;
217
239
  manifest_id?: /**
218
240
  * ID of an imported / installed manifest
219
241
  * example:
@@ -911,6 +933,9 @@ export type CommonImportFields = Components.Schemas.CommonImportFields;
911
933
  export type CommonManifestFields = Components.Schemas.CommonManifestFields;
912
934
  export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
913
935
  export type CommonResourceNode = Components.Schemas.CommonResourceNode;
936
+ export type FormattedError = Components.Schemas.FormattedError;
937
+ export type FormattedErrorCodes = Components.Schemas.FormattedErrorCodes;
938
+ export type FormattedErrorData = Components.Schemas.FormattedErrorData;
914
939
  export type Job = Components.Schemas.Job;
915
940
  export type JobID = Components.Schemas.JobID;
916
941
  export type JobStatus = Components.Schemas.JobStatus;
package/dist/openapi.json CHANGED
@@ -475,6 +475,14 @@
475
475
  },
476
476
  "Manifest": {
477
477
  "allOf": [
478
+ {
479
+ "type": "object",
480
+ "properties": {
481
+ "import_job_id": {
482
+ "$ref": "#/components/schemas/JobID"
483
+ }
484
+ }
485
+ },
478
486
  {
479
487
  "$ref": "#/components/schemas/CommonManifestFields"
480
488
  },
@@ -733,6 +741,12 @@
733
741
  "is_verified": {
734
742
  "type": "boolean",
735
743
  "description": "Whether the manifest comes from a trusted source and is signed by epilot"
744
+ },
745
+ "errors": {
746
+ "type": "array",
747
+ "items": {
748
+ "$ref": "#/components/schemas/FormattedError"
749
+ }
736
750
  }
737
751
  }
738
752
  },
@@ -868,6 +882,57 @@
868
882
  }
869
883
  }
870
884
  }
885
+ },
886
+ "FormattedErrorCodes": {
887
+ "type": "string",
888
+ "enum": [
889
+ "dependency_extraction",
890
+ "resource_not_found",
891
+ "resource_fetch_api_error",
892
+ "resource_fetch_unknown_error",
893
+ "terraform_cli_process_error",
894
+ "terraform_import_block_process_error"
895
+ ]
896
+ },
897
+ "FormattedErrorData": {
898
+ "type": "object",
899
+ "properties": {
900
+ "resource": {
901
+ "type": "object",
902
+ "properties": {
903
+ "id": {
904
+ "type": "string"
905
+ },
906
+ "name": {
907
+ "type": "string"
908
+ },
909
+ "type": {
910
+ "type": "string"
911
+ }
912
+ }
913
+ }
914
+ }
915
+ },
916
+ "FormattedError": {
917
+ "type": "object",
918
+ "properties": {
919
+ "error": {
920
+ "anyOf": [
921
+ {
922
+ "type": "string"
923
+ },
924
+ {
925
+ "type": "object"
926
+ }
927
+ ]
928
+ },
929
+ "code": {
930
+ "$ref": "#/components/schemas/FormattedErrorCodes"
931
+ },
932
+ "data": {
933
+ "$ref": "#/components/schemas/FormattedErrorData"
934
+ }
935
+ }
871
936
  }
872
937
  },
873
938
  "parameters": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/blueprint-manifest-client",
3
- "version": "2.5.1",
3
+ "version": "2.5.3",
4
4
  "description": "Client for epilot Terraform Blueprint Manifest API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -24,7 +24,7 @@
24
24
  "test": "jest",
25
25
  "bundle-definition": "webpack",
26
26
  "openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/blueprint-manifest.yaml",
27
- "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprint-manifest-api/lambda/TerraformHandlerFunction/openapi.yml",
27
+ "openapi:local": "node ../../scripts/update-openapi.js ../../../blueprints-api/lambda/TerraformHandlerFunction/openapi.yml",
28
28
  "typegen": "openapi typegen src/openapi.json --client -b '/* eslint-disable */' > src/openapi.d.ts",
29
29
  "build": "tsc && npm run build:patch && npm run bundle-definition",
30
30
  "build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",