@epilot/blueprint-manifest-client 5.0.0 → 5.1.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 +69 -0
- package/dist/openapi.d.ts +925 -3
- package/dist/openapi.json +571 -1
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -63,6 +63,90 @@ declare namespace Components {
|
|
|
63
63
|
* Outcome of this deployment
|
|
64
64
|
*/
|
|
65
65
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
66
|
+
/**
|
|
67
|
+
* Restore lifecycle metadata for this deployment.
|
|
68
|
+
*/
|
|
69
|
+
restore_details?: {
|
|
70
|
+
/**
|
|
71
|
+
* Whether this sync changed destination resources in a way that can
|
|
72
|
+
* be reverted. `false` means the sync completed without create,
|
|
73
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
74
|
+
* action to offer.
|
|
75
|
+
*
|
|
76
|
+
*/
|
|
77
|
+
has_revertible_changes?: boolean;
|
|
78
|
+
/**
|
|
79
|
+
* Counts of resource impact values from the V3 apply result.
|
|
80
|
+
*/
|
|
81
|
+
resource_impact_summary?: {
|
|
82
|
+
create?: number;
|
|
83
|
+
update?: number;
|
|
84
|
+
internal_update?: number;
|
|
85
|
+
delete?: number;
|
|
86
|
+
no_op?: number;
|
|
87
|
+
ignored?: number;
|
|
88
|
+
};
|
|
89
|
+
/**
|
|
90
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
91
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
92
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
93
|
+
* render the latest restore outcome.
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
last_restore_job_id?: string;
|
|
97
|
+
/**
|
|
98
|
+
* Timestamp of the most recent restore that ran against this
|
|
99
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
100
|
+
* FE to show when a sync was reverted.
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
last_restore_at?: string; // date-time
|
|
104
|
+
/**
|
|
105
|
+
* Identity of the caller who triggered the most recent restore.
|
|
106
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
107
|
+
* who reverted a sync.
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
last_restored_by?: {
|
|
111
|
+
/**
|
|
112
|
+
* Display name (email or token name) of the restorer.
|
|
113
|
+
*/
|
|
114
|
+
name?: string;
|
|
115
|
+
/**
|
|
116
|
+
* User id of the restorer, when triggered by a user.
|
|
117
|
+
*/
|
|
118
|
+
user_id?: string;
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
122
|
+
* `available` when the deployment is restorable but has no prior
|
|
123
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
124
|
+
* reverted via sweep-only);
|
|
125
|
+
* `in_progress` while an install or restore is running on this
|
|
126
|
+
* blueprint instance;
|
|
127
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
128
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
129
|
+
* `unavailable` means there is no revert action, for example
|
|
130
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
131
|
+
*
|
|
132
|
+
*/
|
|
133
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
137
|
+
*
|
|
138
|
+
*/
|
|
139
|
+
has_revertible_changes?: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
142
|
+
*
|
|
143
|
+
*/
|
|
144
|
+
last_restore_job_id?: string;
|
|
145
|
+
/**
|
|
146
|
+
* Deprecated. Use `restore_details.status`.
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
66
150
|
}[];
|
|
67
151
|
/**
|
|
68
152
|
* Whether the blueprint is verified by epilot
|
|
@@ -133,6 +217,7 @@ declare namespace Components {
|
|
|
133
217
|
events?: BlueprintJobEvent[];
|
|
134
218
|
triggered_at?: string; // date-time
|
|
135
219
|
created_by?: CallerIdentity;
|
|
220
|
+
job_type?: "dependencies_sync";
|
|
136
221
|
blueprint_id?: /**
|
|
137
222
|
* ID of a blueprint
|
|
138
223
|
* example:
|
|
@@ -151,6 +236,7 @@ declare namespace Components {
|
|
|
151
236
|
events?: BlueprintJobEvent[];
|
|
152
237
|
triggered_at?: string; // date-time
|
|
153
238
|
created_by?: CallerIdentity;
|
|
239
|
+
job_type?: "export";
|
|
154
240
|
blueprint_id?: /**
|
|
155
241
|
* ID of a blueprint
|
|
156
242
|
* example:
|
|
@@ -177,6 +263,7 @@ declare namespace Components {
|
|
|
177
263
|
events?: BlueprintJobEvent[];
|
|
178
264
|
triggered_at?: string; // date-time
|
|
179
265
|
created_by?: CallerIdentity;
|
|
266
|
+
job_type?: "install";
|
|
180
267
|
source_blueprint_id?: /**
|
|
181
268
|
* ID of a blueprint
|
|
182
269
|
* example:
|
|
@@ -213,7 +300,7 @@ declare namespace Components {
|
|
|
213
300
|
*/
|
|
214
301
|
resources_to_ignore?: string[];
|
|
215
302
|
}
|
|
216
|
-
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintDependenciesSyncJob | BlueprintValidateJob | BlueprintVerificationJob;
|
|
303
|
+
export type BlueprintJob = BlueprintExportJob | BlueprintInstallationJob | BlueprintRestoreJob | BlueprintDependenciesSyncJob | BlueprintValidateJob | BlueprintVerificationJob;
|
|
217
304
|
export interface BlueprintJobEvent {
|
|
218
305
|
timestamp?: string; // date-time
|
|
219
306
|
message?: string;
|
|
@@ -372,6 +459,52 @@ declare namespace Components {
|
|
|
372
459
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
373
460
|
*/
|
|
374
461
|
export type BlueprintResourceID = string;
|
|
462
|
+
export interface BlueprintRestoreJob {
|
|
463
|
+
id?: /**
|
|
464
|
+
* ID of a job
|
|
465
|
+
* example:
|
|
466
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
467
|
+
*/
|
|
468
|
+
BlueprintJobID;
|
|
469
|
+
events?: BlueprintJobEvent[];
|
|
470
|
+
triggered_at?: string; // date-time
|
|
471
|
+
created_by?: CallerIdentity;
|
|
472
|
+
job_type?: "restore";
|
|
473
|
+
destination_blueprint_id?: /**
|
|
474
|
+
* ID of a blueprint
|
|
475
|
+
* example:
|
|
476
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
477
|
+
*/
|
|
478
|
+
BlueprintID;
|
|
479
|
+
destination_org_id?: string;
|
|
480
|
+
/**
|
|
481
|
+
* The install job whose deployment is being reverted. Maps back
|
|
482
|
+
* to the entry in `Blueprint.deployments[]`.
|
|
483
|
+
*
|
|
484
|
+
*/
|
|
485
|
+
install_job_id?: string | null;
|
|
486
|
+
/**
|
|
487
|
+
* The snapshot driving Phase 1 of the restore. Null for sweep-only
|
|
488
|
+
* restores (pure-create deployments with no captured manifest).
|
|
489
|
+
*
|
|
490
|
+
*/
|
|
491
|
+
snapshot_id?: string | null;
|
|
492
|
+
sync_engine?: "v3";
|
|
493
|
+
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
494
|
+
/**
|
|
495
|
+
* Absent while the job is still IN_PROGRESS.
|
|
496
|
+
*/
|
|
497
|
+
restore_result?: {
|
|
498
|
+
/**
|
|
499
|
+
* The snapshot driving Phase 1 of the restore. Null/absent for
|
|
500
|
+
* sweep-only restores (pure-create deployments with no captured
|
|
501
|
+
* manifest).
|
|
502
|
+
*
|
|
503
|
+
*/
|
|
504
|
+
snapshot_id?: string | null;
|
|
505
|
+
resources?: RestoreOutcomeItem[];
|
|
506
|
+
} | null;
|
|
507
|
+
}
|
|
375
508
|
export interface BlueprintValidateJob {
|
|
376
509
|
id?: /**
|
|
377
510
|
* ID of a job
|
|
@@ -382,6 +515,7 @@ declare namespace Components {
|
|
|
382
515
|
events?: BlueprintJobEvent[];
|
|
383
516
|
triggered_at?: string; // date-time
|
|
384
517
|
created_by?: CallerIdentity;
|
|
518
|
+
job_type?: "validate";
|
|
385
519
|
blueprint_id?: /**
|
|
386
520
|
* ID of a blueprint
|
|
387
521
|
* example:
|
|
@@ -408,6 +542,7 @@ declare namespace Components {
|
|
|
408
542
|
events?: BlueprintJobEvent[];
|
|
409
543
|
triggered_at?: string; // date-time
|
|
410
544
|
created_by?: CallerIdentity;
|
|
545
|
+
job_type?: "verification";
|
|
411
546
|
source_org_id?: string;
|
|
412
547
|
source_blueprint_id?: /**
|
|
413
548
|
* ID of a blueprint
|
|
@@ -422,7 +557,7 @@ declare namespace Components {
|
|
|
422
557
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
423
558
|
*/
|
|
424
559
|
BlueprintID;
|
|
425
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
560
|
+
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
426
561
|
summary?: VerificationSummary;
|
|
427
562
|
resource_results?: ResourceVerificationResult[];
|
|
428
563
|
/**
|
|
@@ -500,6 +635,90 @@ declare namespace Components {
|
|
|
500
635
|
* Outcome of this deployment
|
|
501
636
|
*/
|
|
502
637
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
638
|
+
/**
|
|
639
|
+
* Restore lifecycle metadata for this deployment.
|
|
640
|
+
*/
|
|
641
|
+
restore_details?: {
|
|
642
|
+
/**
|
|
643
|
+
* Whether this sync changed destination resources in a way that can
|
|
644
|
+
* be reverted. `false` means the sync completed without create,
|
|
645
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
646
|
+
* action to offer.
|
|
647
|
+
*
|
|
648
|
+
*/
|
|
649
|
+
has_revertible_changes?: boolean;
|
|
650
|
+
/**
|
|
651
|
+
* Counts of resource impact values from the V3 apply result.
|
|
652
|
+
*/
|
|
653
|
+
resource_impact_summary?: {
|
|
654
|
+
create?: number;
|
|
655
|
+
update?: number;
|
|
656
|
+
internal_update?: number;
|
|
657
|
+
delete?: number;
|
|
658
|
+
no_op?: number;
|
|
659
|
+
ignored?: number;
|
|
660
|
+
};
|
|
661
|
+
/**
|
|
662
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
663
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
664
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
665
|
+
* render the latest restore outcome.
|
|
666
|
+
*
|
|
667
|
+
*/
|
|
668
|
+
last_restore_job_id?: string;
|
|
669
|
+
/**
|
|
670
|
+
* Timestamp of the most recent restore that ran against this
|
|
671
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
672
|
+
* FE to show when a sync was reverted.
|
|
673
|
+
*
|
|
674
|
+
*/
|
|
675
|
+
last_restore_at?: string; // date-time
|
|
676
|
+
/**
|
|
677
|
+
* Identity of the caller who triggered the most recent restore.
|
|
678
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
679
|
+
* who reverted a sync.
|
|
680
|
+
*
|
|
681
|
+
*/
|
|
682
|
+
last_restored_by?: {
|
|
683
|
+
/**
|
|
684
|
+
* Display name (email or token name) of the restorer.
|
|
685
|
+
*/
|
|
686
|
+
name?: string;
|
|
687
|
+
/**
|
|
688
|
+
* User id of the restorer, when triggered by a user.
|
|
689
|
+
*/
|
|
690
|
+
user_id?: string;
|
|
691
|
+
};
|
|
692
|
+
/**
|
|
693
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
694
|
+
* `available` when the deployment is restorable but has no prior
|
|
695
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
696
|
+
* reverted via sweep-only);
|
|
697
|
+
* `in_progress` while an install or restore is running on this
|
|
698
|
+
* blueprint instance;
|
|
699
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
700
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
701
|
+
* `unavailable` means there is no revert action, for example
|
|
702
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
703
|
+
*
|
|
704
|
+
*/
|
|
705
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
706
|
+
};
|
|
707
|
+
/**
|
|
708
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
709
|
+
*
|
|
710
|
+
*/
|
|
711
|
+
has_revertible_changes?: boolean;
|
|
712
|
+
/**
|
|
713
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
714
|
+
*
|
|
715
|
+
*/
|
|
716
|
+
last_restore_job_id?: string;
|
|
717
|
+
/**
|
|
718
|
+
* Deprecated. Use `restore_details.status`.
|
|
719
|
+
*
|
|
720
|
+
*/
|
|
721
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
503
722
|
}[];
|
|
504
723
|
/**
|
|
505
724
|
* Whether the blueprint is verified by epilot
|
|
@@ -787,6 +1006,90 @@ declare namespace Components {
|
|
|
787
1006
|
* Outcome of this deployment
|
|
788
1007
|
*/
|
|
789
1008
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
1009
|
+
/**
|
|
1010
|
+
* Restore lifecycle metadata for this deployment.
|
|
1011
|
+
*/
|
|
1012
|
+
restore_details?: {
|
|
1013
|
+
/**
|
|
1014
|
+
* Whether this sync changed destination resources in a way that can
|
|
1015
|
+
* be reverted. `false` means the sync completed without create,
|
|
1016
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
1017
|
+
* action to offer.
|
|
1018
|
+
*
|
|
1019
|
+
*/
|
|
1020
|
+
has_revertible_changes?: boolean;
|
|
1021
|
+
/**
|
|
1022
|
+
* Counts of resource impact values from the V3 apply result.
|
|
1023
|
+
*/
|
|
1024
|
+
resource_impact_summary?: {
|
|
1025
|
+
create?: number;
|
|
1026
|
+
update?: number;
|
|
1027
|
+
internal_update?: number;
|
|
1028
|
+
delete?: number;
|
|
1029
|
+
no_op?: number;
|
|
1030
|
+
ignored?: number;
|
|
1031
|
+
};
|
|
1032
|
+
/**
|
|
1033
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
1034
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
1035
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
1036
|
+
* render the latest restore outcome.
|
|
1037
|
+
*
|
|
1038
|
+
*/
|
|
1039
|
+
last_restore_job_id?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* Timestamp of the most recent restore that ran against this
|
|
1042
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
1043
|
+
* FE to show when a sync was reverted.
|
|
1044
|
+
*
|
|
1045
|
+
*/
|
|
1046
|
+
last_restore_at?: string; // date-time
|
|
1047
|
+
/**
|
|
1048
|
+
* Identity of the caller who triggered the most recent restore.
|
|
1049
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
1050
|
+
* who reverted a sync.
|
|
1051
|
+
*
|
|
1052
|
+
*/
|
|
1053
|
+
last_restored_by?: {
|
|
1054
|
+
/**
|
|
1055
|
+
* Display name (email or token name) of the restorer.
|
|
1056
|
+
*/
|
|
1057
|
+
name?: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* User id of the restorer, when triggered by a user.
|
|
1060
|
+
*/
|
|
1061
|
+
user_id?: string;
|
|
1062
|
+
};
|
|
1063
|
+
/**
|
|
1064
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
1065
|
+
* `available` when the deployment is restorable but has no prior
|
|
1066
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
1067
|
+
* reverted via sweep-only);
|
|
1068
|
+
* `in_progress` while an install or restore is running on this
|
|
1069
|
+
* blueprint instance;
|
|
1070
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
1071
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
1072
|
+
* `unavailable` means there is no revert action, for example
|
|
1073
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
1074
|
+
*
|
|
1075
|
+
*/
|
|
1076
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
1077
|
+
};
|
|
1078
|
+
/**
|
|
1079
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
1080
|
+
*
|
|
1081
|
+
*/
|
|
1082
|
+
has_revertible_changes?: boolean;
|
|
1083
|
+
/**
|
|
1084
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
1085
|
+
*
|
|
1086
|
+
*/
|
|
1087
|
+
last_restore_job_id?: string;
|
|
1088
|
+
/**
|
|
1089
|
+
* Deprecated. Use `restore_details.status`.
|
|
1090
|
+
*
|
|
1091
|
+
*/
|
|
1092
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
790
1093
|
}[];
|
|
791
1094
|
/**
|
|
792
1095
|
* Whether the blueprint is verified by epilot
|
|
@@ -890,6 +1193,90 @@ declare namespace Components {
|
|
|
890
1193
|
* Outcome of this deployment
|
|
891
1194
|
*/
|
|
892
1195
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
1196
|
+
/**
|
|
1197
|
+
* Restore lifecycle metadata for this deployment.
|
|
1198
|
+
*/
|
|
1199
|
+
restore_details?: {
|
|
1200
|
+
/**
|
|
1201
|
+
* Whether this sync changed destination resources in a way that can
|
|
1202
|
+
* be reverted. `false` means the sync completed without create,
|
|
1203
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
1204
|
+
* action to offer.
|
|
1205
|
+
*
|
|
1206
|
+
*/
|
|
1207
|
+
has_revertible_changes?: boolean;
|
|
1208
|
+
/**
|
|
1209
|
+
* Counts of resource impact values from the V3 apply result.
|
|
1210
|
+
*/
|
|
1211
|
+
resource_impact_summary?: {
|
|
1212
|
+
create?: number;
|
|
1213
|
+
update?: number;
|
|
1214
|
+
internal_update?: number;
|
|
1215
|
+
delete?: number;
|
|
1216
|
+
no_op?: number;
|
|
1217
|
+
ignored?: number;
|
|
1218
|
+
};
|
|
1219
|
+
/**
|
|
1220
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
1221
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
1222
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
1223
|
+
* render the latest restore outcome.
|
|
1224
|
+
*
|
|
1225
|
+
*/
|
|
1226
|
+
last_restore_job_id?: string;
|
|
1227
|
+
/**
|
|
1228
|
+
* Timestamp of the most recent restore that ran against this
|
|
1229
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
1230
|
+
* FE to show when a sync was reverted.
|
|
1231
|
+
*
|
|
1232
|
+
*/
|
|
1233
|
+
last_restore_at?: string; // date-time
|
|
1234
|
+
/**
|
|
1235
|
+
* Identity of the caller who triggered the most recent restore.
|
|
1236
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
1237
|
+
* who reverted a sync.
|
|
1238
|
+
*
|
|
1239
|
+
*/
|
|
1240
|
+
last_restored_by?: {
|
|
1241
|
+
/**
|
|
1242
|
+
* Display name (email or token name) of the restorer.
|
|
1243
|
+
*/
|
|
1244
|
+
name?: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* User id of the restorer, when triggered by a user.
|
|
1247
|
+
*/
|
|
1248
|
+
user_id?: string;
|
|
1249
|
+
};
|
|
1250
|
+
/**
|
|
1251
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
1252
|
+
* `available` when the deployment is restorable but has no prior
|
|
1253
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
1254
|
+
* reverted via sweep-only);
|
|
1255
|
+
* `in_progress` while an install or restore is running on this
|
|
1256
|
+
* blueprint instance;
|
|
1257
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
1258
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
1259
|
+
* `unavailable` means there is no revert action, for example
|
|
1260
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
1261
|
+
*
|
|
1262
|
+
*/
|
|
1263
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
1264
|
+
};
|
|
1265
|
+
/**
|
|
1266
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
1267
|
+
*
|
|
1268
|
+
*/
|
|
1269
|
+
has_revertible_changes?: boolean;
|
|
1270
|
+
/**
|
|
1271
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
1272
|
+
*
|
|
1273
|
+
*/
|
|
1274
|
+
last_restore_job_id?: string;
|
|
1275
|
+
/**
|
|
1276
|
+
* Deprecated. Use `restore_details.status`.
|
|
1277
|
+
*
|
|
1278
|
+
*/
|
|
1279
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
893
1280
|
}[];
|
|
894
1281
|
/**
|
|
895
1282
|
* Whether the blueprint is verified by epilot
|
|
@@ -1005,6 +1392,90 @@ declare namespace Components {
|
|
|
1005
1392
|
* Outcome of this deployment
|
|
1006
1393
|
*/
|
|
1007
1394
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
1395
|
+
/**
|
|
1396
|
+
* Restore lifecycle metadata for this deployment.
|
|
1397
|
+
*/
|
|
1398
|
+
restore_details?: {
|
|
1399
|
+
/**
|
|
1400
|
+
* Whether this sync changed destination resources in a way that can
|
|
1401
|
+
* be reverted. `false` means the sync completed without create,
|
|
1402
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
1403
|
+
* action to offer.
|
|
1404
|
+
*
|
|
1405
|
+
*/
|
|
1406
|
+
has_revertible_changes?: boolean;
|
|
1407
|
+
/**
|
|
1408
|
+
* Counts of resource impact values from the V3 apply result.
|
|
1409
|
+
*/
|
|
1410
|
+
resource_impact_summary?: {
|
|
1411
|
+
create?: number;
|
|
1412
|
+
update?: number;
|
|
1413
|
+
internal_update?: number;
|
|
1414
|
+
delete?: number;
|
|
1415
|
+
no_op?: number;
|
|
1416
|
+
ignored?: number;
|
|
1417
|
+
};
|
|
1418
|
+
/**
|
|
1419
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
1420
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
1421
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
1422
|
+
* render the latest restore outcome.
|
|
1423
|
+
*
|
|
1424
|
+
*/
|
|
1425
|
+
last_restore_job_id?: string;
|
|
1426
|
+
/**
|
|
1427
|
+
* Timestamp of the most recent restore that ran against this
|
|
1428
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
1429
|
+
* FE to show when a sync was reverted.
|
|
1430
|
+
*
|
|
1431
|
+
*/
|
|
1432
|
+
last_restore_at?: string; // date-time
|
|
1433
|
+
/**
|
|
1434
|
+
* Identity of the caller who triggered the most recent restore.
|
|
1435
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
1436
|
+
* who reverted a sync.
|
|
1437
|
+
*
|
|
1438
|
+
*/
|
|
1439
|
+
last_restored_by?: {
|
|
1440
|
+
/**
|
|
1441
|
+
* Display name (email or token name) of the restorer.
|
|
1442
|
+
*/
|
|
1443
|
+
name?: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* User id of the restorer, when triggered by a user.
|
|
1446
|
+
*/
|
|
1447
|
+
user_id?: string;
|
|
1448
|
+
};
|
|
1449
|
+
/**
|
|
1450
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
1451
|
+
* `available` when the deployment is restorable but has no prior
|
|
1452
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
1453
|
+
* reverted via sweep-only);
|
|
1454
|
+
* `in_progress` while an install or restore is running on this
|
|
1455
|
+
* blueprint instance;
|
|
1456
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
1457
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
1458
|
+
* `unavailable` means there is no revert action, for example
|
|
1459
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
1460
|
+
*
|
|
1461
|
+
*/
|
|
1462
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
1463
|
+
};
|
|
1464
|
+
/**
|
|
1465
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
1466
|
+
*
|
|
1467
|
+
*/
|
|
1468
|
+
has_revertible_changes?: boolean;
|
|
1469
|
+
/**
|
|
1470
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
1471
|
+
*
|
|
1472
|
+
*/
|
|
1473
|
+
last_restore_job_id?: string;
|
|
1474
|
+
/**
|
|
1475
|
+
* Deprecated. Use `restore_details.status`.
|
|
1476
|
+
*
|
|
1477
|
+
*/
|
|
1478
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
1008
1479
|
}[];
|
|
1009
1480
|
/**
|
|
1010
1481
|
* Whether the blueprint is verified by epilot
|
|
@@ -1327,7 +1798,7 @@ declare namespace Components {
|
|
|
1327
1798
|
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
1328
1799
|
*/
|
|
1329
1800
|
BlueprintJobID;
|
|
1330
|
-
status?: "IN_PROGRESS" | "SUCCESS" | "FAILED";
|
|
1801
|
+
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
1331
1802
|
triggered_at?: string; // date-time
|
|
1332
1803
|
source_org_id?: string;
|
|
1333
1804
|
source_blueprint_id?: /**
|
|
@@ -1716,6 +2187,90 @@ declare namespace Components {
|
|
|
1716
2187
|
* Outcome of this deployment
|
|
1717
2188
|
*/
|
|
1718
2189
|
status?: "IN_PROGRESS" | "SUCCESS" | "PARTIAL_SUCCESS" | "FAILED";
|
|
2190
|
+
/**
|
|
2191
|
+
* Restore lifecycle metadata for this deployment.
|
|
2192
|
+
*/
|
|
2193
|
+
restore_details?: {
|
|
2194
|
+
/**
|
|
2195
|
+
* Whether this sync changed destination resources in a way that can
|
|
2196
|
+
* be reverted. `false` means the sync completed without create,
|
|
2197
|
+
* update, internal-update, or delete impacts, so there is no revert
|
|
2198
|
+
* action to offer.
|
|
2199
|
+
*
|
|
2200
|
+
*/
|
|
2201
|
+
has_revertible_changes?: boolean;
|
|
2202
|
+
/**
|
|
2203
|
+
* Counts of resource impact values from the V3 apply result.
|
|
2204
|
+
*/
|
|
2205
|
+
resource_impact_summary?: {
|
|
2206
|
+
create?: number;
|
|
2207
|
+
update?: number;
|
|
2208
|
+
internal_update?: number;
|
|
2209
|
+
delete?: number;
|
|
2210
|
+
no_op?: number;
|
|
2211
|
+
ignored?: number;
|
|
2212
|
+
};
|
|
2213
|
+
/**
|
|
2214
|
+
* BlueprintInstallationJob id of the most recent restore that ran
|
|
2215
|
+
* against this deployment. Used by the FE to keep the restore-status
|
|
2216
|
+
* badge visible across page reloads. Frontends poll this job to
|
|
2217
|
+
* render the latest restore outcome.
|
|
2218
|
+
*
|
|
2219
|
+
*/
|
|
2220
|
+
last_restore_job_id?: string;
|
|
2221
|
+
/**
|
|
2222
|
+
* Timestamp of the most recent restore that ran against this
|
|
2223
|
+
* deployment. Stamped when the restore sweep finishes. Used by the
|
|
2224
|
+
* FE to show when a sync was reverted.
|
|
2225
|
+
*
|
|
2226
|
+
*/
|
|
2227
|
+
last_restore_at?: string; // date-time
|
|
2228
|
+
/**
|
|
2229
|
+
* Identity of the caller who triggered the most recent restore.
|
|
2230
|
+
* Stamped when the restore sweep finishes. Used by the FE to show
|
|
2231
|
+
* who reverted a sync.
|
|
2232
|
+
*
|
|
2233
|
+
*/
|
|
2234
|
+
last_restored_by?: {
|
|
2235
|
+
/**
|
|
2236
|
+
* Display name (email or token name) of the restorer.
|
|
2237
|
+
*/
|
|
2238
|
+
name?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* User id of the restorer, when triggered by a user.
|
|
2241
|
+
*/
|
|
2242
|
+
user_id?: string;
|
|
2243
|
+
};
|
|
2244
|
+
/**
|
|
2245
|
+
* Computed server-side from `(job_id, restore_details.last_restore_job_id, installation_status)`.
|
|
2246
|
+
* `available` when the deployment is restorable but has no prior
|
|
2247
|
+
* restore (including pure-create deployments without `snapshot_id`,
|
|
2248
|
+
* reverted via sweep-only);
|
|
2249
|
+
* `in_progress` while an install or restore is running on this
|
|
2250
|
+
* blueprint instance;
|
|
2251
|
+
* `restored` / `partially_restored` / `restore_failed` reflect the
|
|
2252
|
+
* terminal status of the job referenced by `last_restore_job_id`;
|
|
2253
|
+
* `unavailable` means there is no revert action, for example
|
|
2254
|
+
* malformed deployment rows missing `job_id` or no-change syncs.
|
|
2255
|
+
*
|
|
2256
|
+
*/
|
|
2257
|
+
status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
2258
|
+
};
|
|
2259
|
+
/**
|
|
2260
|
+
* Deprecated. Use `restore_details.has_revertible_changes`.
|
|
2261
|
+
*
|
|
2262
|
+
*/
|
|
2263
|
+
has_revertible_changes?: boolean;
|
|
2264
|
+
/**
|
|
2265
|
+
* Deprecated. Use `restore_details.last_restore_job_id`.
|
|
2266
|
+
*
|
|
2267
|
+
*/
|
|
2268
|
+
last_restore_job_id?: string;
|
|
2269
|
+
/**
|
|
2270
|
+
* Deprecated. Use `restore_details.status`.
|
|
2271
|
+
*
|
|
2272
|
+
*/
|
|
2273
|
+
restore_status?: "available" | "in_progress" | "restored" | "partially_restored" | "restore_failed" | "unavailable";
|
|
1719
2274
|
}[];
|
|
1720
2275
|
/**
|
|
1721
2276
|
* Whether the blueprint is verified by epilot
|
|
@@ -2006,6 +2561,45 @@ declare namespace Components {
|
|
|
2006
2561
|
field_diffs?: FieldDiff[];
|
|
2007
2562
|
error?: string;
|
|
2008
2563
|
}
|
|
2564
|
+
export interface RestoreOutcome {
|
|
2565
|
+
/**
|
|
2566
|
+
* The snapshot driving Phase 1 of the restore. Null/absent for
|
|
2567
|
+
* sweep-only restores (pure-create deployments with no captured
|
|
2568
|
+
* manifest).
|
|
2569
|
+
*
|
|
2570
|
+
*/
|
|
2571
|
+
snapshot_id?: string | null;
|
|
2572
|
+
resources?: RestoreOutcomeItem[];
|
|
2573
|
+
}
|
|
2574
|
+
export interface RestoreOutcomeItem {
|
|
2575
|
+
lineage_id: string;
|
|
2576
|
+
type: string;
|
|
2577
|
+
name?: string | null;
|
|
2578
|
+
target_id?: string | null;
|
|
2579
|
+
/**
|
|
2580
|
+
* On `restore-preview`: the action the restore would take.
|
|
2581
|
+
* On `restore_result`: the action that was applied.
|
|
2582
|
+
* `failed` only appears on `restore_result`.
|
|
2583
|
+
*
|
|
2584
|
+
*/
|
|
2585
|
+
action: "restore" | "delete" | "skip" | "failed";
|
|
2586
|
+
/**
|
|
2587
|
+
* Only set when `action == skip`.
|
|
2588
|
+
*/
|
|
2589
|
+
reason?: "modified" | "co_owned" | "delete_unsupported" | "heuristic_match";
|
|
2590
|
+
/**
|
|
2591
|
+
* Only set when `reason == modified`. From the lineage row's last install write.
|
|
2592
|
+
*/
|
|
2593
|
+
last_synced_at?: string | null; // date-time
|
|
2594
|
+
/**
|
|
2595
|
+
* Only set when `reason == modified`. From the destination resource's current state.
|
|
2596
|
+
*/
|
|
2597
|
+
current_updated_at?: string | null; // date-time
|
|
2598
|
+
/**
|
|
2599
|
+
* Only set when `action == failed`.
|
|
2600
|
+
*/
|
|
2601
|
+
error_message?: string | null;
|
|
2602
|
+
}
|
|
2009
2603
|
export interface RootResourceNode {
|
|
2010
2604
|
/**
|
|
2011
2605
|
* ID of the resource
|
|
@@ -2107,6 +2701,20 @@ declare namespace Components {
|
|
|
2107
2701
|
*/
|
|
2108
2702
|
add_dependencies_recommended?: boolean;
|
|
2109
2703
|
}
|
|
2704
|
+
export interface UniquenessCriteria {
|
|
2705
|
+
org_id: string;
|
|
2706
|
+
resource_type: /* Resource type for which custom uniqueness criteria can be configured. */ UniquenessCriteriaResourceType;
|
|
2707
|
+
fields: [
|
|
2708
|
+
string,
|
|
2709
|
+
...string[]
|
|
2710
|
+
];
|
|
2711
|
+
updated_at: string; // date-time
|
|
2712
|
+
updated_by?: string;
|
|
2713
|
+
}
|
|
2714
|
+
/**
|
|
2715
|
+
* Resource type for which custom uniqueness criteria can be configured.
|
|
2716
|
+
*/
|
|
2717
|
+
export type UniquenessCriteriaResourceType = "emailtemplate" | "product" | "price" | "tax" | "coupon" | "product_recommendation" | "file" | "document_template" | "schema" | "taxonomy" | "notification_template" | "family" | "permission" | "journey";
|
|
2110
2718
|
export interface UploadFilePayload {
|
|
2111
2719
|
/**
|
|
2112
2720
|
* example:
|
|
@@ -2612,6 +3220,12 @@ declare namespace Paths {
|
|
|
2612
3220
|
}
|
|
2613
3221
|
}
|
|
2614
3222
|
}
|
|
3223
|
+
namespace DeleteUniquenessCriteria {
|
|
3224
|
+
namespace Responses {
|
|
3225
|
+
export interface $204 {
|
|
3226
|
+
}
|
|
3227
|
+
}
|
|
3228
|
+
}
|
|
2615
3229
|
namespace DetectPatchChanges {
|
|
2616
3230
|
namespace Parameters {
|
|
2617
3231
|
export type BlueprintId = /**
|
|
@@ -2981,6 +3595,38 @@ declare namespace Paths {
|
|
|
2981
3595
|
}
|
|
2982
3596
|
}
|
|
2983
3597
|
}
|
|
3598
|
+
namespace GetRestorePreview {
|
|
3599
|
+
namespace Parameters {
|
|
3600
|
+
export type BlueprintId = /**
|
|
3601
|
+
* ID of a blueprint
|
|
3602
|
+
* example:
|
|
3603
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3604
|
+
*/
|
|
3605
|
+
Components.Schemas.BlueprintID;
|
|
3606
|
+
export type JobId = /**
|
|
3607
|
+
* ID of a job
|
|
3608
|
+
* example:
|
|
3609
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3610
|
+
*/
|
|
3611
|
+
Components.Schemas.BlueprintJobID;
|
|
3612
|
+
}
|
|
3613
|
+
export interface PathParameters {
|
|
3614
|
+
blueprint_id: Parameters.BlueprintId;
|
|
3615
|
+
job_id: Parameters.JobId;
|
|
3616
|
+
}
|
|
3617
|
+
namespace Responses {
|
|
3618
|
+
export type $200 = Components.Schemas.RestoreOutcome;
|
|
3619
|
+
export interface $404 {
|
|
3620
|
+
}
|
|
3621
|
+
}
|
|
3622
|
+
}
|
|
3623
|
+
namespace GetUniquenessCriteria {
|
|
3624
|
+
namespace Responses {
|
|
3625
|
+
export type $200 = Components.Schemas.UniquenessCriteria;
|
|
3626
|
+
export interface $404 {
|
|
3627
|
+
}
|
|
3628
|
+
}
|
|
3629
|
+
}
|
|
2984
3630
|
namespace InstallBlueprint {
|
|
2985
3631
|
export interface RequestBody {
|
|
2986
3632
|
source_org_id?: string;
|
|
@@ -3247,6 +3893,13 @@ declare namespace Paths {
|
|
|
3247
3893
|
}
|
|
3248
3894
|
}
|
|
3249
3895
|
}
|
|
3896
|
+
namespace ListUniquenessCriteria {
|
|
3897
|
+
namespace Responses {
|
|
3898
|
+
export interface $200 {
|
|
3899
|
+
results?: Components.Schemas.UniquenessCriteria[];
|
|
3900
|
+
}
|
|
3901
|
+
}
|
|
3902
|
+
}
|
|
3250
3903
|
namespace PreInstallBlueprint {
|
|
3251
3904
|
export interface RequestBody {
|
|
3252
3905
|
/**
|
|
@@ -3316,6 +3969,62 @@ declare namespace Paths {
|
|
|
3316
3969
|
}
|
|
3317
3970
|
}
|
|
3318
3971
|
}
|
|
3972
|
+
namespace PutUniquenessCriteria {
|
|
3973
|
+
export interface RequestBody {
|
|
3974
|
+
fields: [
|
|
3975
|
+
string,
|
|
3976
|
+
...string[]
|
|
3977
|
+
];
|
|
3978
|
+
}
|
|
3979
|
+
namespace Responses {
|
|
3980
|
+
export type $200 = Components.Schemas.UniquenessCriteria;
|
|
3981
|
+
export interface $400 {
|
|
3982
|
+
}
|
|
3983
|
+
}
|
|
3984
|
+
}
|
|
3985
|
+
namespace RestoreBlueprintDeploymentV3 {
|
|
3986
|
+
namespace Parameters {
|
|
3987
|
+
export type BlueprintId = /**
|
|
3988
|
+
* ID of a blueprint
|
|
3989
|
+
* example:
|
|
3990
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3991
|
+
*/
|
|
3992
|
+
Components.Schemas.BlueprintID;
|
|
3993
|
+
export type JobId = /**
|
|
3994
|
+
* ID of a job
|
|
3995
|
+
* example:
|
|
3996
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
3997
|
+
*/
|
|
3998
|
+
Components.Schemas.BlueprintJobID;
|
|
3999
|
+
}
|
|
4000
|
+
export interface PathParameters {
|
|
4001
|
+
blueprint_id: Parameters.BlueprintId;
|
|
4002
|
+
job_id: Parameters.JobId;
|
|
4003
|
+
}
|
|
4004
|
+
namespace Responses {
|
|
4005
|
+
export interface $202 {
|
|
4006
|
+
job_id?: /**
|
|
4007
|
+
* ID of a job
|
|
4008
|
+
* example:
|
|
4009
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4010
|
+
*/
|
|
4011
|
+
Components.Schemas.BlueprintJobID;
|
|
4012
|
+
blueprint_instance_id?: /**
|
|
4013
|
+
* ID of a blueprint
|
|
4014
|
+
* example:
|
|
4015
|
+
* c2d6cac8-bdd5-4ea2-8a6c-1cbdbe77b341
|
|
4016
|
+
*/
|
|
4017
|
+
Components.Schemas.BlueprintID;
|
|
4018
|
+
snapshot_id?: string;
|
|
4019
|
+
}
|
|
4020
|
+
export interface $400 {
|
|
4021
|
+
}
|
|
4022
|
+
export interface $404 {
|
|
4023
|
+
}
|
|
4024
|
+
export interface $409 {
|
|
4025
|
+
}
|
|
4026
|
+
}
|
|
4027
|
+
}
|
|
3319
4028
|
namespace RetryPatchOrg {
|
|
3320
4029
|
namespace Parameters {
|
|
3321
4030
|
export type BlueprintId = /**
|
|
@@ -3479,6 +4188,14 @@ declare namespace Paths {
|
|
|
3479
4188
|
}
|
|
3480
4189
|
}
|
|
3481
4190
|
}
|
|
4191
|
+
namespace V1BlueprintManifestUniquenessCriteria$ResourceType {
|
|
4192
|
+
namespace Parameters {
|
|
4193
|
+
export type ResourceType = /* Resource type for which custom uniqueness criteria can be configured. */ Components.Schemas.UniquenessCriteriaResourceType;
|
|
4194
|
+
}
|
|
4195
|
+
export interface PathParameters {
|
|
4196
|
+
resource_type: Parameters.ResourceType;
|
|
4197
|
+
}
|
|
4198
|
+
}
|
|
3482
4199
|
namespace ValidateBlueprint {
|
|
3483
4200
|
namespace Parameters {
|
|
3484
4201
|
export type BlueprintId = /**
|
|
@@ -4144,6 +4861,55 @@ export interface OperationMethods {
|
|
|
4144
4861
|
data?: Paths.InstallBlueprintV3.RequestBody,
|
|
4145
4862
|
config?: AxiosRequestConfig
|
|
4146
4863
|
): OperationResponse<Paths.InstallBlueprintV3.Responses.$202>
|
|
4864
|
+
/**
|
|
4865
|
+
* restoreBlueprintDeploymentV3 - Restore a specific deployment by job_id
|
|
4866
|
+
*
|
|
4867
|
+
* Roll a deployment back to its pre-install state. Two phases:
|
|
4868
|
+
*
|
|
4869
|
+
* 1. Upsert — re-applies the captured payloads via snapshot-api's
|
|
4870
|
+
* `:restore` (server-side; runs config-engine.apply with captured
|
|
4871
|
+
* target ids pre-seeded). Skipped for pure-create deployments
|
|
4872
|
+
* whose snapshot was empty.
|
|
4873
|
+
* 2. Delete sweep — for lineage rows of this blueprint instance not
|
|
4874
|
+
* present in the snapshot's captured set, deletes the live
|
|
4875
|
+
* resource via the type's adapter. Co-ownership / drift /
|
|
4876
|
+
* no-delete-capability skip the entry with the corresponding
|
|
4877
|
+
* reason.
|
|
4878
|
+
*
|
|
4879
|
+
* Resolves `(blueprint_id, job_id)` to the entry in
|
|
4880
|
+
* `Blueprint.deployments[]` and reads its `snapshot_id` and
|
|
4881
|
+
* `destination_blueprint_id` — the caller never needs to handle
|
|
4882
|
+
* snapshot ids directly.
|
|
4883
|
+
*
|
|
4884
|
+
* Async — returns 202 with a job id. Poll the job to track progress.
|
|
4885
|
+
* The per-instance lock (`installation_status === 'IN_PROGRESS'`)
|
|
4886
|
+
* rejects concurrent installs or restores with 409.
|
|
4887
|
+
*
|
|
4888
|
+
*/
|
|
4889
|
+
'restoreBlueprintDeploymentV3'(
|
|
4890
|
+
parameters?: Parameters<Paths.RestoreBlueprintDeploymentV3.PathParameters> | null,
|
|
4891
|
+
data?: any,
|
|
4892
|
+
config?: AxiosRequestConfig
|
|
4893
|
+
): OperationResponse<Paths.RestoreBlueprintDeploymentV3.Responses.$202>
|
|
4894
|
+
/**
|
|
4895
|
+
* getRestorePreview - Predicted outcome of reverting a deployment
|
|
4896
|
+
*
|
|
4897
|
+
* Computes what would happen if the user triggered a restore on this
|
|
4898
|
+
* deployment, without performing any writes. The forecast uses the
|
|
4899
|
+
* snapshot's captured resources (when present) plus the current lineage
|
|
4900
|
+
* state plus per-adapter gates (co-ownership, no-delete-capability,
|
|
4901
|
+
* heuristic-match, drift when wired).
|
|
4902
|
+
*
|
|
4903
|
+
* Idempotent and side-effect free. Safe to call repeatedly. The result
|
|
4904
|
+
* may shift between calls if operators edit destination resources or
|
|
4905
|
+
* another blueprint adopts a shared resource in the meantime.
|
|
4906
|
+
*
|
|
4907
|
+
*/
|
|
4908
|
+
'getRestorePreview'(
|
|
4909
|
+
parameters?: Parameters<Paths.GetRestorePreview.PathParameters> | null,
|
|
4910
|
+
data?: any,
|
|
4911
|
+
config?: AxiosRequestConfig
|
|
4912
|
+
): OperationResponse<Paths.GetRestorePreview.Responses.$200>
|
|
4147
4913
|
/**
|
|
4148
4914
|
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
4149
4915
|
*
|
|
@@ -4156,6 +4922,53 @@ export interface OperationMethods {
|
|
|
4156
4922
|
data?: any,
|
|
4157
4923
|
config?: AxiosRequestConfig
|
|
4158
4924
|
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
4925
|
+
/**
|
|
4926
|
+
* listUniquenessCriteria - listUniquenessCriteria
|
|
4927
|
+
*
|
|
4928
|
+
* List all custom uniqueness criteria configured for the caller's organization.
|
|
4929
|
+
* These overrides are applied during install (V2 and V3) when matching incoming
|
|
4930
|
+
* resources against existing ones in the destination org, replacing the default
|
|
4931
|
+
* per-resource-type field set with the caller's chosen fields (AND-combined).
|
|
4932
|
+
*
|
|
4933
|
+
*/
|
|
4934
|
+
'listUniquenessCriteria'(
|
|
4935
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
4936
|
+
data?: any,
|
|
4937
|
+
config?: AxiosRequestConfig
|
|
4938
|
+
): OperationResponse<Paths.ListUniquenessCriteria.Responses.$200>
|
|
4939
|
+
/**
|
|
4940
|
+
* getUniquenessCriteria - getUniquenessCriteria
|
|
4941
|
+
*
|
|
4942
|
+
* Get the configured uniqueness criteria for a specific resource type, if any.
|
|
4943
|
+
*/
|
|
4944
|
+
'getUniquenessCriteria'(
|
|
4945
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
4946
|
+
data?: any,
|
|
4947
|
+
config?: AxiosRequestConfig
|
|
4948
|
+
): OperationResponse<Paths.GetUniquenessCriteria.Responses.$200>
|
|
4949
|
+
/**
|
|
4950
|
+
* putUniquenessCriteria - putUniquenessCriteria
|
|
4951
|
+
*
|
|
4952
|
+
* Set or replace the uniqueness criteria for a resource type. The provided fields
|
|
4953
|
+
* must be valid attributes on the resource's schema (the UI typically loads the
|
|
4954
|
+
* schema to populate options). All listed fields are AND-combined during matching.
|
|
4955
|
+
*
|
|
4956
|
+
*/
|
|
4957
|
+
'putUniquenessCriteria'(
|
|
4958
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
4959
|
+
data?: Paths.PutUniquenessCriteria.RequestBody,
|
|
4960
|
+
config?: AxiosRequestConfig
|
|
4961
|
+
): OperationResponse<Paths.PutUniquenessCriteria.Responses.$200>
|
|
4962
|
+
/**
|
|
4963
|
+
* deleteUniquenessCriteria - deleteUniquenessCriteria
|
|
4964
|
+
*
|
|
4965
|
+
* Remove the custom criteria for a resource type, reverting to the default fields.
|
|
4966
|
+
*/
|
|
4967
|
+
'deleteUniquenessCriteria'(
|
|
4968
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
4969
|
+
data?: any,
|
|
4970
|
+
config?: AxiosRequestConfig
|
|
4971
|
+
): OperationResponse<Paths.DeleteUniquenessCriteria.Responses.$204>
|
|
4159
4972
|
}
|
|
4160
4973
|
|
|
4161
4974
|
export interface PathsDictionary {
|
|
@@ -4822,6 +5635,59 @@ export interface PathsDictionary {
|
|
|
4822
5635
|
config?: AxiosRequestConfig
|
|
4823
5636
|
): OperationResponse<Paths.InstallBlueprintV3.Responses.$202>
|
|
4824
5637
|
}
|
|
5638
|
+
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}:restore']: {
|
|
5639
|
+
/**
|
|
5640
|
+
* restoreBlueprintDeploymentV3 - Restore a specific deployment by job_id
|
|
5641
|
+
*
|
|
5642
|
+
* Roll a deployment back to its pre-install state. Two phases:
|
|
5643
|
+
*
|
|
5644
|
+
* 1. Upsert — re-applies the captured payloads via snapshot-api's
|
|
5645
|
+
* `:restore` (server-side; runs config-engine.apply with captured
|
|
5646
|
+
* target ids pre-seeded). Skipped for pure-create deployments
|
|
5647
|
+
* whose snapshot was empty.
|
|
5648
|
+
* 2. Delete sweep — for lineage rows of this blueprint instance not
|
|
5649
|
+
* present in the snapshot's captured set, deletes the live
|
|
5650
|
+
* resource via the type's adapter. Co-ownership / drift /
|
|
5651
|
+
* no-delete-capability skip the entry with the corresponding
|
|
5652
|
+
* reason.
|
|
5653
|
+
*
|
|
5654
|
+
* Resolves `(blueprint_id, job_id)` to the entry in
|
|
5655
|
+
* `Blueprint.deployments[]` and reads its `snapshot_id` and
|
|
5656
|
+
* `destination_blueprint_id` — the caller never needs to handle
|
|
5657
|
+
* snapshot ids directly.
|
|
5658
|
+
*
|
|
5659
|
+
* Async — returns 202 with a job id. Poll the job to track progress.
|
|
5660
|
+
* The per-instance lock (`installation_status === 'IN_PROGRESS'`)
|
|
5661
|
+
* rejects concurrent installs or restores with 409.
|
|
5662
|
+
*
|
|
5663
|
+
*/
|
|
5664
|
+
'post'(
|
|
5665
|
+
parameters?: Parameters<Paths.RestoreBlueprintDeploymentV3.PathParameters> | null,
|
|
5666
|
+
data?: any,
|
|
5667
|
+
config?: AxiosRequestConfig
|
|
5668
|
+
): OperationResponse<Paths.RestoreBlueprintDeploymentV3.Responses.$202>
|
|
5669
|
+
}
|
|
5670
|
+
['/v3/blueprint-manifest/blueprints/{blueprint_id}/deployments/{job_id}/restore-preview']: {
|
|
5671
|
+
/**
|
|
5672
|
+
* getRestorePreview - Predicted outcome of reverting a deployment
|
|
5673
|
+
*
|
|
5674
|
+
* Computes what would happen if the user triggered a restore on this
|
|
5675
|
+
* deployment, without performing any writes. The forecast uses the
|
|
5676
|
+
* snapshot's captured resources (when present) plus the current lineage
|
|
5677
|
+
* state plus per-adapter gates (co-ownership, no-delete-capability,
|
|
5678
|
+
* heuristic-match, drift when wired).
|
|
5679
|
+
*
|
|
5680
|
+
* Idempotent and side-effect free. Safe to call repeatedly. The result
|
|
5681
|
+
* may shift between calls if operators edit destination resources or
|
|
5682
|
+
* another blueprint adopts a shared resource in the meantime.
|
|
5683
|
+
*
|
|
5684
|
+
*/
|
|
5685
|
+
'get'(
|
|
5686
|
+
parameters?: Parameters<Paths.GetRestorePreview.PathParameters> | null,
|
|
5687
|
+
data?: any,
|
|
5688
|
+
config?: AxiosRequestConfig
|
|
5689
|
+
): OperationResponse<Paths.GetRestorePreview.Responses.$200>
|
|
5690
|
+
}
|
|
4825
5691
|
['/v3/blueprint-manifest/blueprints/{blueprint_id}/lineage']: {
|
|
4826
5692
|
/**
|
|
4827
5693
|
* getBlueprintLineageV3 - Get Blueprint Lineage V3
|
|
@@ -4836,6 +5702,57 @@ export interface PathsDictionary {
|
|
|
4836
5702
|
config?: AxiosRequestConfig
|
|
4837
5703
|
): OperationResponse<Paths.GetBlueprintLineageV3.Responses.$200>
|
|
4838
5704
|
}
|
|
5705
|
+
['/v1/blueprint-manifest/uniqueness-criteria']: {
|
|
5706
|
+
/**
|
|
5707
|
+
* listUniquenessCriteria - listUniquenessCriteria
|
|
5708
|
+
*
|
|
5709
|
+
* List all custom uniqueness criteria configured for the caller's organization.
|
|
5710
|
+
* These overrides are applied during install (V2 and V3) when matching incoming
|
|
5711
|
+
* resources against existing ones in the destination org, replacing the default
|
|
5712
|
+
* per-resource-type field set with the caller's chosen fields (AND-combined).
|
|
5713
|
+
*
|
|
5714
|
+
*/
|
|
5715
|
+
'get'(
|
|
5716
|
+
parameters?: Parameters<UnknownParamsObject> | null,
|
|
5717
|
+
data?: any,
|
|
5718
|
+
config?: AxiosRequestConfig
|
|
5719
|
+
): OperationResponse<Paths.ListUniquenessCriteria.Responses.$200>
|
|
5720
|
+
}
|
|
5721
|
+
['/v1/blueprint-manifest/uniqueness-criteria/{resource_type}']: {
|
|
5722
|
+
/**
|
|
5723
|
+
* getUniquenessCriteria - getUniquenessCriteria
|
|
5724
|
+
*
|
|
5725
|
+
* Get the configured uniqueness criteria for a specific resource type, if any.
|
|
5726
|
+
*/
|
|
5727
|
+
'get'(
|
|
5728
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
5729
|
+
data?: any,
|
|
5730
|
+
config?: AxiosRequestConfig
|
|
5731
|
+
): OperationResponse<Paths.GetUniquenessCriteria.Responses.$200>
|
|
5732
|
+
/**
|
|
5733
|
+
* putUniquenessCriteria - putUniquenessCriteria
|
|
5734
|
+
*
|
|
5735
|
+
* Set or replace the uniqueness criteria for a resource type. The provided fields
|
|
5736
|
+
* must be valid attributes on the resource's schema (the UI typically loads the
|
|
5737
|
+
* schema to populate options). All listed fields are AND-combined during matching.
|
|
5738
|
+
*
|
|
5739
|
+
*/
|
|
5740
|
+
'put'(
|
|
5741
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
5742
|
+
data?: Paths.PutUniquenessCriteria.RequestBody,
|
|
5743
|
+
config?: AxiosRequestConfig
|
|
5744
|
+
): OperationResponse<Paths.PutUniquenessCriteria.Responses.$200>
|
|
5745
|
+
/**
|
|
5746
|
+
* deleteUniquenessCriteria - deleteUniquenessCriteria
|
|
5747
|
+
*
|
|
5748
|
+
* Remove the custom criteria for a resource type, reverting to the default fields.
|
|
5749
|
+
*/
|
|
5750
|
+
'delete'(
|
|
5751
|
+
parameters?: Parameters<Paths.V1BlueprintManifestUniquenessCriteria$ResourceType.PathParameters> | null,
|
|
5752
|
+
data?: any,
|
|
5753
|
+
config?: AxiosRequestConfig
|
|
5754
|
+
): OperationResponse<Paths.DeleteUniquenessCriteria.Responses.$204>
|
|
5755
|
+
}
|
|
4839
5756
|
}
|
|
4840
5757
|
|
|
4841
5758
|
export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
@@ -4857,6 +5774,7 @@ export type BlueprintPatchWithResults = Components.Schemas.BlueprintPatchWithRes
|
|
|
4857
5774
|
export type BlueprintPreview = Components.Schemas.BlueprintPreview;
|
|
4858
5775
|
export type BlueprintResource = Components.Schemas.BlueprintResource;
|
|
4859
5776
|
export type BlueprintResourceID = Components.Schemas.BlueprintResourceID;
|
|
5777
|
+
export type BlueprintRestoreJob = Components.Schemas.BlueprintRestoreJob;
|
|
4860
5778
|
export type BlueprintValidateJob = Components.Schemas.BlueprintValidateJob;
|
|
4861
5779
|
export type BlueprintVerificationJob = Components.Schemas.BlueprintVerificationJob;
|
|
4862
5780
|
export type CallerIdentity = Components.Schemas.CallerIdentity;
|
|
@@ -4899,11 +5817,15 @@ export type ResourceNode = Components.Schemas.ResourceNode;
|
|
|
4899
5817
|
export type ResourceNodeType = Components.Schemas.ResourceNodeType;
|
|
4900
5818
|
export type ResourceReplacement = Components.Schemas.ResourceReplacement;
|
|
4901
5819
|
export type ResourceVerificationResult = Components.Schemas.ResourceVerificationResult;
|
|
5820
|
+
export type RestoreOutcome = Components.Schemas.RestoreOutcome;
|
|
5821
|
+
export type RestoreOutcomeItem = Components.Schemas.RestoreOutcomeItem;
|
|
4902
5822
|
export type RootResourceNode = Components.Schemas.RootResourceNode;
|
|
4903
5823
|
export type S3Reference = Components.Schemas.S3Reference;
|
|
4904
5824
|
export type SelectedResources = Components.Schemas.SelectedResources;
|
|
4905
5825
|
export type SuggestBlueprintResourcesRequest = Components.Schemas.SuggestBlueprintResourcesRequest;
|
|
4906
5826
|
export type SuggestBlueprintResourcesResponse = Components.Schemas.SuggestBlueprintResourcesResponse;
|
|
5827
|
+
export type UniquenessCriteria = Components.Schemas.UniquenessCriteria;
|
|
5828
|
+
export type UniquenessCriteriaResourceType = Components.Schemas.UniquenessCriteriaResourceType;
|
|
4907
5829
|
export type UploadFilePayload = Components.Schemas.UploadFilePayload;
|
|
4908
5830
|
export type V3ResourceProgressEntry = Components.Schemas.V3ResourceProgressEntry;
|
|
4909
5831
|
export type VerificationSummary = Components.Schemas.VerificationSummary;
|