@epilot/blueprint-manifest-client 3.9.0 → 4.0.0
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 +0 -5
- package/dist/openapi.d.ts +37 -22
- package/dist/openapi.json +83 -25
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
(()=>{"use strict";var e={
|
|
1
|
+
(()=>{"use strict";var e={330: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(466));t.default=s.default},466: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","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"responses":{}}},"/v1/blueprint-manifest/jobs:createExport":{"post":{"operationId":"createExport","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:exportManifest":{"post":{"operationId":"exportManifest","deprecated":true,"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","deprecated":true,"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/jobs/{job_id}:applyPlan":{"post":{"operationId":"applyPlan","deprecated":true,"parameters":[{"$ref":"#/components/parameters/JobID"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/blueprint-manifest/manifests":{"get":{"operationId":"listInstalledManifests","deprecated":true,"responses":{}}},"/v1/blueprint-manifest/manifests/{manifest_id}":{"get":{"operationId":"getManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"responses":{}},"put":{"operationId":"updateManifest","deprecated":true,"parameters":[{"in":"path","required":true,"name":"manifest_id"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteManifest","deprecated":true,"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/blueprints:marketplace":{"get":{"operationId":"listInstalledMarketplaceBlueprints","responses":{}}},"/v2/blueprint-manifest/blueprints:pre-install":{"post":{"operationId":"preInstallBlueprint","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"}],"requestBody":{"required":false,"content":{"application/json":{}}},"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}(330),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
|
@@ -185,6 +185,36 @@ declare namespace Components {
|
|
|
185
185
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
186
186
|
*/
|
|
187
187
|
export type BlueprintJobID = string;
|
|
188
|
+
/**
|
|
189
|
+
* Preview data for a blueprint before installation. Stored temporarily with TTL.
|
|
190
|
+
*/
|
|
191
|
+
export interface BlueprintPreview {
|
|
192
|
+
/**
|
|
193
|
+
* Unique preview ID
|
|
194
|
+
*/
|
|
195
|
+
id: string;
|
|
196
|
+
/**
|
|
197
|
+
* Organization ID
|
|
198
|
+
*/
|
|
199
|
+
org_id: string;
|
|
200
|
+
title: string;
|
|
201
|
+
description?: {
|
|
202
|
+
preinstall?: string;
|
|
203
|
+
};
|
|
204
|
+
version?: string;
|
|
205
|
+
slug?: string;
|
|
206
|
+
source_type: "marketplace" | "file";
|
|
207
|
+
/**
|
|
208
|
+
* S3 key of the blueprint zip file
|
|
209
|
+
*/
|
|
210
|
+
blueprint_file_s3_key: string;
|
|
211
|
+
is_verified: boolean;
|
|
212
|
+
docs_url?: string;
|
|
213
|
+
compatible_apps?: string[];
|
|
214
|
+
created_at: string; // date-time
|
|
215
|
+
created_by: CallerIdentity;
|
|
216
|
+
resources: BlueprintResource[];
|
|
217
|
+
}
|
|
188
218
|
export interface BlueprintResource {
|
|
189
219
|
id: /**
|
|
190
220
|
* ID of a blueprint resource
|
|
@@ -734,12 +764,6 @@ declare namespace Components {
|
|
|
734
764
|
* URL to install/update the blueprint from the marketplace
|
|
735
765
|
*/
|
|
736
766
|
installation_link?: string;
|
|
737
|
-
/**
|
|
738
|
-
* Localized slug of the blueprint from the epilot marketplace used to reconstruct the details page URL in the frontend
|
|
739
|
-
* example:
|
|
740
|
-
* solar-b2b-de
|
|
741
|
-
*/
|
|
742
|
-
localized_slug?: string;
|
|
743
767
|
}
|
|
744
768
|
export interface Job {
|
|
745
769
|
job_id?: /**
|
|
@@ -1312,25 +1336,19 @@ declare namespace Components {
|
|
|
1312
1336
|
*/
|
|
1313
1337
|
compatible_apps?: string[];
|
|
1314
1338
|
/**
|
|
1315
|
-
* Whether a newer version is available in the marketplace.
|
|
1339
|
+
* Whether a newer version is available in the marketplace.
|
|
1316
1340
|
*/
|
|
1317
1341
|
has_update_available?: boolean;
|
|
1318
1342
|
/**
|
|
1319
|
-
* The latest version available in the marketplace.
|
|
1343
|
+
* The latest version available in the marketplace.
|
|
1320
1344
|
* example:
|
|
1321
1345
|
* v2.0.0
|
|
1322
1346
|
*/
|
|
1323
1347
|
latest_marketplace_version?: string;
|
|
1324
1348
|
/**
|
|
1325
|
-
* URL to install/update the blueprint from the marketplace.
|
|
1349
|
+
* URL to install/update the blueprint from the marketplace.
|
|
1326
1350
|
*/
|
|
1327
1351
|
installation_link?: string;
|
|
1328
|
-
/**
|
|
1329
|
-
* Localized slug of the blueprint from the epilot marketplace used to reconstruct the details page URL in the frontend. Only present when include_marketplace_info=true.
|
|
1330
|
-
* example:
|
|
1331
|
-
* solar-b2b-de
|
|
1332
|
-
*/
|
|
1333
|
-
localized_slug?: string;
|
|
1334
1352
|
}
|
|
1335
1353
|
export type PlanChanges = ("create" | "update" | "internal-update" | "no-op" | "delete")[];
|
|
1336
1354
|
/**
|
|
@@ -1955,14 +1973,10 @@ declare namespace Paths {
|
|
|
1955
1973
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1956
1974
|
*/
|
|
1957
1975
|
Components.Schemas.BlueprintID;
|
|
1958
|
-
export type IncludeMarketplaceInfo = boolean;
|
|
1959
1976
|
}
|
|
1960
1977
|
export interface PathParameters {
|
|
1961
1978
|
blueprint_id: Parameters.BlueprintId;
|
|
1962
1979
|
}
|
|
1963
|
-
export interface QueryParameters {
|
|
1964
|
-
include_marketplace_info?: Parameters.IncludeMarketplaceInfo;
|
|
1965
|
-
}
|
|
1966
1980
|
namespace Responses {
|
|
1967
1981
|
export type $200 = Components.Schemas.Blueprint;
|
|
1968
1982
|
}
|
|
@@ -2124,7 +2138,7 @@ declare namespace Paths {
|
|
|
2124
2138
|
slug?: string;
|
|
2125
2139
|
}
|
|
2126
2140
|
namespace Responses {
|
|
2127
|
-
export type $200 = Components.Schemas.
|
|
2141
|
+
export type $200 = /* Preview data for a blueprint before installation. Stored temporarily with TTL. */ Components.Schemas.BlueprintPreview;
|
|
2128
2142
|
}
|
|
2129
2143
|
}
|
|
2130
2144
|
namespace SyncDependencies {
|
|
@@ -2397,7 +2411,7 @@ export interface OperationMethods {
|
|
|
2397
2411
|
* Get Blueprint by ID
|
|
2398
2412
|
*/
|
|
2399
2413
|
'getBlueprint'(
|
|
2400
|
-
parameters?: Parameters<Paths.GetBlueprint.
|
|
2414
|
+
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
2401
2415
|
data?: any,
|
|
2402
2416
|
config?: AxiosRequestConfig
|
|
2403
2417
|
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
@@ -2740,7 +2754,7 @@ export interface PathsDictionary {
|
|
|
2740
2754
|
* Get Blueprint by ID
|
|
2741
2755
|
*/
|
|
2742
2756
|
'get'(
|
|
2743
|
-
parameters?: Parameters<Paths.GetBlueprint.
|
|
2757
|
+
parameters?: Parameters<Paths.GetBlueprint.PathParameters> | null,
|
|
2744
2758
|
data?: any,
|
|
2745
2759
|
config?: AxiosRequestConfig
|
|
2746
2760
|
): OperationResponse<Paths.GetBlueprint.Responses.$200>
|
|
@@ -2920,6 +2934,7 @@ export type BlueprintInstallationJobOptions = Components.Schemas.BlueprintInstal
|
|
|
2920
2934
|
export type BlueprintJob = Components.Schemas.BlueprintJob;
|
|
2921
2935
|
export type BlueprintJobEvent = Components.Schemas.BlueprintJobEvent;
|
|
2922
2936
|
export type BlueprintJobID = Components.Schemas.BlueprintJobID;
|
|
2937
|
+
export type BlueprintPreview = Components.Schemas.BlueprintPreview;
|
|
2923
2938
|
export type BlueprintResource = Components.Schemas.BlueprintResource;
|
|
2924
2939
|
export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
|
|
2925
2940
|
export type CallerIdentity = Components.Schemas.CallerIdentity;
|
package/dist/openapi.json
CHANGED
|
@@ -829,11 +829,11 @@
|
|
|
829
829
|
},
|
|
830
830
|
"responses": {
|
|
831
831
|
"200": {
|
|
832
|
-
"description": "
|
|
832
|
+
"description": "Blueprint preview data for UI display",
|
|
833
833
|
"content": {
|
|
834
834
|
"application/json": {
|
|
835
835
|
"schema": {
|
|
836
|
-
"$ref": "#/components/schemas/
|
|
836
|
+
"$ref": "#/components/schemas/BlueprintPreview"
|
|
837
837
|
}
|
|
838
838
|
}
|
|
839
839
|
}
|
|
@@ -947,16 +947,6 @@
|
|
|
947
947
|
"schema": {
|
|
948
948
|
"$ref": "#/components/schemas/BlueprintID"
|
|
949
949
|
}
|
|
950
|
-
},
|
|
951
|
-
{
|
|
952
|
-
"in": "query",
|
|
953
|
-
"name": "include_marketplace_info",
|
|
954
|
-
"required": false,
|
|
955
|
-
"schema": {
|
|
956
|
-
"type": "boolean",
|
|
957
|
-
"default": false
|
|
958
|
-
},
|
|
959
|
-
"description": "When true and the blueprint is a marketplace blueprint, includes marketplace CMS item info fields (has_update_available, latest_marketplace_version, installation_link)"
|
|
960
950
|
}
|
|
961
951
|
],
|
|
962
952
|
"responses": {
|
|
@@ -1793,6 +1783,84 @@
|
|
|
1793
1783
|
"type"
|
|
1794
1784
|
]
|
|
1795
1785
|
},
|
|
1786
|
+
"BlueprintPreview": {
|
|
1787
|
+
"type": "object",
|
|
1788
|
+
"description": "Preview data for a blueprint before installation. Stored temporarily with TTL.",
|
|
1789
|
+
"properties": {
|
|
1790
|
+
"id": {
|
|
1791
|
+
"type": "string",
|
|
1792
|
+
"description": "Unique preview ID"
|
|
1793
|
+
},
|
|
1794
|
+
"org_id": {
|
|
1795
|
+
"type": "string",
|
|
1796
|
+
"description": "Organization ID"
|
|
1797
|
+
},
|
|
1798
|
+
"title": {
|
|
1799
|
+
"type": "string"
|
|
1800
|
+
},
|
|
1801
|
+
"description": {
|
|
1802
|
+
"type": "object",
|
|
1803
|
+
"properties": {
|
|
1804
|
+
"preinstall": {
|
|
1805
|
+
"type": "string"
|
|
1806
|
+
}
|
|
1807
|
+
}
|
|
1808
|
+
},
|
|
1809
|
+
"version": {
|
|
1810
|
+
"type": "string"
|
|
1811
|
+
},
|
|
1812
|
+
"slug": {
|
|
1813
|
+
"type": "string"
|
|
1814
|
+
},
|
|
1815
|
+
"source_type": {
|
|
1816
|
+
"type": "string",
|
|
1817
|
+
"enum": [
|
|
1818
|
+
"marketplace",
|
|
1819
|
+
"file"
|
|
1820
|
+
]
|
|
1821
|
+
},
|
|
1822
|
+
"blueprint_file_s3_key": {
|
|
1823
|
+
"type": "string",
|
|
1824
|
+
"description": "S3 key of the blueprint zip file"
|
|
1825
|
+
},
|
|
1826
|
+
"is_verified": {
|
|
1827
|
+
"type": "boolean"
|
|
1828
|
+
},
|
|
1829
|
+
"docs_url": {
|
|
1830
|
+
"type": "string"
|
|
1831
|
+
},
|
|
1832
|
+
"compatible_apps": {
|
|
1833
|
+
"type": "array",
|
|
1834
|
+
"items": {
|
|
1835
|
+
"type": "string"
|
|
1836
|
+
}
|
|
1837
|
+
},
|
|
1838
|
+
"created_at": {
|
|
1839
|
+
"type": "string",
|
|
1840
|
+
"format": "date-time"
|
|
1841
|
+
},
|
|
1842
|
+
"created_by": {
|
|
1843
|
+
"$ref": "#/components/schemas/CallerIdentity"
|
|
1844
|
+
},
|
|
1845
|
+
"resources": {
|
|
1846
|
+
"type": "array",
|
|
1847
|
+
"items": {
|
|
1848
|
+
"$ref": "#/components/schemas/BlueprintResource"
|
|
1849
|
+
}
|
|
1850
|
+
}
|
|
1851
|
+
},
|
|
1852
|
+
"required": [
|
|
1853
|
+
"id",
|
|
1854
|
+
"org_id",
|
|
1855
|
+
"title",
|
|
1856
|
+
"source_type",
|
|
1857
|
+
"blueprint_file_s3_key",
|
|
1858
|
+
"is_verified",
|
|
1859
|
+
"created_at",
|
|
1860
|
+
"created_by",
|
|
1861
|
+
"resources"
|
|
1862
|
+
]
|
|
1863
|
+
},
|
|
1796
1864
|
"CustomBlueprint": {
|
|
1797
1865
|
"allOf": [
|
|
1798
1866
|
{
|
|
@@ -1874,21 +1942,16 @@
|
|
|
1874
1942
|
},
|
|
1875
1943
|
"has_update_available": {
|
|
1876
1944
|
"type": "boolean",
|
|
1877
|
-
"description": "Whether a newer version is available in the marketplace.
|
|
1945
|
+
"description": "Whether a newer version is available in the marketplace."
|
|
1878
1946
|
},
|
|
1879
1947
|
"latest_marketplace_version": {
|
|
1880
1948
|
"type": "string",
|
|
1881
|
-
"description": "The latest version available in the marketplace.
|
|
1949
|
+
"description": "The latest version available in the marketplace.",
|
|
1882
1950
|
"example": "v2.0.0"
|
|
1883
1951
|
},
|
|
1884
1952
|
"installation_link": {
|
|
1885
1953
|
"type": "string",
|
|
1886
|
-
"description": "URL to install/update the blueprint from the marketplace.
|
|
1887
|
-
},
|
|
1888
|
-
"localized_slug": {
|
|
1889
|
-
"type": "string",
|
|
1890
|
-
"description": "Localized slug of the blueprint from the epilot marketplace used to reconstruct the details page URL in the frontend. Only present when include_marketplace_info=true.",
|
|
1891
|
-
"example": "solar-b2b-de"
|
|
1954
|
+
"description": "URL to install/update the blueprint from the marketplace."
|
|
1892
1955
|
}
|
|
1893
1956
|
}
|
|
1894
1957
|
}
|
|
@@ -1941,11 +2004,6 @@
|
|
|
1941
2004
|
"installation_link": {
|
|
1942
2005
|
"type": "string",
|
|
1943
2006
|
"description": "URL to install/update the blueprint from the marketplace"
|
|
1944
|
-
},
|
|
1945
|
-
"localized_slug": {
|
|
1946
|
-
"type": "string",
|
|
1947
|
-
"description": "Localized slug of the blueprint from the epilot marketplace used to reconstruct the details page URL in the frontend",
|
|
1948
|
-
"example": "solar-b2b-de"
|
|
1949
2007
|
}
|
|
1950
2008
|
},
|
|
1951
2009
|
"required": [
|