@epilot/blueprint-manifest-client 3.0.3 → 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.d.ts +32 -4
- package/dist/openapi.json +36 -0
- 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
|
@@ -180,7 +180,11 @@ declare namespace Components {
|
|
|
180
180
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
181
181
|
*/
|
|
182
182
|
BlueprintResourceID[];
|
|
183
|
-
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[];
|
|
184
188
|
}
|
|
185
189
|
/**
|
|
186
190
|
* ID of a blueprint resource
|
|
@@ -299,6 +303,7 @@ declare namespace Components {
|
|
|
299
303
|
* 1.0.0
|
|
300
304
|
*/
|
|
301
305
|
source_blueprint_version?: string;
|
|
306
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
302
307
|
/**
|
|
303
308
|
* A URL to download the source blueprint file used to import the blueprint
|
|
304
309
|
* example:
|
|
@@ -655,6 +660,7 @@ declare namespace Components {
|
|
|
655
660
|
* 1.0.0
|
|
656
661
|
*/
|
|
657
662
|
source_blueprint_version?: string;
|
|
663
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
658
664
|
/**
|
|
659
665
|
* A URL to download the source blueprint file used to import the blueprint
|
|
660
666
|
* example:
|
|
@@ -777,6 +783,7 @@ declare namespace Components {
|
|
|
777
783
|
* 1.0.0
|
|
778
784
|
*/
|
|
779
785
|
source_blueprint_version?: string;
|
|
786
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
780
787
|
/**
|
|
781
788
|
* A URL to download the source blueprint file used to import the blueprint
|
|
782
789
|
* example:
|
|
@@ -932,6 +939,7 @@ declare namespace Components {
|
|
|
932
939
|
* 1.0.0
|
|
933
940
|
*/
|
|
934
941
|
source_blueprint_version?: string;
|
|
942
|
+
pre_install_requirements?: /* List of pre-installation requirements for the blueprint */ PreInstallRequirements;
|
|
935
943
|
/**
|
|
936
944
|
* A URL to download the source blueprint file used to import the blueprint
|
|
937
945
|
* example:
|
|
@@ -1073,7 +1081,28 @@ declare namespace Components {
|
|
|
1073
1081
|
source_type: "marketplace";
|
|
1074
1082
|
resources?: BlueprintResource[];
|
|
1075
1083
|
}
|
|
1076
|
-
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
|
+
}[];
|
|
1077
1106
|
export interface PutManifestPayload {
|
|
1078
1107
|
/**
|
|
1079
1108
|
* Name of the source blueprint
|
|
@@ -1902,7 +1931,6 @@ declare namespace Paths {
|
|
|
1902
1931
|
}
|
|
1903
1932
|
}
|
|
1904
1933
|
|
|
1905
|
-
|
|
1906
1934
|
export interface OperationMethods {
|
|
1907
1935
|
/**
|
|
1908
1936
|
* getJob - getJob
|
|
@@ -2537,7 +2565,6 @@ export interface PathsDictionary {
|
|
|
2537
2565
|
|
|
2538
2566
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
2539
2567
|
|
|
2540
|
-
|
|
2541
2568
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
2542
2569
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
2543
2570
|
export type BlueprintExportJob = Components.Schemas.BlueprintExportJob;
|
|
@@ -2573,6 +2600,7 @@ export type ManifestSource = Components.Schemas.ManifestSource;
|
|
|
2573
2600
|
export type ManifestTimestampFields = Components.Schemas.ManifestTimestampFields;
|
|
2574
2601
|
export type MarketplaceBlueprint = Components.Schemas.MarketplaceBlueprint;
|
|
2575
2602
|
export type PlanChanges = Components.Schemas.PlanChanges;
|
|
2603
|
+
export type PreInstallRequirements = Components.Schemas.PreInstallRequirements;
|
|
2576
2604
|
export type PutManifestPayload = Components.Schemas.PutManifestPayload;
|
|
2577
2605
|
export type ResourceNode = Components.Schemas.ResourceNode;
|
|
2578
2606
|
export type ResourceNodeType = Components.Schemas.ResourceNodeType;
|
package/dist/openapi.json
CHANGED
|
@@ -1595,10 +1595,18 @@
|
|
|
1595
1595
|
"enum": [
|
|
1596
1596
|
"create",
|
|
1597
1597
|
"update",
|
|
1598
|
+
"internal-update",
|
|
1598
1599
|
"no-op",
|
|
1599
1600
|
"delete"
|
|
1600
1601
|
]
|
|
1601
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
|
+
}
|
|
1602
1610
|
}
|
|
1603
1611
|
},
|
|
1604
1612
|
"required": [
|
|
@@ -2033,6 +2041,7 @@
|
|
|
2033
2041
|
"enum": [
|
|
2034
2042
|
"create",
|
|
2035
2043
|
"update",
|
|
2044
|
+
"internal-update",
|
|
2036
2045
|
"no-op",
|
|
2037
2046
|
"delete"
|
|
2038
2047
|
]
|
|
@@ -2305,6 +2314,9 @@
|
|
|
2305
2314
|
"description": "Version of the blueprint (semver)",
|
|
2306
2315
|
"example": "1.0.0"
|
|
2307
2316
|
},
|
|
2317
|
+
"pre_install_requirements": {
|
|
2318
|
+
"$ref": "#/components/schemas/PreInstallRequirements"
|
|
2319
|
+
},
|
|
2308
2320
|
"source_blueprint_file": {
|
|
2309
2321
|
"type": "string",
|
|
2310
2322
|
"deprecated": true,
|
|
@@ -2478,6 +2490,30 @@
|
|
|
2478
2490
|
}
|
|
2479
2491
|
}
|
|
2480
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
|
+
},
|
|
2481
2517
|
"BlueprintInstallStatus": {
|
|
2482
2518
|
"type": "string",
|
|
2483
2519
|
"enum": [
|