@epilot/blueprint-manifest-client 4.3.6 → 4.5.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 +19 -6
- package/dist/openapi.d.ts +195 -53
- package/dist/openapi.json +92 -57
- package/package.json +2 -2
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 i=n(r(466));t.default=i.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","parameters":[{"name":"archived","in":"query","required":false}],"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/blueprints:preview/{preview_id}":{"get":{"operationId":"getBlueprintPreview","parameters":[{"in":"path","required":true,"name":"preview_id"}],"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}/validate":{"post":{"operationId":"validateBlueprint","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}:format-description":{"post":{"operationId":"formatBlueprintDescription","parameters":[{"in":"path","required":true,"name":"blueprint_id"}],"requestBody":{"required":true,"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 i=t[n];if(void 0!==i)return i.exports;var s=t[n]={exports:{}};return e[n].call(s.exports,s,s.exports,r),s.exports}(330),n=exports;for(var i in r)n[i]=r[i];r.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
|
|
@@ -277,6 +277,25 @@
|
|
|
277
277
|
"responses": {}
|
|
278
278
|
}
|
|
279
279
|
},
|
|
280
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}:format-description": {
|
|
281
|
+
"post": {
|
|
282
|
+
"operationId": "formatBlueprintDescription",
|
|
283
|
+
"parameters": [
|
|
284
|
+
{
|
|
285
|
+
"in": "path",
|
|
286
|
+
"required": true,
|
|
287
|
+
"name": "blueprint_id"
|
|
288
|
+
}
|
|
289
|
+
],
|
|
290
|
+
"requestBody": {
|
|
291
|
+
"required": true,
|
|
292
|
+
"content": {
|
|
293
|
+
"application/json": {}
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"responses": {}
|
|
297
|
+
}
|
|
298
|
+
},
|
|
280
299
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
281
300
|
"post": {
|
|
282
301
|
"operationId": "addBlueprintResource",
|
|
@@ -299,12 +318,6 @@
|
|
|
299
318
|
"responses": {}
|
|
300
319
|
}
|
|
301
320
|
},
|
|
302
|
-
"/v2/blueprint-manifest/dependency-tree": {
|
|
303
|
-
"get": {
|
|
304
|
-
"operationId": "getDependencyTree",
|
|
305
|
-
"responses": {}
|
|
306
|
-
}
|
|
307
|
-
},
|
|
308
321
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies": {
|
|
309
322
|
"post": {
|
|
310
323
|
"operationId": "syncDependencies",
|
package/dist/openapi.d.ts
CHANGED
|
@@ -79,7 +79,31 @@ declare namespace Components {
|
|
|
79
79
|
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
80
80
|
*/
|
|
81
81
|
archived?: boolean;
|
|
82
|
-
|
|
82
|
+
/**
|
|
83
|
+
* URL to the blueprint documentation
|
|
84
|
+
*/
|
|
85
|
+
docs_url?: string;
|
|
86
|
+
/**
|
|
87
|
+
* List of compatible app IDs for the blueprint
|
|
88
|
+
*/
|
|
89
|
+
compatible_apps?: string[];
|
|
90
|
+
/**
|
|
91
|
+
* Feature constraints for blueprint installation
|
|
92
|
+
*/
|
|
93
|
+
required_features?: {
|
|
94
|
+
/**
|
|
95
|
+
* Features that must be enabled in the target org
|
|
96
|
+
*/
|
|
97
|
+
enabled?: string[];
|
|
98
|
+
/**
|
|
99
|
+
* Features that must be disabled in the target org
|
|
100
|
+
*/
|
|
101
|
+
disabled?: string[];
|
|
102
|
+
};
|
|
103
|
+
/**
|
|
104
|
+
* Custom name for the exported zip file
|
|
105
|
+
*/
|
|
106
|
+
zip_file_name?: string;
|
|
83
107
|
source_type: "app";
|
|
84
108
|
resources?: BlueprintResource[];
|
|
85
109
|
}
|
|
@@ -394,9 +418,30 @@ declare namespace Components {
|
|
|
394
418
|
*/
|
|
395
419
|
archived?: boolean;
|
|
396
420
|
/**
|
|
397
|
-
*
|
|
421
|
+
* URL to the blueprint documentation
|
|
398
422
|
*/
|
|
399
|
-
|
|
423
|
+
docs_url?: string;
|
|
424
|
+
/**
|
|
425
|
+
* List of compatible app IDs for the blueprint
|
|
426
|
+
*/
|
|
427
|
+
compatible_apps?: string[];
|
|
428
|
+
/**
|
|
429
|
+
* Feature constraints for blueprint installation
|
|
430
|
+
*/
|
|
431
|
+
required_features?: {
|
|
432
|
+
/**
|
|
433
|
+
* Features that must be enabled in the target org
|
|
434
|
+
*/
|
|
435
|
+
enabled?: string[];
|
|
436
|
+
/**
|
|
437
|
+
* Features that must be disabled in the target org
|
|
438
|
+
*/
|
|
439
|
+
disabled?: string[];
|
|
440
|
+
};
|
|
441
|
+
/**
|
|
442
|
+
* Custom name for the exported zip file
|
|
443
|
+
*/
|
|
444
|
+
zip_file_name?: string;
|
|
400
445
|
}
|
|
401
446
|
export interface CommonBlueprintJobFields {
|
|
402
447
|
id?: /**
|
|
@@ -642,25 +687,34 @@ declare namespace Components {
|
|
|
642
687
|
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
643
688
|
*/
|
|
644
689
|
archived?: boolean;
|
|
645
|
-
|
|
690
|
+
/**
|
|
691
|
+
* URL to the blueprint documentation
|
|
692
|
+
*/
|
|
693
|
+
docs_url?: string;
|
|
694
|
+
/**
|
|
695
|
+
* List of compatible app IDs for the blueprint
|
|
696
|
+
*/
|
|
697
|
+
compatible_apps?: string[];
|
|
698
|
+
/**
|
|
699
|
+
* Feature constraints for blueprint installation
|
|
700
|
+
*/
|
|
701
|
+
required_features?: {
|
|
702
|
+
/**
|
|
703
|
+
* Features that must be enabled in the target org
|
|
704
|
+
*/
|
|
705
|
+
enabled?: string[];
|
|
706
|
+
/**
|
|
707
|
+
* Features that must be disabled in the target org
|
|
708
|
+
*/
|
|
709
|
+
disabled?: string[];
|
|
710
|
+
};
|
|
711
|
+
/**
|
|
712
|
+
* Custom name for the exported zip file
|
|
713
|
+
*/
|
|
714
|
+
zip_file_name?: string;
|
|
646
715
|
resources?: BlueprintResource[];
|
|
647
716
|
source_type: "custom";
|
|
648
717
|
}
|
|
649
|
-
/**
|
|
650
|
-
* The default resource dependency tree. Keys are resource types, values describe their dependencies.
|
|
651
|
-
*/
|
|
652
|
-
export interface DependencyTree {
|
|
653
|
-
[name: string]: {
|
|
654
|
-
dependencies?: /* Type of the resource */ ResourceNodeType[];
|
|
655
|
-
rootOnlyDependencies?: /* Type of the resource */ ResourceNodeType[];
|
|
656
|
-
};
|
|
657
|
-
}
|
|
658
|
-
/**
|
|
659
|
-
* Custom dependency tree override. Keys are resource types, values are arrays of allowed dependency types.
|
|
660
|
-
*/
|
|
661
|
-
export interface DependencyTreeOverride {
|
|
662
|
-
[name: string]: /* Type of the resource */ ResourceNodeType[];
|
|
663
|
-
}
|
|
664
718
|
export interface DeployedBlueprint {
|
|
665
719
|
id?: /**
|
|
666
720
|
* ID of a blueprint
|
|
@@ -719,7 +773,31 @@ declare namespace Components {
|
|
|
719
773
|
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
720
774
|
*/
|
|
721
775
|
archived?: boolean;
|
|
722
|
-
|
|
776
|
+
/**
|
|
777
|
+
* URL to the blueprint documentation
|
|
778
|
+
*/
|
|
779
|
+
docs_url?: string;
|
|
780
|
+
/**
|
|
781
|
+
* List of compatible app IDs for the blueprint
|
|
782
|
+
*/
|
|
783
|
+
compatible_apps?: string[];
|
|
784
|
+
/**
|
|
785
|
+
* Feature constraints for blueprint installation
|
|
786
|
+
*/
|
|
787
|
+
required_features?: {
|
|
788
|
+
/**
|
|
789
|
+
* Features that must be enabled in the target org
|
|
790
|
+
*/
|
|
791
|
+
enabled?: string[];
|
|
792
|
+
/**
|
|
793
|
+
* Features that must be disabled in the target org
|
|
794
|
+
*/
|
|
795
|
+
disabled?: string[];
|
|
796
|
+
};
|
|
797
|
+
/**
|
|
798
|
+
* Custom name for the exported zip file
|
|
799
|
+
*/
|
|
800
|
+
zip_file_name?: string;
|
|
723
801
|
source_type: "deploy";
|
|
724
802
|
resources?: BlueprintResource[];
|
|
725
803
|
}
|
|
@@ -781,7 +859,31 @@ declare namespace Components {
|
|
|
781
859
|
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
782
860
|
*/
|
|
783
861
|
archived?: boolean;
|
|
784
|
-
|
|
862
|
+
/**
|
|
863
|
+
* URL to the blueprint documentation
|
|
864
|
+
*/
|
|
865
|
+
docs_url?: string;
|
|
866
|
+
/**
|
|
867
|
+
* List of compatible app IDs for the blueprint
|
|
868
|
+
*/
|
|
869
|
+
compatible_apps?: string[];
|
|
870
|
+
/**
|
|
871
|
+
* Feature constraints for blueprint installation
|
|
872
|
+
*/
|
|
873
|
+
required_features?: {
|
|
874
|
+
/**
|
|
875
|
+
* Features that must be enabled in the target org
|
|
876
|
+
*/
|
|
877
|
+
enabled?: string[];
|
|
878
|
+
/**
|
|
879
|
+
* Features that must be disabled in the target org
|
|
880
|
+
*/
|
|
881
|
+
disabled?: string[];
|
|
882
|
+
};
|
|
883
|
+
/**
|
|
884
|
+
* Custom name for the exported zip file
|
|
885
|
+
*/
|
|
886
|
+
zip_file_name?: string;
|
|
785
887
|
source_type: "file";
|
|
786
888
|
resources?: BlueprintResource[];
|
|
787
889
|
}
|
|
@@ -1412,17 +1514,33 @@ declare namespace Components {
|
|
|
1412
1514
|
* Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.
|
|
1413
1515
|
*/
|
|
1414
1516
|
archived?: boolean;
|
|
1415
|
-
dependency_tree?: /* Custom dependency tree override. Keys are resource types, values are arrays of allowed dependency types. */ DependencyTreeOverride;
|
|
1416
1517
|
/**
|
|
1417
1518
|
* URL to the blueprint documentation
|
|
1418
1519
|
*/
|
|
1419
1520
|
docs_url?: string;
|
|
1420
|
-
source_type: "marketplace";
|
|
1421
|
-
resources?: BlueprintResource[];
|
|
1422
1521
|
/**
|
|
1423
1522
|
* List of compatible app IDs for the blueprint
|
|
1424
1523
|
*/
|
|
1425
1524
|
compatible_apps?: string[];
|
|
1525
|
+
/**
|
|
1526
|
+
* Feature constraints for blueprint installation
|
|
1527
|
+
*/
|
|
1528
|
+
required_features?: {
|
|
1529
|
+
/**
|
|
1530
|
+
* Features that must be enabled in the target org
|
|
1531
|
+
*/
|
|
1532
|
+
enabled?: string[];
|
|
1533
|
+
/**
|
|
1534
|
+
* Features that must be disabled in the target org
|
|
1535
|
+
*/
|
|
1536
|
+
disabled?: string[];
|
|
1537
|
+
};
|
|
1538
|
+
/**
|
|
1539
|
+
* Custom name for the exported zip file
|
|
1540
|
+
*/
|
|
1541
|
+
zip_file_name?: string;
|
|
1542
|
+
source_type: "marketplace";
|
|
1543
|
+
resources?: BlueprintResource[];
|
|
1426
1544
|
/**
|
|
1427
1545
|
* Whether a newer version is available in the marketplace.
|
|
1428
1546
|
*/
|
|
@@ -2053,6 +2171,33 @@ declare namespace Paths {
|
|
|
2053
2171
|
}
|
|
2054
2172
|
}
|
|
2055
2173
|
}
|
|
2174
|
+
namespace FormatBlueprintDescription {
|
|
2175
|
+
namespace Parameters {
|
|
2176
|
+
export type BlueprintId = /**
|
|
2177
|
+
* ID of a blueprint
|
|
2178
|
+
* example:
|
|
2179
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
2180
|
+
*/
|
|
2181
|
+
Components.Schemas.BlueprintID;
|
|
2182
|
+
}
|
|
2183
|
+
export interface PathParameters {
|
|
2184
|
+
blueprint_id: Parameters.BlueprintId;
|
|
2185
|
+
}
|
|
2186
|
+
export interface RequestBody {
|
|
2187
|
+
/**
|
|
2188
|
+
* Plain text to format as markdown
|
|
2189
|
+
*/
|
|
2190
|
+
text: string;
|
|
2191
|
+
}
|
|
2192
|
+
namespace Responses {
|
|
2193
|
+
export interface $200 {
|
|
2194
|
+
/**
|
|
2195
|
+
* AI-formatted markdown content
|
|
2196
|
+
*/
|
|
2197
|
+
markdown?: string;
|
|
2198
|
+
}
|
|
2199
|
+
}
|
|
2200
|
+
}
|
|
2056
2201
|
namespace GetBlueprint {
|
|
2057
2202
|
namespace Parameters {
|
|
2058
2203
|
export type BlueprintId = /**
|
|
@@ -2098,11 +2243,6 @@ declare namespace Paths {
|
|
|
2098
2243
|
}
|
|
2099
2244
|
}
|
|
2100
2245
|
}
|
|
2101
|
-
namespace GetDependencyTree {
|
|
2102
|
-
namespace Responses {
|
|
2103
|
-
export type $200 = /* The default resource dependency tree. Keys are resource types, values describe their dependencies. */ Components.Schemas.DependencyTree;
|
|
2104
|
-
}
|
|
2105
|
-
}
|
|
2106
2246
|
namespace GetJob {
|
|
2107
2247
|
namespace Parameters {
|
|
2108
2248
|
export type JobId = /**
|
|
@@ -2376,6 +2516,7 @@ declare namespace Paths {
|
|
|
2376
2516
|
}
|
|
2377
2517
|
}
|
|
2378
2518
|
|
|
2519
|
+
|
|
2379
2520
|
export interface OperationMethods {
|
|
2380
2521
|
/**
|
|
2381
2522
|
* getJob - getJob
|
|
@@ -2604,6 +2745,17 @@ export interface OperationMethods {
|
|
|
2604
2745
|
data?: Paths.ExportBlueprint.RequestBody,
|
|
2605
2746
|
config?: AxiosRequestConfig
|
|
2606
2747
|
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
2748
|
+
/**
|
|
2749
|
+
* formatBlueprintDescription - formatBlueprintDescription
|
|
2750
|
+
*
|
|
2751
|
+
* Format a blueprint description as markdown using AI.
|
|
2752
|
+
*
|
|
2753
|
+
*/
|
|
2754
|
+
'formatBlueprintDescription'(
|
|
2755
|
+
parameters?: Parameters<Paths.FormatBlueprintDescription.PathParameters> | null,
|
|
2756
|
+
data?: Paths.FormatBlueprintDescription.RequestBody,
|
|
2757
|
+
config?: AxiosRequestConfig
|
|
2758
|
+
): OperationResponse<Paths.FormatBlueprintDescription.Responses.$200>
|
|
2607
2759
|
/**
|
|
2608
2760
|
* addBlueprintResource - addBlueprintResource
|
|
2609
2761
|
*
|
|
@@ -2614,16 +2766,6 @@ export interface OperationMethods {
|
|
|
2614
2766
|
data?: Paths.AddBlueprintResource.RequestBody,
|
|
2615
2767
|
config?: AxiosRequestConfig
|
|
2616
2768
|
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
2617
|
-
/**
|
|
2618
|
-
* getDependencyTree - getDependencyTree
|
|
2619
|
-
*
|
|
2620
|
-
* Get the default resource dependency tree
|
|
2621
|
-
*/
|
|
2622
|
-
'getDependencyTree'(
|
|
2623
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
2624
|
-
data?: any,
|
|
2625
|
-
config?: AxiosRequestConfig
|
|
2626
|
-
): OperationResponse<Paths.GetDependencyTree.Responses.$200>
|
|
2627
2769
|
/**
|
|
2628
2770
|
* syncDependencies - syncDependencies
|
|
2629
2771
|
*
|
|
@@ -2986,6 +3128,19 @@ export interface PathsDictionary {
|
|
|
2986
3128
|
config?: AxiosRequestConfig
|
|
2987
3129
|
): OperationResponse<Paths.ExportBlueprint.Responses.$202>
|
|
2988
3130
|
}
|
|
3131
|
+
['/v2/blueprint-manifest/blueprints/{blueprint_id}:format-description']: {
|
|
3132
|
+
/**
|
|
3133
|
+
* formatBlueprintDescription - formatBlueprintDescription
|
|
3134
|
+
*
|
|
3135
|
+
* Format a blueprint description as markdown using AI.
|
|
3136
|
+
*
|
|
3137
|
+
*/
|
|
3138
|
+
'post'(
|
|
3139
|
+
parameters?: Parameters<Paths.FormatBlueprintDescription.PathParameters> | null,
|
|
3140
|
+
data?: Paths.FormatBlueprintDescription.RequestBody,
|
|
3141
|
+
config?: AxiosRequestConfig
|
|
3142
|
+
): OperationResponse<Paths.FormatBlueprintDescription.Responses.$200>
|
|
3143
|
+
}
|
|
2989
3144
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources']: {
|
|
2990
3145
|
/**
|
|
2991
3146
|
* addBlueprintResource - addBlueprintResource
|
|
@@ -2998,18 +3153,6 @@ export interface PathsDictionary {
|
|
|
2998
3153
|
config?: AxiosRequestConfig
|
|
2999
3154
|
): OperationResponse<Paths.AddBlueprintResource.Responses.$200>
|
|
3000
3155
|
}
|
|
3001
|
-
['/v2/blueprint-manifest/dependency-tree']: {
|
|
3002
|
-
/**
|
|
3003
|
-
* getDependencyTree - getDependencyTree
|
|
3004
|
-
*
|
|
3005
|
-
* Get the default resource dependency tree
|
|
3006
|
-
*/
|
|
3007
|
-
'get'(
|
|
3008
|
-
parameters?: Parameters<UnknownParamsObject> | null,
|
|
3009
|
-
data?: any,
|
|
3010
|
-
config?: AxiosRequestConfig
|
|
3011
|
-
): OperationResponse<Paths.GetDependencyTree.Responses.$200>
|
|
3012
|
-
}
|
|
3013
3156
|
['/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies']: {
|
|
3014
3157
|
/**
|
|
3015
3158
|
* syncDependencies - syncDependencies
|
|
@@ -3128,6 +3271,7 @@ export interface PathsDictionary {
|
|
|
3128
3271
|
|
|
3129
3272
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
3130
3273
|
|
|
3274
|
+
|
|
3131
3275
|
export type AppBlueprint = Components.Schemas.AppBlueprint;
|
|
3132
3276
|
export type Blueprint = Components.Schemas.Blueprint;
|
|
3133
3277
|
export type BlueprintDependenciesSyncJob = Components.Schemas.BlueprintDependenciesSyncJob;
|
|
@@ -3151,8 +3295,6 @@ export type CommonManifestFields = Components.Schemas.CommonManifestFields;
|
|
|
3151
3295
|
export type CommonMarkdownFields = Components.Schemas.CommonMarkdownFields;
|
|
3152
3296
|
export type CommonResourceNode = Components.Schemas.CommonResourceNode;
|
|
3153
3297
|
export type CustomBlueprint = Components.Schemas.CustomBlueprint;
|
|
3154
|
-
export type DependencyTree = Components.Schemas.DependencyTree;
|
|
3155
|
-
export type DependencyTreeOverride = Components.Schemas.DependencyTreeOverride;
|
|
3156
3298
|
export type DeployedBlueprint = Components.Schemas.DeployedBlueprint;
|
|
3157
3299
|
export type FileBlueprint = Components.Schemas.FileBlueprint;
|
|
3158
3300
|
export type FormattedError = Components.Schemas.FormattedError;
|
package/dist/openapi.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.0",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Blueprint Manifest API",
|
|
5
|
-
"version": "4.
|
|
5
|
+
"version": "4.5.0",
|
|
6
6
|
"description": "Service to create and install Blueprint Manifest files"
|
|
7
7
|
},
|
|
8
8
|
"tags": [
|
|
@@ -1187,6 +1187,63 @@
|
|
|
1187
1187
|
}
|
|
1188
1188
|
}
|
|
1189
1189
|
},
|
|
1190
|
+
"/v2/blueprint-manifest/blueprints/{blueprint_id}:format-description": {
|
|
1191
|
+
"post": {
|
|
1192
|
+
"operationId": "formatBlueprintDescription",
|
|
1193
|
+
"summary": "formatBlueprintDescription",
|
|
1194
|
+
"description": "Format a blueprint description as markdown using AI.\n",
|
|
1195
|
+
"tags": [
|
|
1196
|
+
"Blueprints"
|
|
1197
|
+
],
|
|
1198
|
+
"parameters": [
|
|
1199
|
+
{
|
|
1200
|
+
"in": "path",
|
|
1201
|
+
"required": true,
|
|
1202
|
+
"name": "blueprint_id",
|
|
1203
|
+
"schema": {
|
|
1204
|
+
"$ref": "#/components/schemas/BlueprintID"
|
|
1205
|
+
}
|
|
1206
|
+
}
|
|
1207
|
+
],
|
|
1208
|
+
"requestBody": {
|
|
1209
|
+
"required": true,
|
|
1210
|
+
"content": {
|
|
1211
|
+
"application/json": {
|
|
1212
|
+
"schema": {
|
|
1213
|
+
"type": "object",
|
|
1214
|
+
"required": [
|
|
1215
|
+
"text"
|
|
1216
|
+
],
|
|
1217
|
+
"properties": {
|
|
1218
|
+
"text": {
|
|
1219
|
+
"type": "string",
|
|
1220
|
+
"description": "Plain text to format as markdown"
|
|
1221
|
+
}
|
|
1222
|
+
}
|
|
1223
|
+
}
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1226
|
+
},
|
|
1227
|
+
"responses": {
|
|
1228
|
+
"200": {
|
|
1229
|
+
"description": "Successfully formatted description",
|
|
1230
|
+
"content": {
|
|
1231
|
+
"application/json": {
|
|
1232
|
+
"schema": {
|
|
1233
|
+
"type": "object",
|
|
1234
|
+
"properties": {
|
|
1235
|
+
"markdown": {
|
|
1236
|
+
"type": "string",
|
|
1237
|
+
"description": "AI-formatted markdown content"
|
|
1238
|
+
}
|
|
1239
|
+
}
|
|
1240
|
+
}
|
|
1241
|
+
}
|
|
1242
|
+
}
|
|
1243
|
+
}
|
|
1244
|
+
}
|
|
1245
|
+
}
|
|
1246
|
+
},
|
|
1190
1247
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources": {
|
|
1191
1248
|
"post": {
|
|
1192
1249
|
"operationId": "addBlueprintResource",
|
|
@@ -1245,28 +1302,6 @@
|
|
|
1245
1302
|
}
|
|
1246
1303
|
}
|
|
1247
1304
|
},
|
|
1248
|
-
"/v2/blueprint-manifest/dependency-tree": {
|
|
1249
|
-
"get": {
|
|
1250
|
-
"operationId": "getDependencyTree",
|
|
1251
|
-
"summary": "getDependencyTree",
|
|
1252
|
-
"description": "Get the default resource dependency tree",
|
|
1253
|
-
"tags": [
|
|
1254
|
-
"Blueprints"
|
|
1255
|
-
],
|
|
1256
|
-
"responses": {
|
|
1257
|
-
"200": {
|
|
1258
|
-
"description": "Default dependency tree",
|
|
1259
|
-
"content": {
|
|
1260
|
-
"application/json": {
|
|
1261
|
-
"schema": {
|
|
1262
|
-
"$ref": "#/components/schemas/DependencyTree"
|
|
1263
|
-
}
|
|
1264
|
-
}
|
|
1265
|
-
}
|
|
1266
|
-
}
|
|
1267
|
-
}
|
|
1268
|
-
}
|
|
1269
|
-
},
|
|
1270
1305
|
"/v2/blueprint-manifest/blueprints/{blueprint_id}/resources:syncDependencies": {
|
|
1271
1306
|
"post": {
|
|
1272
1307
|
"operationId": "syncDependencies",
|
|
@@ -1826,46 +1861,46 @@
|
|
|
1826
1861
|
"description": "Whether the blueprint is archived (soft-deleted). Archived blueprints are hidden from the main list.",
|
|
1827
1862
|
"default": false
|
|
1828
1863
|
},
|
|
1829
|
-
"
|
|
1830
|
-
"
|
|
1831
|
-
"
|
|
1864
|
+
"docs_url": {
|
|
1865
|
+
"type": "string",
|
|
1866
|
+
"description": "URL to the blueprint documentation"
|
|
1867
|
+
},
|
|
1868
|
+
"compatible_apps": {
|
|
1869
|
+
"type": "array",
|
|
1870
|
+
"items": {
|
|
1871
|
+
"type": "string"
|
|
1872
|
+
},
|
|
1873
|
+
"description": "List of compatible app IDs for the blueprint"
|
|
1874
|
+
},
|
|
1875
|
+
"required_features": {
|
|
1876
|
+
"type": "object",
|
|
1877
|
+
"description": "Feature constraints for blueprint installation",
|
|
1878
|
+
"properties": {
|
|
1879
|
+
"enabled": {
|
|
1880
|
+
"type": "array",
|
|
1881
|
+
"items": {
|
|
1882
|
+
"type": "string"
|
|
1883
|
+
},
|
|
1884
|
+
"description": "Features that must be enabled in the target org"
|
|
1885
|
+
},
|
|
1886
|
+
"disabled": {
|
|
1887
|
+
"type": "array",
|
|
1888
|
+
"items": {
|
|
1889
|
+
"type": "string"
|
|
1890
|
+
},
|
|
1891
|
+
"description": "Features that must be disabled in the target org"
|
|
1892
|
+
}
|
|
1893
|
+
}
|
|
1894
|
+
},
|
|
1895
|
+
"zip_file_name": {
|
|
1896
|
+
"type": "string",
|
|
1897
|
+
"description": "Custom name for the exported zip file"
|
|
1832
1898
|
}
|
|
1833
1899
|
},
|
|
1834
1900
|
"required": [
|
|
1835
1901
|
"title"
|
|
1836
1902
|
]
|
|
1837
1903
|
},
|
|
1838
|
-
"DependencyTree": {
|
|
1839
|
-
"type": "object",
|
|
1840
|
-
"description": "The default resource dependency tree. Keys are resource types, values describe their dependencies.",
|
|
1841
|
-
"additionalProperties": {
|
|
1842
|
-
"type": "object",
|
|
1843
|
-
"properties": {
|
|
1844
|
-
"dependencies": {
|
|
1845
|
-
"type": "array",
|
|
1846
|
-
"items": {
|
|
1847
|
-
"$ref": "#/components/schemas/ResourceNodeType"
|
|
1848
|
-
}
|
|
1849
|
-
},
|
|
1850
|
-
"rootOnlyDependencies": {
|
|
1851
|
-
"type": "array",
|
|
1852
|
-
"items": {
|
|
1853
|
-
"$ref": "#/components/schemas/ResourceNodeType"
|
|
1854
|
-
}
|
|
1855
|
-
}
|
|
1856
|
-
}
|
|
1857
|
-
}
|
|
1858
|
-
},
|
|
1859
|
-
"DependencyTreeOverride": {
|
|
1860
|
-
"type": "object",
|
|
1861
|
-
"description": "Custom dependency tree override. Keys are resource types, values are arrays of allowed dependency types.",
|
|
1862
|
-
"additionalProperties": {
|
|
1863
|
-
"type": "array",
|
|
1864
|
-
"items": {
|
|
1865
|
-
"$ref": "#/components/schemas/ResourceNodeType"
|
|
1866
|
-
}
|
|
1867
|
-
}
|
|
1868
|
-
},
|
|
1869
1904
|
"BlueprintResource": {
|
|
1870
1905
|
"type": "object",
|
|
1871
1906
|
"properties": {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/blueprint-manifest-client",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.5.0",
|
|
4
4
|
"description": "Client for epilot Terraform Blueprint Manifest API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -70,7 +70,7 @@
|
|
|
70
70
|
"ts-node": "^10.9.1",
|
|
71
71
|
"typescript": "^4.1.3",
|
|
72
72
|
"webpack": "^5.18.0",
|
|
73
|
-
"webpack-cli": "^4.
|
|
73
|
+
"webpack-cli": "^4.10.0"
|
|
74
74
|
},
|
|
75
75
|
"gitHead": "39426e86cfb320fa3227dc03f60ee6a10848e7c7"
|
|
76
76
|
}
|