@epilot/blueprint-manifest-client 3.0.2 → 3.0.4
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/definition.js +1 -1
- package/dist/openapi-runtime.json +1 -0
- package/dist/openapi.d.ts +45 -5
- package/dist/openapi.json +48 -1
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={914:function(e,t,r){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=n(r(240));t.default=s.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.1.0","info":{"title":"","version":""},"servers":[{"url":"https://blueprint-manifest.sls.epilot.io"}],"paths":{"/v1/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getJob","parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest:uploadManifest":{"post":{"operationId":"uploadManifest","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs:createPlan":{"post":{"operationId":"createPlan","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints":{"get":{"operationId":"listBlueprints","responses":{}},"post":{"operationId":"createBlueprint","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprint:install":{"post":{"operationId":"installBlueprint","requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}":{"get":{"operationId":"getBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}},"put":{"operationId":"updateBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}:export":{"post":{"operationId":"exportBlueprint","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources":{"post":{"operationId":"addBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies":{"post":{"operationId":"syncDependencies","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/bulk":{"post":{"operationId":"bulkAddBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"query","name":"add_dependencies"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"put":{"operationId":"bulkUpdateBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"bulkDeleteBlueprintResources","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources/{resource_id}":{"put":{"operationId":"updateBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteBlueprintResource","parameters":[{"in":"path","required":true,"name":"blueprint_id"},{"in":"path","required":true,"name":"resource_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs":{"get":{"operationId":"listBlueprintJobs","responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}":{"get":{"operationId":"getBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:continue":{"post":{"operationId":"continueInstallationJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"requestBody":{"required":false,"content":{"application/json":{}}},"responses":{}}},"/v2/blueprint-manifest/jobs/{job_id}:cancel":{"post":{"operationId":"cancelBlueprintJob","parameters":[{"in":"path","required":true,"name":"job_id"}],"responses":{}}}},"components":{"parameters":{"JobID":{"name":"job_id","in":"path","required":true}}}}')}},t={},r=function r(n){var s=t[n];if(void 0!==s)return s.exports;var i=t[n]={exports:{}};return e[n].call(i.exports,i,i.exports,r),i.exports}(914),n=exports;for(var s in r)n[s]=r[s];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
package/dist/openapi.d.ts
CHANGED
|
@@ -127,7 +127,19 @@ declare namespace Components {
|
|
|
127
127
|
errors?: FormattedError[];
|
|
128
128
|
level?: "info" | "warning" | "error";
|
|
129
129
|
data?: {
|
|
130
|
-
|
|
130
|
+
installed_blueprint_id?: /**
|
|
131
|
+
* ID of a blueprint
|
|
132
|
+
* example:
|
|
133
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
134
|
+
*/
|
|
135
|
+
BlueprintID;
|
|
136
|
+
export_job_id?: /**
|
|
137
|
+
* ID of a job
|
|
138
|
+
* example:
|
|
139
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
140
|
+
*/
|
|
141
|
+
BlueprintJobID;
|
|
142
|
+
resources?: number;
|
|
131
143
|
};
|
|
132
144
|
}
|
|
133
145
|
/**
|
|
@@ -168,7 +180,11 @@ declare namespace Components {
|
|
|
168
180
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
169
181
|
*/
|
|
170
182
|
BlueprintResourceID[];
|
|
171
|
-
impact_on_install?: ("create" | "update" | "no-op" | "delete")[];
|
|
183
|
+
impact_on_install?: ("create" | "update" | "internal-update" | "no-op" | "delete")[];
|
|
184
|
+
/**
|
|
185
|
+
* Fields causing the updates / internal updates on a resource install
|
|
186
|
+
*/
|
|
187
|
+
impact_on_install_reason?: string[];
|
|
172
188
|
}
|
|
173
189
|
/**
|
|
174
190
|
* ID of a blueprint resource
|
|
@@ -287,6 +303,7 @@ declare namespace Components {
|
|
|
287
303
|
* 1.0.0
|
|
288
304
|
*/
|
|
289
305
|
source_blueprint_version?: string;
|
|
306
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
290
307
|
/**
|
|
291
308
|
* A URL to download the source blueprint file used to import the blueprint
|
|
292
309
|
* example:
|
|
@@ -643,6 +660,7 @@ declare namespace Components {
|
|
|
643
660
|
* 1.0.0
|
|
644
661
|
*/
|
|
645
662
|
source_blueprint_version?: string;
|
|
663
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
646
664
|
/**
|
|
647
665
|
* A URL to download the source blueprint file used to import the blueprint
|
|
648
666
|
* example:
|
|
@@ -765,6 +783,7 @@ declare namespace Components {
|
|
|
765
783
|
* 1.0.0
|
|
766
784
|
*/
|
|
767
785
|
source_blueprint_version?: string;
|
|
786
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
768
787
|
/**
|
|
769
788
|
* A URL to download the source blueprint file used to import the blueprint
|
|
770
789
|
* example:
|
|
@@ -920,6 +939,7 @@ declare namespace Components {
|
|
|
920
939
|
* 1.0.0
|
|
921
940
|
*/
|
|
922
941
|
source_blueprint_version?: string;
|
|
942
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
923
943
|
/**
|
|
924
944
|
* A URL to download the source blueprint file used to import the blueprint
|
|
925
945
|
* example:
|
|
@@ -1061,7 +1081,28 @@ declare namespace Components {
|
|
|
1061
1081
|
source_type: "marketplace";
|
|
1062
1082
|
resources?: BlueprintResource[];
|
|
1063
1083
|
}
|
|
1064
|
-
export type PlanChanges = ("create" | "update" | "no-op" | "delete")[];
|
|
1084
|
+
export type PlanChanges = ("create" | "update" | "internal-update" | "no-op" | "delete")[];
|
|
1085
|
+
/**
|
|
1086
|
+
* List of pre-installation requirements for the blueprint
|
|
1087
|
+
*/
|
|
1088
|
+
export type PreInstallRequirements = {
|
|
1089
|
+
/**
|
|
1090
|
+
* Requirement Name
|
|
1091
|
+
* example:
|
|
1092
|
+
* billing_enabled
|
|
1093
|
+
*/
|
|
1094
|
+
name?: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* Human-readable description of the requirement
|
|
1097
|
+
* example:
|
|
1098
|
+
* Billing must be enabled in your epilot organization
|
|
1099
|
+
*/
|
|
1100
|
+
description?: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* Whether this requirement has been completed
|
|
1103
|
+
*/
|
|
1104
|
+
completed?: boolean;
|
|
1105
|
+
}[];
|
|
1065
1106
|
export interface PutManifestPayload {
|
|
1066
1107
|
/**
|
|
1067
1108
|
* Name of the source blueprint
|
|
@@ -1890,7 +1931,6 @@ declare namespace Paths {
|
|
|
1890
1931
|
}
|
|
1891
1932
|
}
|
|
1892
1933
|
|
|
1893
|
-
|
|
1894
1934
|
export interface OperationMethods {
|
|
1895
1935
|
/**
|
|
1896
1936
|
* getJob - getJob
|
|
@@ -2525,7 +2565,6 @@ export interface PathsDictionary {
|
|
|
2525
2565
|
|
|
2526
2566
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2527
2567
|
|
|
2528
|
-
|
|
2529
2568
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2530
2569
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
2531
2570
|
export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
@@ -2561,6 +2600,7 @@ export type ManifestSource = Components.Schemas.ManifestSource;
|
|
|
2561
2600
|
export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
|
|
2562
2601
|
export type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
|
|
2563
2602
|
export type PlanChanges = Components.Schemas.PlanChanges;
|
|
2603
|
+
export type PreInstallRequirements = Components.Schemas.PreInstallRequirements;
|
|
2564
2604
|
export type PutManifestPayload = Components.Schemas.PutManifestPayload;
|
|
2565
2605
|
export type ResourceNode = Components.Schemas.ResourceNode;
|
|
2566
2606
|
export type ResourceNodeType = Components.Schemas.ResourceNodeType;
|
package/dist/openapi.json
CHANGED
|
@@ -1424,6 +1424,7 @@
|
|
|
1424
1424
|
}
|
|
1425
1425
|
],
|
|
1426
1426
|
"requestBody": {
|
|
1427
|
+
"required": false,
|
|
1427
1428
|
"content": {
|
|
1428
1429
|
"application/json": {
|
|
1429
1430
|
"schema": {
|
|
@@ -1594,10 +1595,18 @@
|
|
|
1594
1595
|
"enum": [
|
|
1595
1596
|
"create",
|
|
1596
1597
|
"update",
|
|
1598
|
+
"internal-update",
|
|
1597
1599
|
"no-op",
|
|
1598
1600
|
"delete"
|
|
1599
1601
|
]
|
|
1600
1602
|
}
|
|
1603
|
+
},
|
|
1604
|
+
"impact_on_install_reason": {
|
|
1605
|
+
"type": "array",
|
|
1606
|
+
"description": "Fields causing the updates / internal updates on a resource install",
|
|
1607
|
+
"items": {
|
|
1608
|
+
"type": "string"
|
|
1609
|
+
}
|
|
1601
1610
|
}
|
|
1602
1611
|
},
|
|
1603
1612
|
"required": [
|
|
@@ -1889,7 +1898,17 @@
|
|
|
1889
1898
|
},
|
|
1890
1899
|
"data": {
|
|
1891
1900
|
"type": "object",
|
|
1892
|
-
"
|
|
1901
|
+
"properties": {
|
|
1902
|
+
"installed_blueprint_id": {
|
|
1903
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
1904
|
+
},
|
|
1905
|
+
"export_job_id": {
|
|
1906
|
+
"$ref": "#/components/schemas/BlueprintJobID"
|
|
1907
|
+
},
|
|
1908
|
+
"resources": {
|
|
1909
|
+
"type": "number"
|
|
1910
|
+
}
|
|
1911
|
+
}
|
|
1893
1912
|
}
|
|
1894
1913
|
}
|
|
1895
1914
|
},
|
|
@@ -2022,6 +2041,7 @@
|
|
|
2022
2041
|
"enum": [
|
|
2023
2042
|
"create",
|
|
2024
2043
|
"update",
|
|
2044
|
+
"internal-update",
|
|
2025
2045
|
"no-op",
|
|
2026
2046
|
"delete"
|
|
2027
2047
|
]
|
|
@@ -2294,6 +2314,9 @@
|
|
|
2294
2314
|
"description": "Version of the blueprint (semver)",
|
|
2295
2315
|
"example": "1.0.0"
|
|
2296
2316
|
},
|
|
2317
|
+
"pre_install_requirements": {
|
|
2318
|
+
"$ref": "#/components/schemas/PreInstallRequirements"
|
|
2319
|
+
},
|
|
2297
2320
|
"source_blueprint_file": {
|
|
2298
2321
|
"type": "string",
|
|
2299
2322
|
"deprecated": true,
|
|
@@ -2467,6 +2490,30 @@
|
|
|
2467
2490
|
}
|
|
2468
2491
|
}
|
|
2469
2492
|
},
|
|
2493
|
+
"PreInstallRequirements": {
|
|
2494
|
+
"type": "array",
|
|
2495
|
+
"description": "List of pre-installation requirements for the blueprint",
|
|
2496
|
+
"items": {
|
|
2497
|
+
"type": "object",
|
|
2498
|
+
"properties": {
|
|
2499
|
+
"name": {
|
|
2500
|
+
"type": "string",
|
|
2501
|
+
"description": "Requirement Name",
|
|
2502
|
+
"example": "billing_enabled"
|
|
2503
|
+
},
|
|
2504
|
+
"description": {
|
|
2505
|
+
"type": "string",
|
|
2506
|
+
"description": "Human-readable description of the requirement",
|
|
2507
|
+
"example": "Billing must be enabled in your epilot organization"
|
|
2508
|
+
},
|
|
2509
|
+
"completed": {
|
|
2510
|
+
"type": "boolean",
|
|
2511
|
+
"description": "Whether this requirement has been completed",
|
|
2512
|
+
"default": false
|
|
2513
|
+
}
|
|
2514
|
+
}
|
|
2515
|
+
}
|
|
2516
|
+
},
|
|
2470
2517
|
"BlueprintInstallStatus": {
|
|
2471
2518
|
"type": "string",
|
|
2472
2519
|
"enum": [
|