@confighub/api 0.8.11 → 0.8.12
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/index.d.cts +84 -22
- package/dist/index.d.ts +84 -22
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -97,7 +97,7 @@ interface paths {
|
|
|
97
97
|
put?: never;
|
|
98
98
|
/**
|
|
99
99
|
* Record Attestations across Spaces
|
|
100
|
-
* @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision.
|
|
100
|
+
* @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision. When ChangeOrderID is given it defaults to the Revision a Release of the change would bundle, which the ChangeOrder's release Tag marks, or to the one its end Tag marks for a Unit the release Tag does not mark, so the approval satisfies its entry and release gates alike; it defaults to the head Revision otherwise. Each Space is recorded on its own and reported on its own.
|
|
101
101
|
*/
|
|
102
102
|
post: operations["Attest"];
|
|
103
103
|
delete?: never;
|
|
@@ -4114,12 +4114,28 @@ interface components {
|
|
|
4114
4114
|
};
|
|
4115
4115
|
/** @description Permissions to access this change order. */
|
|
4116
4116
|
Permissions?: components["schemas"]["Permissions"];
|
|
4117
|
+
/**
|
|
4118
|
+
* @description How the ChangeOrder marks the Units its change does not change, and the default PriorRevisions for its promotions. Include (the default), Skip and Error mark such a Unit at the Revision its followers have taken, or at its LastReleasedRevisionNum when that is later, or at its head if it has neither, so promoting the change does not move it; a promotion then merges a changed Unit's Revisions from before the change (Include), passes over them for good (Skip), or refuses (Error). All marks every such Unit at its head, so promoting the change brings every Unit up to the Space it takes from. Immutable: the ChangeOrder's own Space is marked when it is created.
|
|
4119
|
+
* @enum {string}
|
|
4120
|
+
*/
|
|
4121
|
+
PriorRevisions?: ChangeOrderPriorRevisions;
|
|
4117
4122
|
/** @description PromotionFailures records each promotion that did not complete: who ran it, when, into which Stage, and each Space it failed or was blocked in, with the Space's error or reason and the error of each Unit and Link whose write failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
4118
4123
|
readonly PromotionFailures?: components["schemas"]["ChangeOrderPromotionFailure"][];
|
|
4119
4124
|
/** @description PromotionOverrides records each promotion forced into a Stage whose gates did not hold: who forced it, when, into which Stage and Spaces, why, and which gates failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
4120
4125
|
readonly PromotionOverrides?: components["schemas"]["ChangeOrderPromotionOverride"][];
|
|
4121
4126
|
/** @description Promotions records each promotion that wrote the change into Spaces: who ran it, when, into which Stage, and which Spaces. A promotion entering several Stages records one entry per Stage. The most recent entries are kept. Set by the server. (readonly) */
|
|
4122
4127
|
readonly Promotions?: components["schemas"]["ChangeOrderPromotion"][];
|
|
4128
|
+
/**
|
|
4129
|
+
* @description What a Release of the ChangeOrder does with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum, up to the one the start Tag marks. Include (the default) releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. A publish's PriorRevisions overrides it.
|
|
4130
|
+
* @enum {string}
|
|
4131
|
+
*/
|
|
4132
|
+
ReleasePriorRevisions?: ChangeOrderReleasePriorRevisions;
|
|
4133
|
+
/**
|
|
4134
|
+
* Format: uuid
|
|
4135
|
+
* @description ReleaseTagID is the Tag a Release of the ChangeOrder is published at. It marks one Revision of each releasable Unit (ProviderType empty or OCI) in every Space the change is in: the Revision the end Tag marks, or the head where the Unit does not carry it. It follows Revisions the resolve processor makes after the promotion, and can be moved with a tag move, until a Release in the Space has been published at it. Empty on ChangeOrders created before it existed.
|
|
4136
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4137
|
+
*/
|
|
4138
|
+
readonly ReleaseTagID?: string;
|
|
4123
4139
|
/** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
|
|
4124
4140
|
readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
4125
4141
|
/** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. A Space with no ReleaseTargetID is never here, since nothing releases it. Derived when the ChangeOrder is read. */
|
|
@@ -4180,6 +4196,12 @@ interface components {
|
|
|
4180
4196
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
4181
4197
|
*/
|
|
4182
4198
|
readonly UpdatedAt?: string;
|
|
4199
|
+
/**
|
|
4200
|
+
* Format: uuid
|
|
4201
|
+
* @description The User who created the ChangeOrder. Absent for ChangeOrders created before it was recorded. (readonly)
|
|
4202
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4203
|
+
*/
|
|
4204
|
+
readonly UserID?: string;
|
|
4183
4205
|
/**
|
|
4184
4206
|
* Format: int64
|
|
4185
4207
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
@@ -4584,7 +4606,7 @@ interface components {
|
|
|
4584
4606
|
ChangeWorkflowStage: {
|
|
4585
4607
|
/** @description Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */
|
|
4586
4608
|
Name: string;
|
|
4587
|
-
/** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage
|
|
4609
|
+
/** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage before this one; the first stage's are evaluated over the Space the ChangeOrder resides in, and refused for Invoke and fan-out ChangeOrders, whose change is in no Space before it is promoted. */
|
|
4588
4610
|
Prerequisites?: string[];
|
|
4589
4611
|
/** @description Gates on publishing a Release for a change order in one of the stage's Spaces, each naming one declared in AttestationPrerequisites. Evaluated over the Revisions the Release bundles. */
|
|
4590
4612
|
ReleasePrerequisites?: string[];
|
|
@@ -4914,6 +4936,7 @@ interface components {
|
|
|
4914
4936
|
Error?: components["schemas"]["ResponseError"];
|
|
4915
4937
|
Invocation?: components["schemas"]["Invocation"];
|
|
4916
4938
|
Organization?: components["schemas"]["Organization"];
|
|
4939
|
+
ReleaseTag?: components["schemas"]["Tag"];
|
|
4917
4940
|
RestoreTag?: components["schemas"]["Tag"];
|
|
4918
4941
|
Space?: components["schemas"]["Space"];
|
|
4919
4942
|
SpaceFilter?: components["schemas"]["Filter"];
|
|
@@ -6200,7 +6223,7 @@ interface components {
|
|
|
6200
6223
|
/** @description Reasons to record on the paths each Unit write changes. A later operation must be cleared for them before overwriting those paths. Clearance must cover them, since a write is withheld by guards it is not cleared for, its own included. */
|
|
6201
6224
|
Guards?: components["schemas"]["GuardStamp"];
|
|
6202
6225
|
/**
|
|
6203
|
-
* @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include
|
|
6226
|
+
* @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start, and those Revisions do not arrive later; Error refuses, naming the Revisions; All merges them as Include does, and also marks every Unit in the Space the change does not change at its head, so the next promotion brings it up to this Space. Defaults to the ChangeOrder's PriorRevisions, or Include. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range.
|
|
6204
6227
|
* @enum {string}
|
|
6205
6228
|
*/
|
|
6206
6229
|
PriorRevisions?: PromoteRequestPriorRevisions;
|
|
@@ -6298,7 +6321,7 @@ interface components {
|
|
|
6298
6321
|
PreviousHeadMutationNum?: number;
|
|
6299
6322
|
/** Format: int64 */
|
|
6300
6323
|
PreviousHeadRevisionNum?: number;
|
|
6301
|
-
/** @description For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken,
|
|
6324
|
+
/** @description For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, NotChanged when the change does not change the Unit, or CreatedInSpace when the Unit was created in this Space rather than cloned into it. A Unit in the Space that the change does not change is marked once the Space's writes are done, with both Tags on the Revision the ChangeOrder's PriorRevisions names. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head. */
|
|
6302
6325
|
Reason?: string;
|
|
6303
6326
|
Slug?: string;
|
|
6304
6327
|
/**
|
|
@@ -6556,7 +6579,7 @@ interface components {
|
|
|
6556
6579
|
BundleBaseName?: string;
|
|
6557
6580
|
/**
|
|
6558
6581
|
* Format: uuid
|
|
6559
|
-
* @description Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction.
|
|
6582
|
+
* @description Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction. The Release is bundled at the ChangeOrder's release Tag (ReleaseTagID): TagID may be omitted, or name that Tag or the ChangeOrder's end Tag, which is taken to mean it; any other TagID is refused. Naming a ChangeOrder's release Tag as TagID without ChangeOrderID publishes for that ChangeOrder.
|
|
6560
6583
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6561
6584
|
*/
|
|
6562
6585
|
ChangeOrderID?: string;
|
|
@@ -6564,12 +6587,19 @@ interface components {
|
|
|
6564
6587
|
DeleteGates?: {
|
|
6565
6588
|
[key: string]: boolean;
|
|
6566
6589
|
};
|
|
6590
|
+
/** @description Publish in a transaction that is rolled back, returning the Release that would be published, or the error publishing would return: the same ChangeSet, validation and ReleasePrerequisites checks run against the Revisions it would bundle. No event is emitted and no Stage is advanced. */
|
|
6591
|
+
DryRun?: boolean;
|
|
6567
6592
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
6568
6593
|
Labels?: {
|
|
6569
6594
|
[key: string]: string;
|
|
6570
6595
|
};
|
|
6571
6596
|
/** @description Optional Permissions to access the Release. Its publisher is granted Manage in addition. */
|
|
6572
6597
|
Permissions?: components["schemas"]["Permissions"];
|
|
6598
|
+
/**
|
|
6599
|
+
* @description For a Release of a ChangeOrder, what to do with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum up to the one the ChangeOrder's start Tag marks. Include releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. Defaults to the ChangeOrder's ReleasePriorRevisions, or Include.
|
|
6600
|
+
* @enum {string}
|
|
6601
|
+
*/
|
|
6602
|
+
PriorRevisions?: ReleasePublishRequestPriorRevisions;
|
|
6573
6603
|
/**
|
|
6574
6604
|
* Format: uuid
|
|
6575
6605
|
* @description Optional Tag ID identifying the tagged Revision to bundle. For each Unit assigned to the Space's ReleaseTarget, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision is left out of the bundle and listed in the Release's SkippedUnits when it has never been released, and refuses the publish when it has. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-<ReleaseNum>, applies it to each bundled Revision, and sets it as the Release's TagID.
|
|
@@ -8264,6 +8294,8 @@ interface components {
|
|
|
8264
8294
|
MutationSources?: components["schemas"]["ResourceMutationList"];
|
|
8265
8295
|
};
|
|
8266
8296
|
UnitTagRequest: {
|
|
8297
|
+
/** @description Move the Tag from the Revision it marks on each Unit to the one Revision names, refusing a Unit it marks no Revision of. Tags owned by a ChangeSet, ChangeOrder or Release cannot be added or removed; a ChangeOrder's release Tag can be moved, to a Revision at or after the one its end Tag marks and the Unit's LastReleasedRevisionNum, with no ValidationErrors, while no Release in the Space has been published at it. */
|
|
8298
|
+
Move?: boolean;
|
|
8267
8299
|
/** @description Which Unit revision to tag: a named revision ('HeadRevisionNum', 'LastReleasedRevisionNum'), a revision number, an entity reference ('Tag:uuid', 'ChangeSet:uuid', 'Revision:uuid'), any of those prefixed with 'Before:', or 'Remove' to remove the tag from the unit */
|
|
8268
8300
|
Revision?: string;
|
|
8269
8301
|
/**
|
|
@@ -12844,7 +12876,7 @@ interface operations {
|
|
|
12844
12876
|
* An example conjunction is:
|
|
12845
12877
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12846
12878
|
*
|
|
12847
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12879
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
12848
12880
|
*
|
|
12849
12881
|
* The whole string must be query-encoded.
|
|
12850
12882
|
*/
|
|
@@ -12886,7 +12918,7 @@ interface operations {
|
|
|
12886
12918
|
* The attribute names are case-sensitive, PascalCase, and
|
|
12887
12919
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
12888
12920
|
*
|
|
12889
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
12921
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
12890
12922
|
*
|
|
12891
12923
|
* The whole string must be query-encoded.
|
|
12892
12924
|
*/
|
|
@@ -12919,7 +12951,7 @@ interface operations {
|
|
|
12919
12951
|
*
|
|
12920
12952
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
12921
12953
|
*
|
|
12922
|
-
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12954
|
+
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
12923
12955
|
*
|
|
12924
12956
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
12925
12957
|
*
|
|
@@ -13048,7 +13080,7 @@ interface operations {
|
|
|
13048
13080
|
* An example conjunction is:
|
|
13049
13081
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13050
13082
|
*
|
|
13051
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13083
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13052
13084
|
*
|
|
13053
13085
|
* The whole string must be query-encoded.
|
|
13054
13086
|
*/
|
|
@@ -13100,7 +13132,7 @@ interface operations {
|
|
|
13100
13132
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13101
13133
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13102
13134
|
*
|
|
13103
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13135
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13104
13136
|
*
|
|
13105
13137
|
* The whole string must be query-encoded.
|
|
13106
13138
|
*/
|
|
@@ -13212,6 +13244,8 @@ interface operations {
|
|
|
13212
13244
|
Permissions?: {
|
|
13213
13245
|
[key: string]: Record<string, never> | null;
|
|
13214
13246
|
} | null;
|
|
13247
|
+
PriorRevisions?: string | null;
|
|
13248
|
+
ReleasePriorRevisions?: string | null;
|
|
13215
13249
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13216
13250
|
Slug?: string | null;
|
|
13217
13251
|
/** Format: uuid */
|
|
@@ -13350,7 +13384,7 @@ interface operations {
|
|
|
13350
13384
|
* An example conjunction is:
|
|
13351
13385
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13352
13386
|
*
|
|
13353
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13387
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13354
13388
|
*
|
|
13355
13389
|
* The whole string must be query-encoded.
|
|
13356
13390
|
*/
|
|
@@ -13402,7 +13436,7 @@ interface operations {
|
|
|
13402
13436
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13403
13437
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13404
13438
|
*
|
|
13405
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13439
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13406
13440
|
*
|
|
13407
13441
|
* The whole string must be query-encoded.
|
|
13408
13442
|
*/
|
|
@@ -13552,7 +13586,7 @@ interface operations {
|
|
|
13552
13586
|
* An example conjunction is:
|
|
13553
13587
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13554
13588
|
*
|
|
13555
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13589
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13556
13590
|
*
|
|
13557
13591
|
* The whole string must be query-encoded.
|
|
13558
13592
|
*/
|
|
@@ -13604,7 +13638,7 @@ interface operations {
|
|
|
13604
13638
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13605
13639
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13606
13640
|
*
|
|
13607
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13641
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13608
13642
|
*
|
|
13609
13643
|
* The whole string must be query-encoded.
|
|
13610
13644
|
*/
|
|
@@ -13654,6 +13688,8 @@ interface operations {
|
|
|
13654
13688
|
Permissions?: {
|
|
13655
13689
|
[key: string]: Record<string, never> | null;
|
|
13656
13690
|
} | null;
|
|
13691
|
+
PriorRevisions?: string | null;
|
|
13692
|
+
ReleasePriorRevisions?: string | null;
|
|
13657
13693
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13658
13694
|
Slug?: string | null;
|
|
13659
13695
|
/** Format: uuid */
|
|
@@ -28646,7 +28682,7 @@ interface operations {
|
|
|
28646
28682
|
* An example conjunction is:
|
|
28647
28683
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
28648
28684
|
*
|
|
28649
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
28685
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
28650
28686
|
*
|
|
28651
28687
|
* The whole string must be query-encoded.
|
|
28652
28688
|
*/
|
|
@@ -28688,7 +28724,7 @@ interface operations {
|
|
|
28688
28724
|
* The attribute names are case-sensitive, PascalCase, and
|
|
28689
28725
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28690
28726
|
*
|
|
28691
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28727
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28692
28728
|
*
|
|
28693
28729
|
* The whole string must be query-encoded.
|
|
28694
28730
|
*/
|
|
@@ -28721,7 +28757,7 @@ interface operations {
|
|
|
28721
28757
|
*
|
|
28722
28758
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
28723
28759
|
*
|
|
28724
|
-
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
28760
|
+
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
28725
28761
|
*
|
|
28726
28762
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
28727
28763
|
*
|
|
@@ -28918,7 +28954,7 @@ interface operations {
|
|
|
28918
28954
|
* The attribute names are case-sensitive, PascalCase, and
|
|
28919
28955
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28920
28956
|
*
|
|
28921
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28957
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28922
28958
|
*
|
|
28923
28959
|
* The whole string must be query-encoded.
|
|
28924
28960
|
*/
|
|
@@ -29259,6 +29295,8 @@ interface operations {
|
|
|
29259
29295
|
Permissions?: {
|
|
29260
29296
|
[key: string]: Record<string, never> | null;
|
|
29261
29297
|
} | null;
|
|
29298
|
+
PriorRevisions?: string | null;
|
|
29299
|
+
ReleasePriorRevisions?: string | null;
|
|
29262
29300
|
/** @description Unique URL-safe identifier for the entity. */
|
|
29263
29301
|
Slug?: string | null;
|
|
29264
29302
|
/** Format: uuid */
|
|
@@ -38240,7 +38278,7 @@ interface operations {
|
|
|
38240
38278
|
change_set_id?: string;
|
|
38241
38279
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
38242
38280
|
change_order?: string;
|
|
38243
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
38281
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
38244
38282
|
prior_revisions?: string;
|
|
38245
38283
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
38246
38284
|
subgroup?: string;
|
|
@@ -38547,7 +38585,7 @@ interface operations {
|
|
|
38547
38585
|
change_set_id?: string;
|
|
38548
38586
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
38549
38587
|
change_order?: string;
|
|
38550
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
38588
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
38551
38589
|
prior_revisions?: string;
|
|
38552
38590
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
38553
38591
|
subgroup?: string;
|
|
@@ -47121,7 +47159,7 @@ interface operations {
|
|
|
47121
47159
|
change_set_id?: string;
|
|
47122
47160
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
47123
47161
|
change_order?: string;
|
|
47124
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
47162
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
47125
47163
|
prior_revisions?: string;
|
|
47126
47164
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
47127
47165
|
subgroup?: string;
|
|
@@ -47833,6 +47871,15 @@ interface operations {
|
|
|
47833
47871
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
47834
47872
|
};
|
|
47835
47873
|
};
|
|
47874
|
+
/** @description Moving a change order's release tag to a Revision a release of the change could not deliver: before its end tag or the last released Revision, with validation errors, or in a Space where a release has been published at it */
|
|
47875
|
+
422: {
|
|
47876
|
+
headers: {
|
|
47877
|
+
[name: string]: unknown;
|
|
47878
|
+
};
|
|
47879
|
+
content: {
|
|
47880
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
47881
|
+
};
|
|
47882
|
+
};
|
|
47836
47883
|
/** @description Something went wrong while processing Unit. */
|
|
47837
47884
|
500: {
|
|
47838
47885
|
headers: {
|
|
@@ -50775,6 +50822,16 @@ declare enum AttestationResult {
|
|
|
50775
50822
|
Pass = "Pass",
|
|
50776
50823
|
Fail = "Fail"
|
|
50777
50824
|
}
|
|
50825
|
+
declare enum ChangeOrderPriorRevisions {
|
|
50826
|
+
Include = "Include",
|
|
50827
|
+
Skip = "Skip",
|
|
50828
|
+
Error = "Error",
|
|
50829
|
+
All = "All"
|
|
50830
|
+
}
|
|
50831
|
+
declare enum ChangeOrderReleasePriorRevisions {
|
|
50832
|
+
Include = "Include",
|
|
50833
|
+
Error = "Error"
|
|
50834
|
+
}
|
|
50778
50835
|
declare enum MutationType {
|
|
50779
50836
|
Add = "Add",
|
|
50780
50837
|
Delete = "Delete",
|
|
@@ -50785,7 +50842,8 @@ declare enum MutationType {
|
|
|
50785
50842
|
declare enum PromoteRequestPriorRevisions {
|
|
50786
50843
|
Include = "Include",
|
|
50787
50844
|
Skip = "Skip",
|
|
50788
|
-
Error = "Error"
|
|
50845
|
+
Error = "Error",
|
|
50846
|
+
All = "All"
|
|
50789
50847
|
}
|
|
50790
50848
|
declare enum QueuedOperationStatus {
|
|
50791
50849
|
Initializing = "Initializing",
|
|
@@ -50817,6 +50875,10 @@ declare enum ReleaseLiveStatusSync {
|
|
|
50817
50875
|
OutOfSync = "OutOfSync",
|
|
50818
50876
|
Unknown = "Unknown"
|
|
50819
50877
|
}
|
|
50878
|
+
declare enum ReleasePublishRequestPriorRevisions {
|
|
50879
|
+
Include = "Include",
|
|
50880
|
+
Error = "Error"
|
|
50881
|
+
}
|
|
50820
50882
|
declare enum UnitActionStatus {
|
|
50821
50883
|
Initializing = "Initializing",
|
|
50822
50884
|
Pending = "Pending",
|
package/dist/index.d.ts
CHANGED
|
@@ -97,7 +97,7 @@ interface paths {
|
|
|
97
97
|
put?: never;
|
|
98
98
|
/**
|
|
99
99
|
* Record Attestations across Spaces
|
|
100
|
-
* @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision.
|
|
100
|
+
* @description Record an Attestation in each Space selected by WhereSpace, SpaceFilterID, ChangeOrderID and TargetStage, covering one Revision of each Unit WhereUnit selects there, named by Revision. When ChangeOrderID is given it defaults to the Revision a Release of the change would bundle, which the ChangeOrder's release Tag marks, or to the one its end Tag marks for a Unit the release Tag does not mark, so the approval satisfies its entry and release gates alike; it defaults to the head Revision otherwise. Each Space is recorded on its own and reported on its own.
|
|
101
101
|
*/
|
|
102
102
|
post: operations["Attest"];
|
|
103
103
|
delete?: never;
|
|
@@ -4114,12 +4114,28 @@ interface components {
|
|
|
4114
4114
|
};
|
|
4115
4115
|
/** @description Permissions to access this change order. */
|
|
4116
4116
|
Permissions?: components["schemas"]["Permissions"];
|
|
4117
|
+
/**
|
|
4118
|
+
* @description How the ChangeOrder marks the Units its change does not change, and the default PriorRevisions for its promotions. Include (the default), Skip and Error mark such a Unit at the Revision its followers have taken, or at its LastReleasedRevisionNum when that is later, or at its head if it has neither, so promoting the change does not move it; a promotion then merges a changed Unit's Revisions from before the change (Include), passes over them for good (Skip), or refuses (Error). All marks every such Unit at its head, so promoting the change brings every Unit up to the Space it takes from. Immutable: the ChangeOrder's own Space is marked when it is created.
|
|
4119
|
+
* @enum {string}
|
|
4120
|
+
*/
|
|
4121
|
+
PriorRevisions?: ChangeOrderPriorRevisions;
|
|
4117
4122
|
/** @description PromotionFailures records each promotion that did not complete: who ran it, when, into which Stage, and each Space it failed or was blocked in, with the Space's error or reason and the error of each Unit and Link whose write failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
4118
4123
|
readonly PromotionFailures?: components["schemas"]["ChangeOrderPromotionFailure"][];
|
|
4119
4124
|
/** @description PromotionOverrides records each promotion forced into a Stage whose gates did not hold: who forced it, when, into which Stage and Spaces, why, and which gates failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
4120
4125
|
readonly PromotionOverrides?: components["schemas"]["ChangeOrderPromotionOverride"][];
|
|
4121
4126
|
/** @description Promotions records each promotion that wrote the change into Spaces: who ran it, when, into which Stage, and which Spaces. A promotion entering several Stages records one entry per Stage. The most recent entries are kept. Set by the server. (readonly) */
|
|
4122
4127
|
readonly Promotions?: components["schemas"]["ChangeOrderPromotion"][];
|
|
4128
|
+
/**
|
|
4129
|
+
* @description What a Release of the ChangeOrder does with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum, up to the one the start Tag marks. Include (the default) releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. A publish's PriorRevisions overrides it.
|
|
4130
|
+
* @enum {string}
|
|
4131
|
+
*/
|
|
4132
|
+
ReleasePriorRevisions?: ChangeOrderReleasePriorRevisions;
|
|
4133
|
+
/**
|
|
4134
|
+
* Format: uuid
|
|
4135
|
+
* @description ReleaseTagID is the Tag a Release of the ChangeOrder is published at. It marks one Revision of each releasable Unit (ProviderType empty or OCI) in every Space the change is in: the Revision the end Tag marks, or the head where the Unit does not carry it. It follows Revisions the resolve processor makes after the promotion, and can be moved with a tag move, until a Release in the Space has been published at it. Empty on ChangeOrders created before it existed.
|
|
4136
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4137
|
+
*/
|
|
4138
|
+
readonly ReleaseTagID?: string;
|
|
4123
4139
|
/** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
|
|
4124
4140
|
readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
4125
4141
|
/** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. A Space with no ReleaseTargetID is never here, since nothing releases it. Derived when the ChangeOrder is read. */
|
|
@@ -4180,6 +4196,12 @@ interface components {
|
|
|
4180
4196
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
4181
4197
|
*/
|
|
4182
4198
|
readonly UpdatedAt?: string;
|
|
4199
|
+
/**
|
|
4200
|
+
* Format: uuid
|
|
4201
|
+
* @description The User who created the ChangeOrder. Absent for ChangeOrders created before it was recorded. (readonly)
|
|
4202
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4203
|
+
*/
|
|
4204
|
+
readonly UserID?: string;
|
|
4183
4205
|
/**
|
|
4184
4206
|
* Format: int64
|
|
4185
4207
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
@@ -4584,7 +4606,7 @@ interface components {
|
|
|
4584
4606
|
ChangeWorkflowStage: {
|
|
4585
4607
|
/** @description Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */
|
|
4586
4608
|
Name: string;
|
|
4587
|
-
/** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage
|
|
4609
|
+
/** @description The stage's entry gates, each naming a built-in check or one declared in CustomPrerequisites. Evaluated over every Space of the stage before this one; the first stage's are evaluated over the Space the ChangeOrder resides in, and refused for Invoke and fan-out ChangeOrders, whose change is in no Space before it is promoted. */
|
|
4588
4610
|
Prerequisites?: string[];
|
|
4589
4611
|
/** @description Gates on publishing a Release for a change order in one of the stage's Spaces, each naming one declared in AttestationPrerequisites. Evaluated over the Revisions the Release bundles. */
|
|
4590
4612
|
ReleasePrerequisites?: string[];
|
|
@@ -4914,6 +4936,7 @@ interface components {
|
|
|
4914
4936
|
Error?: components["schemas"]["ResponseError"];
|
|
4915
4937
|
Invocation?: components["schemas"]["Invocation"];
|
|
4916
4938
|
Organization?: components["schemas"]["Organization"];
|
|
4939
|
+
ReleaseTag?: components["schemas"]["Tag"];
|
|
4917
4940
|
RestoreTag?: components["schemas"]["Tag"];
|
|
4918
4941
|
Space?: components["schemas"]["Space"];
|
|
4919
4942
|
SpaceFilter?: components["schemas"]["Filter"];
|
|
@@ -6200,7 +6223,7 @@ interface components {
|
|
|
6200
6223
|
/** @description Reasons to record on the paths each Unit write changes. A later operation must be cleared for them before overwriting those paths. Clearance must cover them, since a write is withheld by guards it is not cleared for, its own included. */
|
|
6201
6224
|
Guards?: components["schemas"]["GuardStamp"];
|
|
6202
6225
|
/**
|
|
6203
|
-
* @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include
|
|
6226
|
+
* @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start, and those Revisions do not arrive later; Error refuses, naming the Revisions; All merges them as Include does, and also marks every Unit in the Space the change does not change at its head, so the next promotion brings it up to this Space. Defaults to the ChangeOrder's PriorRevisions, or Include. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range.
|
|
6204
6227
|
* @enum {string}
|
|
6205
6228
|
*/
|
|
6206
6229
|
PriorRevisions?: PromoteRequestPriorRevisions;
|
|
@@ -6298,7 +6321,7 @@ interface components {
|
|
|
6298
6321
|
PreviousHeadMutationNum?: number;
|
|
6299
6322
|
/** Format: int64 */
|
|
6300
6323
|
PreviousHeadRevisionNum?: number;
|
|
6301
|
-
/** @description For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken,
|
|
6324
|
+
/** @description For Skip and Unchanged: NotCovered, CreatedAfterChangeOrder, AlreadyTaken, NotChanged when the change does not change the Unit, or CreatedInSpace when the Unit was created in this Space rather than cloned into it. A Unit in the Space that the change does not change is marked once the Space's writes are done, with both Tags on the Revision the ChangeOrder's PriorRevisions names. For an applied Upgrade or Resolve: NoChange, when the Unit already held the change, so no Revision was made and the ChangeOrder's Tags mark its head. */
|
|
6302
6325
|
Reason?: string;
|
|
6303
6326
|
Slug?: string;
|
|
6304
6327
|
/**
|
|
@@ -6556,7 +6579,7 @@ interface components {
|
|
|
6556
6579
|
BundleBaseName?: string;
|
|
6557
6580
|
/**
|
|
6558
6581
|
* Format: uuid
|
|
6559
|
-
* @description Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction.
|
|
6582
|
+
* @description Optional ID of the ChangeOrder the Release is published for. It is recorded as the Release's ChangeOrderID, and the ChangeOrder's Stage is advanced in the same transaction. The Release is bundled at the ChangeOrder's release Tag (ReleaseTagID): TagID may be omitted, or name that Tag or the ChangeOrder's end Tag, which is taken to mean it; any other TagID is refused. Naming a ChangeOrder's release Tag as TagID without ChangeOrderID publishes for that ChangeOrder.
|
|
6560
6583
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6561
6584
|
*/
|
|
6562
6585
|
ChangeOrderID?: string;
|
|
@@ -6564,12 +6587,19 @@ interface components {
|
|
|
6564
6587
|
DeleteGates?: {
|
|
6565
6588
|
[key: string]: boolean;
|
|
6566
6589
|
};
|
|
6590
|
+
/** @description Publish in a transaction that is rolled back, returning the Release that would be published, or the error publishing would return: the same ChangeSet, validation and ReleasePrerequisites checks run against the Revisions it would bundle. No event is emitted and no Stage is advanced. */
|
|
6591
|
+
DryRun?: boolean;
|
|
6567
6592
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
6568
6593
|
Labels?: {
|
|
6569
6594
|
[key: string]: string;
|
|
6570
6595
|
};
|
|
6571
6596
|
/** @description Optional Permissions to access the Release. Its publisher is granted Manage in addition. */
|
|
6572
6597
|
Permissions?: components["schemas"]["Permissions"];
|
|
6598
|
+
/**
|
|
6599
|
+
* @description For a Release of a ChangeOrder, what to do with a bundled Unit's Revisions from before the change: those after its LastReleasedRevisionNum up to the one the ChangeOrder's start Tag marks. Include releases them; Error refuses the publish, naming them and the ChangeOrders they belong to. Defaults to the ChangeOrder's ReleasePriorRevisions, or Include.
|
|
6600
|
+
* @enum {string}
|
|
6601
|
+
*/
|
|
6602
|
+
PriorRevisions?: ReleasePublishRequestPriorRevisions;
|
|
6573
6603
|
/**
|
|
6574
6604
|
* Format: uuid
|
|
6575
6605
|
* @description Optional Tag ID identifying the tagged Revision to bundle. For each Unit assigned to the Space's ReleaseTarget, the highest-numbered Revision carrying this Tag is bundled at that Revision instead of the Unit's head Revision. A Unit with no matching tagged Revision is left out of the bundle and listed in the Release's SkippedUnits when it has never been released, and refuses the publish when it has. When omitted, each Unit is bundled at its head Revision and publishing creates a Tag named release-<ReleaseNum>, applies it to each bundled Revision, and sets it as the Release's TagID.
|
|
@@ -8264,6 +8294,8 @@ interface components {
|
|
|
8264
8294
|
MutationSources?: components["schemas"]["ResourceMutationList"];
|
|
8265
8295
|
};
|
|
8266
8296
|
UnitTagRequest: {
|
|
8297
|
+
/** @description Move the Tag from the Revision it marks on each Unit to the one Revision names, refusing a Unit it marks no Revision of. Tags owned by a ChangeSet, ChangeOrder or Release cannot be added or removed; a ChangeOrder's release Tag can be moved, to a Revision at or after the one its end Tag marks and the Unit's LastReleasedRevisionNum, with no ValidationErrors, while no Release in the Space has been published at it. */
|
|
8298
|
+
Move?: boolean;
|
|
8267
8299
|
/** @description Which Unit revision to tag: a named revision ('HeadRevisionNum', 'LastReleasedRevisionNum'), a revision number, an entity reference ('Tag:uuid', 'ChangeSet:uuid', 'Revision:uuid'), any of those prefixed with 'Before:', or 'Remove' to remove the tag from the unit */
|
|
8268
8300
|
Revision?: string;
|
|
8269
8301
|
/**
|
|
@@ -12844,7 +12876,7 @@ interface operations {
|
|
|
12844
12876
|
* An example conjunction is:
|
|
12845
12877
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12846
12878
|
*
|
|
12847
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12879
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
12848
12880
|
*
|
|
12849
12881
|
* The whole string must be query-encoded.
|
|
12850
12882
|
*/
|
|
@@ -12886,7 +12918,7 @@ interface operations {
|
|
|
12886
12918
|
* The attribute names are case-sensitive, PascalCase, and
|
|
12887
12919
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
12888
12920
|
*
|
|
12889
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
12921
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
12890
12922
|
*
|
|
12891
12923
|
* The whole string must be query-encoded.
|
|
12892
12924
|
*/
|
|
@@ -12919,7 +12951,7 @@ interface operations {
|
|
|
12919
12951
|
*
|
|
12920
12952
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
12921
12953
|
*
|
|
12922
|
-
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12954
|
+
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
12923
12955
|
*
|
|
12924
12956
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
12925
12957
|
*
|
|
@@ -13048,7 +13080,7 @@ interface operations {
|
|
|
13048
13080
|
* An example conjunction is:
|
|
13049
13081
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13050
13082
|
*
|
|
13051
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13083
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13052
13084
|
*
|
|
13053
13085
|
* The whole string must be query-encoded.
|
|
13054
13086
|
*/
|
|
@@ -13100,7 +13132,7 @@ interface operations {
|
|
|
13100
13132
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13101
13133
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13102
13134
|
*
|
|
13103
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13135
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13104
13136
|
*
|
|
13105
13137
|
* The whole string must be query-encoded.
|
|
13106
13138
|
*/
|
|
@@ -13212,6 +13244,8 @@ interface operations {
|
|
|
13212
13244
|
Permissions?: {
|
|
13213
13245
|
[key: string]: Record<string, never> | null;
|
|
13214
13246
|
} | null;
|
|
13247
|
+
PriorRevisions?: string | null;
|
|
13248
|
+
ReleasePriorRevisions?: string | null;
|
|
13215
13249
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13216
13250
|
Slug?: string | null;
|
|
13217
13251
|
/** Format: uuid */
|
|
@@ -13350,7 +13384,7 @@ interface operations {
|
|
|
13350
13384
|
* An example conjunction is:
|
|
13351
13385
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13352
13386
|
*
|
|
13353
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13387
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13354
13388
|
*
|
|
13355
13389
|
* The whole string must be query-encoded.
|
|
13356
13390
|
*/
|
|
@@ -13402,7 +13436,7 @@ interface operations {
|
|
|
13402
13436
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13403
13437
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13404
13438
|
*
|
|
13405
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13439
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13406
13440
|
*
|
|
13407
13441
|
* The whole string must be query-encoded.
|
|
13408
13442
|
*/
|
|
@@ -13552,7 +13586,7 @@ interface operations {
|
|
|
13552
13586
|
* An example conjunction is:
|
|
13553
13587
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
13554
13588
|
*
|
|
13555
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
13589
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
13556
13590
|
*
|
|
13557
13591
|
* The whole string must be query-encoded.
|
|
13558
13592
|
*/
|
|
@@ -13604,7 +13638,7 @@ interface operations {
|
|
|
13604
13638
|
* The attribute names are case-sensitive, PascalCase, and
|
|
13605
13639
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
13606
13640
|
*
|
|
13607
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13641
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
13608
13642
|
*
|
|
13609
13643
|
* The whole string must be query-encoded.
|
|
13610
13644
|
*/
|
|
@@ -13654,6 +13688,8 @@ interface operations {
|
|
|
13654
13688
|
Permissions?: {
|
|
13655
13689
|
[key: string]: Record<string, never> | null;
|
|
13656
13690
|
} | null;
|
|
13691
|
+
PriorRevisions?: string | null;
|
|
13692
|
+
ReleasePriorRevisions?: string | null;
|
|
13657
13693
|
/** @description Unique URL-safe identifier for the entity. */
|
|
13658
13694
|
Slug?: string | null;
|
|
13659
13695
|
/** Format: uuid */
|
|
@@ -28646,7 +28682,7 @@ interface operations {
|
|
|
28646
28682
|
* An example conjunction is:
|
|
28647
28683
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
28648
28684
|
*
|
|
28649
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
28685
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PriorRevisions, PromotionFailures, PromotionOverrides, Promotions, ReleasePriorRevisions, ReleaseTagID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, Releases, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
28650
28686
|
*
|
|
28651
28687
|
* The whole string must be query-encoded.
|
|
28652
28688
|
*/
|
|
@@ -28688,7 +28724,7 @@ interface operations {
|
|
|
28688
28724
|
* The attribute names are case-sensitive, PascalCase, and
|
|
28689
28725
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28690
28726
|
*
|
|
28691
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28727
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28692
28728
|
*
|
|
28693
28729
|
* The whole string must be query-encoded.
|
|
28694
28730
|
*/
|
|
@@ -28721,7 +28757,7 @@ interface operations {
|
|
|
28721
28757
|
*
|
|
28722
28758
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
28723
28759
|
*
|
|
28724
|
-
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
28760
|
+
* Supported attributes for ordering ChangeOrder: AbortedReason, AdoptedEndTagID, ChangeOrderID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, InvocationID, OrganizationID, PriorRevisions, ReleasePriorRevisions, ReleaseTagID, RestoreTagID, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, UnitFilterID, UpdateType, UpdatedAt, UserID, WhereSpace, WhereUnit.
|
|
28725
28761
|
*
|
|
28726
28762
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
28727
28763
|
*
|
|
@@ -28918,7 +28954,7 @@ interface operations {
|
|
|
28918
28954
|
* The attribute names are case-sensitive, PascalCase, and
|
|
28919
28955
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
28920
28956
|
*
|
|
28921
|
-
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28957
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, ReleaseTagID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
28922
28958
|
*
|
|
28923
28959
|
* The whole string must be query-encoded.
|
|
28924
28960
|
*/
|
|
@@ -29259,6 +29295,8 @@ interface operations {
|
|
|
29259
29295
|
Permissions?: {
|
|
29260
29296
|
[key: string]: Record<string, never> | null;
|
|
29261
29297
|
} | null;
|
|
29298
|
+
PriorRevisions?: string | null;
|
|
29299
|
+
ReleasePriorRevisions?: string | null;
|
|
29262
29300
|
/** @description Unique URL-safe identifier for the entity. */
|
|
29263
29301
|
Slug?: string | null;
|
|
29264
29302
|
/** Format: uuid */
|
|
@@ -38240,7 +38278,7 @@ interface operations {
|
|
|
38240
38278
|
change_set_id?: string;
|
|
38241
38279
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
38242
38280
|
change_order?: string;
|
|
38243
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
38281
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
38244
38282
|
prior_revisions?: string;
|
|
38245
38283
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
38246
38284
|
subgroup?: string;
|
|
@@ -38547,7 +38585,7 @@ interface operations {
|
|
|
38547
38585
|
change_set_id?: string;
|
|
38548
38586
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
38549
38587
|
change_order?: string;
|
|
38550
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
38588
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
38551
38589
|
prior_revisions?: string;
|
|
38552
38590
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
38553
38591
|
subgroup?: string;
|
|
@@ -47121,7 +47159,7 @@ interface operations {
|
|
|
47121
47159
|
change_set_id?: string;
|
|
47122
47160
|
/** @description ChangeOrder to promote, with upgrade or resolve, or to undo, with restore. The change order fixed the range when it was created -- the interval on each source Unit, marked with its Tags -- so it supplies both ends of the merge and merge_end is refused alongside it. A Unit whose source the change order does not cover is passed over rather than failed, which is what lets a bulk upgrade name a whole Space and take only the Units the change is in. A Unit whose last merged revision is past where the change order starts is an error, since merging anyway would replay what it already has; one that is short of it is handled as prior_revisions says. With resolve a selected Link whose UpdateType the change order does not follow is an error too. The revisions the promotion creates carry the ChangeOrder, and its start Tag is placed on the revision before them and its end Tag on the one it arrives at, so 'restore Before:ChangeOrder:uuid' undoes it whether it landed as one revision or as one per source revision. With restore the change order is being undone rather than promoted: the restore must be 'Before:ChangeOrder:' the same change order, the change order must have an AbortedReason -- undoing a change nobody has said is not coming is a race with whoever is still promoting it -- and a Unit the change order never marked is an error rather than passed over, since naming it says the Unit is part of the undoing. The first restore mints the change order's restore Tag and records it as RestoreTagID; every restore after that marks with the same Tag, which is what RestoredSpaceIDs is read off. A Unit the change order carried nothing for takes the restore Tag on the revision its start and end Tags are already on, and no revision is made. A Unit already carrying the restore Tag has had the change order taken back out of it and is passed over, since undoing one in a Unit happens once as promoting it into one does -- so the revisions a Unit has taken since it was undone are its own work rather than this undoing's to drop. Restoring also advances the merge pointers of the Links of the change order's UpdateType that follow the restored Unit onto the revision the restore made, so a later upgrade does not replay the change that was just taken out; the downstream Units are not restored with it, since each has to be restored and released on its own account. */
|
|
47123
47161
|
change_order?: string;
|
|
47124
|
-
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. A Unit that has already merged past the change order's start is an error whatever this says. */
|
|
47162
|
+
/** @description With change_order, when promoting it by upgrade or resolve: what to do for a Unit whose last merged revision of its source is before the revision the change order starts at there -- typically because a Link in the source's Space, such as a TransformPaths Link, wrote revisions after the Unit last merged, and those revisions are not the change order's. Include (the default) merges them first, walking them one source revision at a time even with squash, as revisions that do not carry the change order, and places the change order's start Tag on the revision they leave, so 'restore Before:ChangeOrder:uuid' keeps them. Skip merges only the change order's range, as though the Unit's merge pointer had already been advanced to the change order's start, so what those revisions changed does not reach the Unit. Error refuses, naming the Unit, the Link, and each of those revisions with the operation and Link that made it. All merges them as Include does. A Unit that has already merged past the change order's start is an error whatever this says. Defaults to the change order's PriorRevisions. */
|
|
47125
47163
|
prior_revisions?: string;
|
|
47126
47164
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
47127
47165
|
subgroup?: string;
|
|
@@ -47833,6 +47871,15 @@ interface operations {
|
|
|
47833
47871
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
47834
47872
|
};
|
|
47835
47873
|
};
|
|
47874
|
+
/** @description Moving a change order's release tag to a Revision a release of the change could not deliver: before its end tag or the last released Revision, with validation errors, or in a Space where a release has been published at it */
|
|
47875
|
+
422: {
|
|
47876
|
+
headers: {
|
|
47877
|
+
[name: string]: unknown;
|
|
47878
|
+
};
|
|
47879
|
+
content: {
|
|
47880
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
47881
|
+
};
|
|
47882
|
+
};
|
|
47836
47883
|
/** @description Something went wrong while processing Unit. */
|
|
47837
47884
|
500: {
|
|
47838
47885
|
headers: {
|
|
@@ -50775,6 +50822,16 @@ declare enum AttestationResult {
|
|
|
50775
50822
|
Pass = "Pass",
|
|
50776
50823
|
Fail = "Fail"
|
|
50777
50824
|
}
|
|
50825
|
+
declare enum ChangeOrderPriorRevisions {
|
|
50826
|
+
Include = "Include",
|
|
50827
|
+
Skip = "Skip",
|
|
50828
|
+
Error = "Error",
|
|
50829
|
+
All = "All"
|
|
50830
|
+
}
|
|
50831
|
+
declare enum ChangeOrderReleasePriorRevisions {
|
|
50832
|
+
Include = "Include",
|
|
50833
|
+
Error = "Error"
|
|
50834
|
+
}
|
|
50778
50835
|
declare enum MutationType {
|
|
50779
50836
|
Add = "Add",
|
|
50780
50837
|
Delete = "Delete",
|
|
@@ -50785,7 +50842,8 @@ declare enum MutationType {
|
|
|
50785
50842
|
declare enum PromoteRequestPriorRevisions {
|
|
50786
50843
|
Include = "Include",
|
|
50787
50844
|
Skip = "Skip",
|
|
50788
|
-
Error = "Error"
|
|
50845
|
+
Error = "Error",
|
|
50846
|
+
All = "All"
|
|
50789
50847
|
}
|
|
50790
50848
|
declare enum QueuedOperationStatus {
|
|
50791
50849
|
Initializing = "Initializing",
|
|
@@ -50817,6 +50875,10 @@ declare enum ReleaseLiveStatusSync {
|
|
|
50817
50875
|
OutOfSync = "OutOfSync",
|
|
50818
50876
|
Unknown = "Unknown"
|
|
50819
50877
|
}
|
|
50878
|
+
declare enum ReleasePublishRequestPriorRevisions {
|
|
50879
|
+
Include = "Include",
|
|
50880
|
+
Error = "Error"
|
|
50881
|
+
}
|
|
50820
50882
|
declare enum UnitActionStatus {
|
|
50821
50883
|
Initializing = "Initializing",
|
|
50822
50884
|
Pending = "Pending",
|