@confighub/api 0.8.28 → 0.8.29
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 +126 -29
- package/dist/index.d.ts +126 -29
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -4820,6 +4820,16 @@ interface components {
|
|
|
4820
4820
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4821
4821
|
*/
|
|
4822
4822
|
ChangeSetID?: string;
|
|
4823
|
+
/** @description ChangeWorkflow is a copy of the ChangeWorkflow ChangeWorkflowID names, taken when the ChangeSet was created, so editing the workflow afterwards does not change what closing this ChangeSet is judged against. Empty is a ChangeSet no workflow governs. (readonly) */
|
|
4824
|
+
readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
|
|
4825
|
+
/**
|
|
4826
|
+
* Format: uuid
|
|
4827
|
+
* @description ChangeWorkflowID is the ChangeWorkflow that gates closing this ChangeSet: its Final prerequisites, evaluated over every Space in InScopeSpaceIDs. The workflow must have no Stages, and its Final may not name Released or Healthy. Settable at creation and immutable afterwards. When a Unit in a Space that is a Variant of a Component joins the ChangeSet, the workflow must be one the Component allows, and is required if the Component requires one.
|
|
4828
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4829
|
+
*/
|
|
4830
|
+
ChangeWorkflowID?: string;
|
|
4831
|
+
/** @description CloseOverride records a close forced past the ChangeWorkflow's gates: who forced it, when, why, and which gates did not hold. (readonly) */
|
|
4832
|
+
readonly CloseOverride?: components["schemas"]["ChangeSetCloseOverride"];
|
|
4823
4833
|
/**
|
|
4824
4834
|
* Format: date-time
|
|
4825
4835
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -4844,6 +4854,8 @@ interface components {
|
|
|
4844
4854
|
readonly EntityType?: string;
|
|
4845
4855
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
4846
4856
|
HiddenReason?: string;
|
|
4857
|
+
/** @description InScopeSpaceIDs are the Spaces of the Units the ChangeSet has been opened on. A Space is added when the first of its Units joins, and is not removed. Closing a ChangeSet governed by a ChangeWorkflow is gated over every one of them. (readonly) */
|
|
4858
|
+
readonly InScopeSpaceIDs?: components["schemas"]["UUID"][];
|
|
4847
4859
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
4848
4860
|
Labels?: {
|
|
4849
4861
|
[key: string]: string;
|
|
@@ -4856,6 +4868,8 @@ interface components {
|
|
|
4856
4868
|
OrganizationID?: string;
|
|
4857
4869
|
/** @description Permissions to access this change set. */
|
|
4858
4870
|
Permissions?: components["schemas"]["Permissions"];
|
|
4871
|
+
/** @description ReviewRequests records whose review the change is waiting for: for each, the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */
|
|
4872
|
+
ReviewRequests?: components["schemas"]["ChangeSetReviewRequest"][];
|
|
4859
4873
|
/** @description Unique URL-safe identifier for the entity. */
|
|
4860
4874
|
Slug: string;
|
|
4861
4875
|
/**
|
|
@@ -4882,16 +4896,68 @@ interface components {
|
|
|
4882
4896
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
4883
4897
|
*/
|
|
4884
4898
|
readonly UpdatedAt?: string;
|
|
4899
|
+
/**
|
|
4900
|
+
* Format: uuid
|
|
4901
|
+
* @description The User who created the ChangeSet. Absent for ChangeSets created before it was recorded. (readonly)
|
|
4902
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4903
|
+
*/
|
|
4904
|
+
readonly UserID?: string;
|
|
4885
4905
|
/**
|
|
4886
4906
|
* Format: int64
|
|
4887
4907
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
4888
4908
|
*/
|
|
4889
4909
|
Version?: number;
|
|
4890
4910
|
};
|
|
4911
|
+
ChangeSetCloseOverride: {
|
|
4912
|
+
FailedGates?: string[];
|
|
4913
|
+
/**
|
|
4914
|
+
* Format: date-time
|
|
4915
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4916
|
+
*/
|
|
4917
|
+
OverriddenAt?: string;
|
|
4918
|
+
Reason?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Format: uuid
|
|
4921
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4922
|
+
*/
|
|
4923
|
+
UserID?: string;
|
|
4924
|
+
};
|
|
4925
|
+
ChangeSetCloseResult: {
|
|
4926
|
+
/**
|
|
4927
|
+
* Format: uuid
|
|
4928
|
+
* @description The ChangeSet the write closed, or would have closed.
|
|
4929
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4930
|
+
*/
|
|
4931
|
+
ChangeSetID?: string;
|
|
4932
|
+
/** @description The close was forced past gates that did not hold, which the ChangeSet's CloseOverride records. */
|
|
4933
|
+
Forced?: boolean;
|
|
4934
|
+
/** @description Each Final prerequisite of the ChangeSet's ChangeWorkflow, evaluated over each Space the ChangeSet was opened in. */
|
|
4935
|
+
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
4936
|
+
};
|
|
4891
4937
|
ChangeSetCreateOrUpdateResponse: {
|
|
4892
4938
|
ChangeSet?: components["schemas"]["ChangeSet"];
|
|
4893
4939
|
Error?: components["schemas"]["ResponseError"];
|
|
4894
4940
|
};
|
|
4941
|
+
ChangeSetReviewRequest: {
|
|
4942
|
+
/**
|
|
4943
|
+
* Format: date-time
|
|
4944
|
+
* @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time.
|
|
4945
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4946
|
+
*/
|
|
4947
|
+
RequestedAt?: string;
|
|
4948
|
+
/**
|
|
4949
|
+
* Format: uuid
|
|
4950
|
+
* @description Who requested the review, or last re-requested it. Set by the server.
|
|
4951
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4952
|
+
*/
|
|
4953
|
+
readonly RequestedByUserID?: string;
|
|
4954
|
+
/**
|
|
4955
|
+
* Format: uuid
|
|
4956
|
+
* @description The User asked to review.
|
|
4957
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4958
|
+
*/
|
|
4959
|
+
UserID: string;
|
|
4960
|
+
};
|
|
4895
4961
|
/** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */
|
|
4896
4962
|
ChangeWorkflow: {
|
|
4897
4963
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -4927,7 +4993,7 @@ interface components {
|
|
|
4927
4993
|
DisplayName?: string;
|
|
4928
4994
|
/** @description The type of entity. */
|
|
4929
4995
|
readonly EntityType?: string;
|
|
4930
|
-
/** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
4996
|
+
/** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, it is what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
4931
4997
|
Final?: components["schemas"]["ChangeWorkflowFinalStage"];
|
|
4932
4998
|
/** @description SHA256 hash of the change workflow's Stages, Final, CustomPrerequisites and AttestationPrerequisites encoded as hexadecimal. (readonly) */
|
|
4933
4999
|
readonly Hash?: string;
|
|
@@ -4955,8 +5021,8 @@ interface components {
|
|
|
4955
5021
|
SpaceID?: string;
|
|
4956
5022
|
/** @description Slug of the Space this entity belongs to. (readonly) */
|
|
4957
5023
|
readonly SpaceSlug?: string;
|
|
4958
|
-
/** @description Stages is the series a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
4959
|
-
Stages
|
|
5024
|
+
/** @description Stages is the series a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
5025
|
+
Stages?: components["schemas"]["ChangeWorkflowStage"][];
|
|
4960
5026
|
/**
|
|
4961
5027
|
* Format: date-time
|
|
4962
5028
|
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
@@ -5007,7 +5073,7 @@ interface components {
|
|
|
5007
5073
|
ChangeWorkflowPrerequisite: {
|
|
5008
5074
|
/** @description What the gate checks, in the author's words. A promotion this gate holds up reports the prerequisite by Name, so this is where the reason lives. Read by nobody: it is not part of what the gate evaluates. */
|
|
5009
5075
|
Description?: string;
|
|
5010
|
-
/** @description The check itself, carrying the "cel:" prefix. Evaluated against the Space under consideration, the change order being promoted, and that Space's Release. Compiled when the workflow is written. */
|
|
5076
|
+
/** @description The check itself, carrying the "cel:" prefix. Evaluated against the Space under consideration, the change order being promoted, and that Space's Release; closing a ChangeSet binds Space and ChangeSet, with ChangeOrder and Release null. Compiled when the workflow is written. */
|
|
5011
5077
|
Expression: string;
|
|
5012
5078
|
/** @description What a stage or Final gates on. Unique within a workflow, and refused if it shadows a built-in name. */
|
|
5013
5079
|
Name: string;
|
|
@@ -5017,10 +5083,10 @@ interface components {
|
|
|
5017
5083
|
AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][];
|
|
5018
5084
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
5019
5085
|
CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][];
|
|
5020
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
5086
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
5021
5087
|
Final?: components["schemas"]["ChangeWorkflowFinalStage"];
|
|
5022
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
5023
|
-
Stages
|
|
5088
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
5089
|
+
Stages?: components["schemas"]["ChangeWorkflowStage"][];
|
|
5024
5090
|
};
|
|
5025
5091
|
ChangeWorkflowStage: {
|
|
5026
5092
|
/** @description Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */
|
|
@@ -5314,9 +5380,9 @@ interface components {
|
|
|
5314
5380
|
Options?: components["schemas"]["CommandOption"][];
|
|
5315
5381
|
Returns?: components["schemas"]["Schema"];
|
|
5316
5382
|
};
|
|
5317
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
5383
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
5318
5384
|
Component: {
|
|
5319
|
-
/** @description The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants. Changing it requires Manage permission on the component. (optional) */
|
|
5385
|
+
/** @description The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants, and for ChangeSets opened on their Units: a ChangeOrder or ChangeSet is governed by one workflow, which every component it reaches has to allow. Changing it requires Manage permission on the component. (optional) */
|
|
5320
5386
|
AllowedChangeWorkflowIDs?: components["schemas"]["UUID"][];
|
|
5321
5387
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
5322
5388
|
Annotations?: {
|
|
@@ -5327,7 +5393,7 @@ interface components {
|
|
|
5327
5393
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5328
5394
|
*/
|
|
5329
5395
|
readonly BackingUnitID?: string;
|
|
5330
|
-
/** @description Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants. Changing it requires Manage permission on the component. (optional) */
|
|
5396
|
+
/** @description Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
5331
5397
|
ChangeWorkflowRequired?: boolean;
|
|
5332
5398
|
/**
|
|
5333
5399
|
* Format: uuid
|
|
@@ -8962,6 +9028,8 @@ interface components {
|
|
|
8962
9028
|
Unit?: components["schemas"]["Unit"];
|
|
8963
9029
|
};
|
|
8964
9030
|
UnitCreateOrUpdateResponse: {
|
|
9031
|
+
/** @description The gates closing the Unit's ChangeSet was judged against, when the write closed, or on a dry run would close, a ChangeSet a ChangeWorkflow governs. Returned for every Unit of the ChangeSet the write detaches. A close the gates refuse fails every such Unit alike, so a write detaching nothing else answers with the refusal alone, whose items name each gate that does not hold, by Space. */
|
|
9032
|
+
ChangeSetClose?: components["schemas"]["ChangeSetCloseResult"];
|
|
8965
9033
|
/** @description The configuration the operation produced; returned when include names ConfigData. */
|
|
8966
9034
|
ConfigData?: string;
|
|
8967
9035
|
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
@@ -9320,10 +9388,16 @@ interface components {
|
|
|
9320
9388
|
ChangeSetDescription?: string;
|
|
9321
9389
|
/**
|
|
9322
9390
|
* Format: uuid
|
|
9323
|
-
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space.
|
|
9391
|
+
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space. The upload closes it afterwards, unless a ChangeWorkflow governs it.
|
|
9324
9392
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9325
9393
|
*/
|
|
9326
9394
|
ChangeSetID?: string;
|
|
9395
|
+
/**
|
|
9396
|
+
* Format: uuid
|
|
9397
|
+
* @description The ChangeWorkflow governing the ChangeSet the upload opens, which a Space whose Component requires one needs. A ChangeSet a ChangeWorkflow governs is left open, with the Units the upload wrote in it, since closing it is gated on the workflow's Final prerequisites. Not accepted with ChangeSetID, whose ChangeSet names its own.
|
|
9398
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9399
|
+
*/
|
|
9400
|
+
ChangeWorkflowID?: string;
|
|
9327
9401
|
/** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
|
|
9328
9402
|
Clearance?: components["schemas"]["Clearance"];
|
|
9329
9403
|
/** @description Placement of each component. Exactly one is supported. */
|
|
@@ -9387,6 +9461,8 @@ interface components {
|
|
|
9387
9461
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9388
9462
|
*/
|
|
9389
9463
|
ChangeSetID?: string;
|
|
9464
|
+
/** @description The upload left the ChangeSet open, with the Units it wrote in it, because a ChangeWorkflow governs it: closing it is gated on the workflow's Final prerequisites. */
|
|
9465
|
+
ChangeSetOpen?: boolean;
|
|
9390
9466
|
/** @description Resources this upload writes that other Units deployed to the same Target also define: the Space's other Units, and when the Space has a Target, Units elsewhere on that Target. */
|
|
9391
9467
|
Duplicates?: components["schemas"]["UploadDuplicate"][];
|
|
9392
9468
|
Links?: components["schemas"]["UploadLinkResult"][];
|
|
@@ -14799,7 +14875,7 @@ interface operations {
|
|
|
14799
14875
|
* An example conjunction is:
|
|
14800
14876
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14801
14877
|
*
|
|
14802
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
14878
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
14803
14879
|
*
|
|
14804
14880
|
* The whole string must be query-encoded.
|
|
14805
14881
|
*/
|
|
@@ -14884,7 +14960,7 @@ interface operations {
|
|
|
14884
14960
|
*
|
|
14885
14961
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
14886
14962
|
*
|
|
14887
|
-
* Supported attributes for ordering ChangeSet: ChangeSetID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
14963
|
+
* Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
14888
14964
|
*
|
|
14889
14965
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
14890
14966
|
*
|
|
@@ -15013,7 +15089,7 @@ interface operations {
|
|
|
15013
15089
|
* An example conjunction is:
|
|
15014
15090
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15015
15091
|
*
|
|
15016
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15092
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15017
15093
|
*
|
|
15018
15094
|
* The whole string must be query-encoded.
|
|
15019
15095
|
*/
|
|
@@ -15152,6 +15228,8 @@ interface operations {
|
|
|
15152
15228
|
Annotations?: {
|
|
15153
15229
|
[key: string]: string | null;
|
|
15154
15230
|
} | null;
|
|
15231
|
+
/** Format: uuid */
|
|
15232
|
+
ChangeWorkflowID?: string | null;
|
|
15155
15233
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
15156
15234
|
DeleteGates?: {
|
|
15157
15235
|
[key: string]: boolean | null;
|
|
@@ -15168,6 +15246,7 @@ interface operations {
|
|
|
15168
15246
|
Permissions?: {
|
|
15169
15247
|
[key: string]: Record<string, never> | null;
|
|
15170
15248
|
} | null;
|
|
15249
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
15171
15250
|
/** @description Unique URL-safe identifier for the entity. */
|
|
15172
15251
|
Slug?: string | null;
|
|
15173
15252
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -15299,7 +15378,7 @@ interface operations {
|
|
|
15299
15378
|
* An example conjunction is:
|
|
15300
15379
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15301
15380
|
*
|
|
15302
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15381
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15303
15382
|
*
|
|
15304
15383
|
* The whole string must be query-encoded.
|
|
15305
15384
|
*/
|
|
@@ -15501,7 +15580,7 @@ interface operations {
|
|
|
15501
15580
|
* An example conjunction is:
|
|
15502
15581
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15503
15582
|
*
|
|
15504
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15583
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15505
15584
|
*
|
|
15506
15585
|
* The whole string must be query-encoded.
|
|
15507
15586
|
*/
|
|
@@ -15576,6 +15655,8 @@ interface operations {
|
|
|
15576
15655
|
Annotations?: {
|
|
15577
15656
|
[key: string]: string | null;
|
|
15578
15657
|
} | null;
|
|
15658
|
+
/** Format: uuid */
|
|
15659
|
+
ChangeWorkflowID?: string | null;
|
|
15579
15660
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
15580
15661
|
DeleteGates?: {
|
|
15581
15662
|
[key: string]: boolean | null;
|
|
@@ -15592,6 +15673,7 @@ interface operations {
|
|
|
15592
15673
|
Permissions?: {
|
|
15593
15674
|
[key: string]: Record<string, never> | null;
|
|
15594
15675
|
} | null;
|
|
15676
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
15595
15677
|
/** @description Unique URL-safe identifier for the entity. */
|
|
15596
15678
|
Slug?: string | null;
|
|
15597
15679
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -15723,7 +15805,7 @@ interface operations {
|
|
|
15723
15805
|
* An example conjunction is:
|
|
15724
15806
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15725
15807
|
*
|
|
15726
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15808
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15727
15809
|
*
|
|
15728
15810
|
* The whole string must be query-encoded.
|
|
15729
15811
|
*/
|
|
@@ -16327,7 +16409,7 @@ interface operations {
|
|
|
16327
16409
|
} | null;
|
|
16328
16410
|
/** @description Friendly name for the entity. */
|
|
16329
16411
|
DisplayName?: string | null;
|
|
16330
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
16412
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
16331
16413
|
Final?: Record<string, never> | null;
|
|
16332
16414
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
16333
16415
|
HiddenReason?: string | null;
|
|
@@ -16340,7 +16422,7 @@ interface operations {
|
|
|
16340
16422
|
} | null;
|
|
16341
16423
|
/** @description Unique URL-safe identifier for the entity. */
|
|
16342
16424
|
Slug?: string | null;
|
|
16343
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
16425
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
16344
16426
|
Stages?: (Record<string, never> | null)[] | null;
|
|
16345
16427
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
16346
16428
|
Version?: number | null;
|
|
@@ -16771,7 +16853,7 @@ interface operations {
|
|
|
16771
16853
|
} | null;
|
|
16772
16854
|
/** @description Friendly name for the entity. */
|
|
16773
16855
|
DisplayName?: string | null;
|
|
16774
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
16856
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
16775
16857
|
Final?: Record<string, never> | null;
|
|
16776
16858
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
16777
16859
|
HiddenReason?: string | null;
|
|
@@ -16784,7 +16866,7 @@ interface operations {
|
|
|
16784
16866
|
} | null;
|
|
16785
16867
|
/** @description Unique URL-safe identifier for the entity. */
|
|
16786
16868
|
Slug?: string | null;
|
|
16787
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
16869
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
16788
16870
|
Stages?: (Record<string, never> | null)[] | null;
|
|
16789
16871
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
16790
16872
|
Version?: number | null;
|
|
@@ -18779,7 +18861,7 @@ interface operations {
|
|
|
18779
18861
|
};
|
|
18780
18862
|
};
|
|
18781
18863
|
responses: {
|
|
18782
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
18864
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
18783
18865
|
200: {
|
|
18784
18866
|
headers: {
|
|
18785
18867
|
[name: string]: unknown;
|
|
@@ -18971,7 +19053,7 @@ interface operations {
|
|
|
18971
19053
|
};
|
|
18972
19054
|
};
|
|
18973
19055
|
responses: {
|
|
18974
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19056
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
18975
19057
|
200: {
|
|
18976
19058
|
headers: {
|
|
18977
19059
|
[name: string]: unknown;
|
|
@@ -19185,7 +19267,7 @@ interface operations {
|
|
|
19185
19267
|
};
|
|
19186
19268
|
};
|
|
19187
19269
|
responses: {
|
|
19188
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19270
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
19189
19271
|
200: {
|
|
19190
19272
|
headers: {
|
|
19191
19273
|
[name: string]: unknown;
|
|
@@ -19355,7 +19437,7 @@ interface operations {
|
|
|
19355
19437
|
};
|
|
19356
19438
|
};
|
|
19357
19439
|
responses: {
|
|
19358
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19440
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
19359
19441
|
200: {
|
|
19360
19442
|
headers: {
|
|
19361
19443
|
[name: string]: unknown;
|
|
@@ -32343,7 +32425,7 @@ interface operations {
|
|
|
32343
32425
|
* An example conjunction is:
|
|
32344
32426
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
32345
32427
|
*
|
|
32346
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
32428
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
32347
32429
|
*
|
|
32348
32430
|
* The whole string must be query-encoded.
|
|
32349
32431
|
*/
|
|
@@ -32428,7 +32510,7 @@ interface operations {
|
|
|
32428
32510
|
*
|
|
32429
32511
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
32430
32512
|
*
|
|
32431
|
-
* Supported attributes for ordering ChangeSet: ChangeSetID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
32513
|
+
* Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
32432
32514
|
*
|
|
32433
32515
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
32434
32516
|
*
|
|
@@ -32935,6 +33017,8 @@ interface operations {
|
|
|
32935
33017
|
Annotations?: {
|
|
32936
33018
|
[key: string]: string | null;
|
|
32937
33019
|
} | null;
|
|
33020
|
+
/** Format: uuid */
|
|
33021
|
+
ChangeWorkflowID?: string | null;
|
|
32938
33022
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
32939
33023
|
DeleteGates?: {
|
|
32940
33024
|
[key: string]: boolean | null;
|
|
@@ -32951,6 +33035,7 @@ interface operations {
|
|
|
32951
33035
|
Permissions?: {
|
|
32952
33036
|
[key: string]: Record<string, never> | null;
|
|
32953
33037
|
} | null;
|
|
33038
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
32954
33039
|
/** @description Unique URL-safe identifier for the entity. */
|
|
32955
33040
|
Slug?: string | null;
|
|
32956
33041
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -33672,7 +33757,7 @@ interface operations {
|
|
|
33672
33757
|
} | null;
|
|
33673
33758
|
/** @description Friendly name for the entity. */
|
|
33674
33759
|
DisplayName?: string | null;
|
|
33675
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
33760
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
33676
33761
|
Final?: Record<string, never> | null;
|
|
33677
33762
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
33678
33763
|
HiddenReason?: string | null;
|
|
@@ -33685,7 +33770,7 @@ interface operations {
|
|
|
33685
33770
|
} | null;
|
|
33686
33771
|
/** @description Unique URL-safe identifier for the entity. */
|
|
33687
33772
|
Slug?: string | null;
|
|
33688
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
33773
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
33689
33774
|
Stages?: (Record<string, never> | null)[] | null;
|
|
33690
33775
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
33691
33776
|
Version?: number | null;
|
|
@@ -43137,6 +43222,10 @@ interface operations {
|
|
|
43137
43222
|
prior_revisions?: string;
|
|
43138
43223
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
43139
43224
|
subgroup?: string;
|
|
43225
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
43226
|
+
force_close?: boolean;
|
|
43227
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
43228
|
+
force_reason?: string;
|
|
43140
43229
|
/**
|
|
43141
43230
|
* @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
43142
43231
|
*
|
|
@@ -43448,6 +43537,10 @@ interface operations {
|
|
|
43448
43537
|
prior_revisions?: string;
|
|
43449
43538
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
43450
43539
|
subgroup?: string;
|
|
43540
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
43541
|
+
force_close?: boolean;
|
|
43542
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
43543
|
+
force_reason?: string;
|
|
43451
43544
|
/**
|
|
43452
43545
|
* @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
43453
43546
|
*
|
|
@@ -52131,6 +52224,10 @@ interface operations {
|
|
|
52131
52224
|
prior_revisions?: string;
|
|
52132
52225
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
52133
52226
|
subgroup?: string;
|
|
52227
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
52228
|
+
force_close?: boolean;
|
|
52229
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
52230
|
+
force_reason?: string;
|
|
52134
52231
|
};
|
|
52135
52232
|
header?: never;
|
|
52136
52233
|
path?: never;
|
package/dist/index.d.ts
CHANGED
|
@@ -4820,6 +4820,16 @@ interface components {
|
|
|
4820
4820
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4821
4821
|
*/
|
|
4822
4822
|
ChangeSetID?: string;
|
|
4823
|
+
/** @description ChangeWorkflow is a copy of the ChangeWorkflow ChangeWorkflowID names, taken when the ChangeSet was created, so editing the workflow afterwards does not change what closing this ChangeSet is judged against. Empty is a ChangeSet no workflow governs. (readonly) */
|
|
4824
|
+
readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
|
|
4825
|
+
/**
|
|
4826
|
+
* Format: uuid
|
|
4827
|
+
* @description ChangeWorkflowID is the ChangeWorkflow that gates closing this ChangeSet: its Final prerequisites, evaluated over every Space in InScopeSpaceIDs. The workflow must have no Stages, and its Final may not name Released or Healthy. Settable at creation and immutable afterwards. When a Unit in a Space that is a Variant of a Component joins the ChangeSet, the workflow must be one the Component allows, and is required if the Component requires one.
|
|
4828
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4829
|
+
*/
|
|
4830
|
+
ChangeWorkflowID?: string;
|
|
4831
|
+
/** @description CloseOverride records a close forced past the ChangeWorkflow's gates: who forced it, when, why, and which gates did not hold. (readonly) */
|
|
4832
|
+
readonly CloseOverride?: components["schemas"]["ChangeSetCloseOverride"];
|
|
4823
4833
|
/**
|
|
4824
4834
|
* Format: date-time
|
|
4825
4835
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -4844,6 +4854,8 @@ interface components {
|
|
|
4844
4854
|
readonly EntityType?: string;
|
|
4845
4855
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
4846
4856
|
HiddenReason?: string;
|
|
4857
|
+
/** @description InScopeSpaceIDs are the Spaces of the Units the ChangeSet has been opened on. A Space is added when the first of its Units joins, and is not removed. Closing a ChangeSet governed by a ChangeWorkflow is gated over every one of them. (readonly) */
|
|
4858
|
+
readonly InScopeSpaceIDs?: components["schemas"]["UUID"][];
|
|
4847
4859
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
4848
4860
|
Labels?: {
|
|
4849
4861
|
[key: string]: string;
|
|
@@ -4856,6 +4868,8 @@ interface components {
|
|
|
4856
4868
|
OrganizationID?: string;
|
|
4857
4869
|
/** @description Permissions to access this change set. */
|
|
4858
4870
|
Permissions?: components["schemas"]["Permissions"];
|
|
4871
|
+
/** @description ReviewRequests records whose review the change is waiting for: for each, the User, and when and by whom the review was requested. A request is not cleared when the review is given; whether a reviewer has reviewed is read from their Attestations. A merge patch replaces the list whole. At most 256. */
|
|
4872
|
+
ReviewRequests?: components["schemas"]["ChangeSetReviewRequest"][];
|
|
4859
4873
|
/** @description Unique URL-safe identifier for the entity. */
|
|
4860
4874
|
Slug: string;
|
|
4861
4875
|
/**
|
|
@@ -4882,16 +4896,68 @@ interface components {
|
|
|
4882
4896
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
4883
4897
|
*/
|
|
4884
4898
|
readonly UpdatedAt?: string;
|
|
4899
|
+
/**
|
|
4900
|
+
* Format: uuid
|
|
4901
|
+
* @description The User who created the ChangeSet. Absent for ChangeSets created before it was recorded. (readonly)
|
|
4902
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4903
|
+
*/
|
|
4904
|
+
readonly UserID?: string;
|
|
4885
4905
|
/**
|
|
4886
4906
|
* Format: int64
|
|
4887
4907
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
4888
4908
|
*/
|
|
4889
4909
|
Version?: number;
|
|
4890
4910
|
};
|
|
4911
|
+
ChangeSetCloseOverride: {
|
|
4912
|
+
FailedGates?: string[];
|
|
4913
|
+
/**
|
|
4914
|
+
* Format: date-time
|
|
4915
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4916
|
+
*/
|
|
4917
|
+
OverriddenAt?: string;
|
|
4918
|
+
Reason?: string;
|
|
4919
|
+
/**
|
|
4920
|
+
* Format: uuid
|
|
4921
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4922
|
+
*/
|
|
4923
|
+
UserID?: string;
|
|
4924
|
+
};
|
|
4925
|
+
ChangeSetCloseResult: {
|
|
4926
|
+
/**
|
|
4927
|
+
* Format: uuid
|
|
4928
|
+
* @description The ChangeSet the write closed, or would have closed.
|
|
4929
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4930
|
+
*/
|
|
4931
|
+
ChangeSetID?: string;
|
|
4932
|
+
/** @description The close was forced past gates that did not hold, which the ChangeSet's CloseOverride records. */
|
|
4933
|
+
Forced?: boolean;
|
|
4934
|
+
/** @description Each Final prerequisite of the ChangeSet's ChangeWorkflow, evaluated over each Space the ChangeSet was opened in. */
|
|
4935
|
+
Gates?: components["schemas"]["PromoteGateResult"][];
|
|
4936
|
+
};
|
|
4891
4937
|
ChangeSetCreateOrUpdateResponse: {
|
|
4892
4938
|
ChangeSet?: components["schemas"]["ChangeSet"];
|
|
4893
4939
|
Error?: components["schemas"]["ResponseError"];
|
|
4894
4940
|
};
|
|
4941
|
+
ChangeSetReviewRequest: {
|
|
4942
|
+
/**
|
|
4943
|
+
* Format: date-time
|
|
4944
|
+
* @description When the review was requested, by the server's clock. A new request is stamped with the current time, and an existing one keeps its time; sending a later time than the one recorded re-requests the review, and stamps it with the current time.
|
|
4945
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
4946
|
+
*/
|
|
4947
|
+
RequestedAt?: string;
|
|
4948
|
+
/**
|
|
4949
|
+
* Format: uuid
|
|
4950
|
+
* @description Who requested the review, or last re-requested it. Set by the server.
|
|
4951
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4952
|
+
*/
|
|
4953
|
+
readonly RequestedByUserID?: string;
|
|
4954
|
+
/**
|
|
4955
|
+
* Format: uuid
|
|
4956
|
+
* @description The User asked to review.
|
|
4957
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4958
|
+
*/
|
|
4959
|
+
UserID: string;
|
|
4960
|
+
};
|
|
4895
4961
|
/** @description Declares how a change is promoted: the ordered stages it moves through, which Spaces each stage selects, and the gates that have to pass before it enters one. */
|
|
4896
4962
|
ChangeWorkflow: {
|
|
4897
4963
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -4927,7 +4993,7 @@ interface components {
|
|
|
4927
4993
|
DisplayName?: string;
|
|
4928
4994
|
/** @description The type of entity. */
|
|
4929
4995
|
readonly EntityType?: string;
|
|
4930
|
-
/** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
4996
|
+
/** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, it is what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
4931
4997
|
Final?: components["schemas"]["ChangeWorkflowFinalStage"];
|
|
4932
4998
|
/** @description SHA256 hash of the change workflow's Stages, Final, CustomPrerequisites and AttestationPrerequisites encoded as hexadecimal. (readonly) */
|
|
4933
4999
|
readonly Hash?: string;
|
|
@@ -4955,8 +5021,8 @@ interface components {
|
|
|
4955
5021
|
SpaceID?: string;
|
|
4956
5022
|
/** @description Slug of the Space this entity belongs to. (readonly) */
|
|
4957
5023
|
readonly SpaceSlug?: string;
|
|
4958
|
-
/** @description Stages is the series a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
4959
|
-
Stages
|
|
5024
|
+
/** @description Stages is the series a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
5025
|
+
Stages?: components["schemas"]["ChangeWorkflowStage"][];
|
|
4960
5026
|
/**
|
|
4961
5027
|
* Format: date-time
|
|
4962
5028
|
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
@@ -5007,7 +5073,7 @@ interface components {
|
|
|
5007
5073
|
ChangeWorkflowPrerequisite: {
|
|
5008
5074
|
/** @description What the gate checks, in the author's words. A promotion this gate holds up reports the prerequisite by Name, so this is where the reason lives. Read by nobody: it is not part of what the gate evaluates. */
|
|
5009
5075
|
Description?: string;
|
|
5010
|
-
/** @description The check itself, carrying the "cel:" prefix. Evaluated against the Space under consideration, the change order being promoted, and that Space's Release. Compiled when the workflow is written. */
|
|
5076
|
+
/** @description The check itself, carrying the "cel:" prefix. Evaluated against the Space under consideration, the change order being promoted, and that Space's Release; closing a ChangeSet binds Space and ChangeSet, with ChangeOrder and Release null. Compiled when the workflow is written. */
|
|
5011
5077
|
Expression: string;
|
|
5012
5078
|
/** @description What a stage or Final gates on. Unique within a workflow, and refused if it shadows a built-in name. */
|
|
5013
5079
|
Name: string;
|
|
@@ -5017,10 +5083,10 @@ interface components {
|
|
|
5017
5083
|
AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][];
|
|
5018
5084
|
/** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
|
|
5019
5085
|
CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][];
|
|
5020
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
5086
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
5021
5087
|
Final?: components["schemas"]["ChangeWorkflowFinalStage"];
|
|
5022
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
5023
|
-
Stages
|
|
5088
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
5089
|
+
Stages?: components["schemas"]["ChangeWorkflowStage"][];
|
|
5024
5090
|
};
|
|
5025
5091
|
ChangeWorkflowStage: {
|
|
5026
5092
|
/** @description Identifies the stage within the workflow, and is what a promotion reports the change as having entered. Unique within a workflow. */
|
|
@@ -5314,9 +5380,9 @@ interface components {
|
|
|
5314
5380
|
Options?: components["schemas"]["CommandOption"][];
|
|
5315
5381
|
Returns?: components["schemas"]["Schema"];
|
|
5316
5382
|
};
|
|
5317
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
5383
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
5318
5384
|
Component: {
|
|
5319
|
-
/** @description The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants. Changing it requires Manage permission on the component. (optional) */
|
|
5385
|
+
/** @description The set of ChangeWorkflows that can be used for promotions and releases of this component's Variants, and for ChangeSets opened on their Units: a ChangeOrder or ChangeSet is governed by one workflow, which every component it reaches has to allow. Changing it requires Manage permission on the component. (optional) */
|
|
5320
5386
|
AllowedChangeWorkflowIDs?: components["schemas"]["UUID"][];
|
|
5321
5387
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
5322
5388
|
Annotations?: {
|
|
@@ -5327,7 +5393,7 @@ interface components {
|
|
|
5327
5393
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5328
5394
|
*/
|
|
5329
5395
|
readonly BackingUnitID?: string;
|
|
5330
|
-
/** @description Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants. Changing it requires Manage permission on the component. (optional) */
|
|
5396
|
+
/** @description Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
5331
5397
|
ChangeWorkflowRequired?: boolean;
|
|
5332
5398
|
/**
|
|
5333
5399
|
* Format: uuid
|
|
@@ -8962,6 +9028,8 @@ interface components {
|
|
|
8962
9028
|
Unit?: components["schemas"]["Unit"];
|
|
8963
9029
|
};
|
|
8964
9030
|
UnitCreateOrUpdateResponse: {
|
|
9031
|
+
/** @description The gates closing the Unit's ChangeSet was judged against, when the write closed, or on a dry run would close, a ChangeSet a ChangeWorkflow governs. Returned for every Unit of the ChangeSet the write detaches. A close the gates refuse fails every such Unit alike, so a write detaching nothing else answers with the refusal alone, whose items name each gate that does not hold, by Space. */
|
|
9032
|
+
ChangeSetClose?: components["schemas"]["ChangeSetCloseResult"];
|
|
8965
9033
|
/** @description The configuration the operation produced; returned when include names ConfigData. */
|
|
8966
9034
|
ConfigData?: string;
|
|
8967
9035
|
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
@@ -9320,10 +9388,16 @@ interface components {
|
|
|
9320
9388
|
ChangeSetDescription?: string;
|
|
9321
9389
|
/**
|
|
9322
9390
|
* Format: uuid
|
|
9323
|
-
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space.
|
|
9391
|
+
* @description An existing ChangeSet to record the writes in. Default: one new ChangeSet per Space. The upload closes it afterwards, unless a ChangeWorkflow governs it.
|
|
9324
9392
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9325
9393
|
*/
|
|
9326
9394
|
ChangeSetID?: string;
|
|
9395
|
+
/**
|
|
9396
|
+
* Format: uuid
|
|
9397
|
+
* @description The ChangeWorkflow governing the ChangeSet the upload opens, which a Space whose Component requires one needs. A ChangeSet a ChangeWorkflow governs is left open, with the Units the upload wrote in it, since closing it is gated on the workflow's Final prerequisites. Not accepted with ChangeSetID, whose ChangeSet names its own.
|
|
9398
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9399
|
+
*/
|
|
9400
|
+
ChangeWorkflowID?: string;
|
|
9327
9401
|
/** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
|
|
9328
9402
|
Clearance?: components["schemas"]["Clearance"];
|
|
9329
9403
|
/** @description Placement of each component. Exactly one is supported. */
|
|
@@ -9387,6 +9461,8 @@ interface components {
|
|
|
9387
9461
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9388
9462
|
*/
|
|
9389
9463
|
ChangeSetID?: string;
|
|
9464
|
+
/** @description The upload left the ChangeSet open, with the Units it wrote in it, because a ChangeWorkflow governs it: closing it is gated on the workflow's Final prerequisites. */
|
|
9465
|
+
ChangeSetOpen?: boolean;
|
|
9390
9466
|
/** @description Resources this upload writes that other Units deployed to the same Target also define: the Space's other Units, and when the Space has a Target, Units elsewhere on that Target. */
|
|
9391
9467
|
Duplicates?: components["schemas"]["UploadDuplicate"][];
|
|
9392
9468
|
Links?: components["schemas"]["UploadLinkResult"][];
|
|
@@ -14799,7 +14875,7 @@ interface operations {
|
|
|
14799
14875
|
* An example conjunction is:
|
|
14800
14876
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14801
14877
|
*
|
|
14802
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
14878
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
14803
14879
|
*
|
|
14804
14880
|
* The whole string must be query-encoded.
|
|
14805
14881
|
*/
|
|
@@ -14884,7 +14960,7 @@ interface operations {
|
|
|
14884
14960
|
*
|
|
14885
14961
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
14886
14962
|
*
|
|
14887
|
-
* Supported attributes for ordering ChangeSet: ChangeSetID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
14963
|
+
* Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
14888
14964
|
*
|
|
14889
14965
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
14890
14966
|
*
|
|
@@ -15013,7 +15089,7 @@ interface operations {
|
|
|
15013
15089
|
* An example conjunction is:
|
|
15014
15090
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15015
15091
|
*
|
|
15016
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15092
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15017
15093
|
*
|
|
15018
15094
|
* The whole string must be query-encoded.
|
|
15019
15095
|
*/
|
|
@@ -15152,6 +15228,8 @@ interface operations {
|
|
|
15152
15228
|
Annotations?: {
|
|
15153
15229
|
[key: string]: string | null;
|
|
15154
15230
|
} | null;
|
|
15231
|
+
/** Format: uuid */
|
|
15232
|
+
ChangeWorkflowID?: string | null;
|
|
15155
15233
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
15156
15234
|
DeleteGates?: {
|
|
15157
15235
|
[key: string]: boolean | null;
|
|
@@ -15168,6 +15246,7 @@ interface operations {
|
|
|
15168
15246
|
Permissions?: {
|
|
15169
15247
|
[key: string]: Record<string, never> | null;
|
|
15170
15248
|
} | null;
|
|
15249
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
15171
15250
|
/** @description Unique URL-safe identifier for the entity. */
|
|
15172
15251
|
Slug?: string | null;
|
|
15173
15252
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -15299,7 +15378,7 @@ interface operations {
|
|
|
15299
15378
|
* An example conjunction is:
|
|
15300
15379
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15301
15380
|
*
|
|
15302
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15381
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15303
15382
|
*
|
|
15304
15383
|
* The whole string must be query-encoded.
|
|
15305
15384
|
*/
|
|
@@ -15501,7 +15580,7 @@ interface operations {
|
|
|
15501
15580
|
* An example conjunction is:
|
|
15502
15581
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15503
15582
|
*
|
|
15504
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15583
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15505
15584
|
*
|
|
15506
15585
|
* The whole string must be query-encoded.
|
|
15507
15586
|
*/
|
|
@@ -15576,6 +15655,8 @@ interface operations {
|
|
|
15576
15655
|
Annotations?: {
|
|
15577
15656
|
[key: string]: string | null;
|
|
15578
15657
|
} | null;
|
|
15658
|
+
/** Format: uuid */
|
|
15659
|
+
ChangeWorkflowID?: string | null;
|
|
15579
15660
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
15580
15661
|
DeleteGates?: {
|
|
15581
15662
|
[key: string]: boolean | null;
|
|
@@ -15592,6 +15673,7 @@ interface operations {
|
|
|
15592
15673
|
Permissions?: {
|
|
15593
15674
|
[key: string]: Record<string, never> | null;
|
|
15594
15675
|
} | null;
|
|
15676
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
15595
15677
|
/** @description Unique URL-safe identifier for the entity. */
|
|
15596
15678
|
Slug?: string | null;
|
|
15597
15679
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -15723,7 +15805,7 @@ interface operations {
|
|
|
15723
15805
|
* An example conjunction is:
|
|
15724
15806
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15725
15807
|
*
|
|
15726
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
15808
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
15727
15809
|
*
|
|
15728
15810
|
* The whole string must be query-encoded.
|
|
15729
15811
|
*/
|
|
@@ -16327,7 +16409,7 @@ interface operations {
|
|
|
16327
16409
|
} | null;
|
|
16328
16410
|
/** @description Friendly name for the entity. */
|
|
16329
16411
|
DisplayName?: string | null;
|
|
16330
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
16412
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
16331
16413
|
Final?: Record<string, never> | null;
|
|
16332
16414
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
16333
16415
|
HiddenReason?: string | null;
|
|
@@ -16340,7 +16422,7 @@ interface operations {
|
|
|
16340
16422
|
} | null;
|
|
16341
16423
|
/** @description Unique URL-safe identifier for the entity. */
|
|
16342
16424
|
Slug?: string | null;
|
|
16343
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
16425
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
16344
16426
|
Stages?: (Record<string, never> | null)[] | null;
|
|
16345
16427
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
16346
16428
|
Version?: number | null;
|
|
@@ -16771,7 +16853,7 @@ interface operations {
|
|
|
16771
16853
|
} | null;
|
|
16772
16854
|
/** @description Friendly name for the entity. */
|
|
16773
16855
|
DisplayName?: string | null;
|
|
16774
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
16856
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
16775
16857
|
Final?: Record<string, never> | null;
|
|
16776
16858
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
16777
16859
|
HiddenReason?: string | null;
|
|
@@ -16784,7 +16866,7 @@ interface operations {
|
|
|
16784
16866
|
} | null;
|
|
16785
16867
|
/** @description Unique URL-safe identifier for the entity. */
|
|
16786
16868
|
Slug?: string | null;
|
|
16787
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
16869
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
16788
16870
|
Stages?: (Record<string, never> | null)[] | null;
|
|
16789
16871
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
16790
16872
|
Version?: number | null;
|
|
@@ -18779,7 +18861,7 @@ interface operations {
|
|
|
18779
18861
|
};
|
|
18780
18862
|
};
|
|
18781
18863
|
responses: {
|
|
18782
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
18864
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
18783
18865
|
200: {
|
|
18784
18866
|
headers: {
|
|
18785
18867
|
[name: string]: unknown;
|
|
@@ -18971,7 +19053,7 @@ interface operations {
|
|
|
18971
19053
|
};
|
|
18972
19054
|
};
|
|
18973
19055
|
responses: {
|
|
18974
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19056
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
18975
19057
|
200: {
|
|
18976
19058
|
headers: {
|
|
18977
19059
|
[name: string]: unknown;
|
|
@@ -19185,7 +19267,7 @@ interface operations {
|
|
|
19185
19267
|
};
|
|
19186
19268
|
};
|
|
19187
19269
|
responses: {
|
|
19188
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19270
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
19189
19271
|
200: {
|
|
19190
19272
|
headers: {
|
|
19191
19273
|
[name: string]: unknown;
|
|
@@ -19355,7 +19437,7 @@ interface operations {
|
|
|
19355
19437
|
};
|
|
19356
19438
|
};
|
|
19357
19439
|
responses: {
|
|
19358
|
-
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants may use, and whether one is required. */
|
|
19440
|
+
/** @description The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, and whether one is required. */
|
|
19359
19441
|
200: {
|
|
19360
19442
|
headers: {
|
|
19361
19443
|
[name: string]: unknown;
|
|
@@ -32343,7 +32425,7 @@ interface operations {
|
|
|
32343
32425
|
* An example conjunction is:
|
|
32344
32426
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
32345
32427
|
*
|
|
32346
|
-
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, Labels, OrganizationID, Permissions, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
32428
|
+
* Supported attributes for filtering on ChangeSet: Annotations, ChangeSetID, ChangeWorkflow, ChangeWorkflowID, CloseOverride, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, Labels, OrganizationID, Permissions, ReviewRequests, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
32347
32429
|
*
|
|
32348
32430
|
* The whole string must be query-encoded.
|
|
32349
32431
|
*/
|
|
@@ -32428,7 +32510,7 @@ interface operations {
|
|
|
32428
32510
|
*
|
|
32429
32511
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
32430
32512
|
*
|
|
32431
|
-
* Supported attributes for ordering ChangeSet: ChangeSetID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt.
|
|
32513
|
+
* Supported attributes for ordering ChangeSet: ChangeSetID, ChangeWorkflowID, CreatedAt, Description, DisplayName, EndTagID, HiddenReason, OrganizationID, Slug, SpaceID, StartTagID, StartTagIsPriorRevision, State, UpdatedAt, UserID.
|
|
32432
32514
|
*
|
|
32433
32515
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
32434
32516
|
*
|
|
@@ -32935,6 +33017,8 @@ interface operations {
|
|
|
32935
33017
|
Annotations?: {
|
|
32936
33018
|
[key: string]: string | null;
|
|
32937
33019
|
} | null;
|
|
33020
|
+
/** Format: uuid */
|
|
33021
|
+
ChangeWorkflowID?: string | null;
|
|
32938
33022
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
32939
33023
|
DeleteGates?: {
|
|
32940
33024
|
[key: string]: boolean | null;
|
|
@@ -32951,6 +33035,7 @@ interface operations {
|
|
|
32951
33035
|
Permissions?: {
|
|
32952
33036
|
[key: string]: Record<string, never> | null;
|
|
32953
33037
|
} | null;
|
|
33038
|
+
ReviewRequests?: (Record<string, never> | null)[] | null;
|
|
32954
33039
|
/** @description Unique URL-safe identifier for the entity. */
|
|
32955
33040
|
Slug?: string | null;
|
|
32956
33041
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -33672,7 +33757,7 @@ interface operations {
|
|
|
33672
33757
|
} | null;
|
|
33673
33758
|
/** @description Friendly name for the entity. */
|
|
33674
33759
|
DisplayName?: string | null;
|
|
33675
|
-
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
|
|
33760
|
+
/** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. In a workflow with no stages, which governs a ChangeSet, what every Space the ChangeSet was opened in must satisfy for it to close. */
|
|
33676
33761
|
Final?: Record<string, never> | null;
|
|
33677
33762
|
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
33678
33763
|
HiddenReason?: string | null;
|
|
@@ -33685,7 +33770,7 @@ interface operations {
|
|
|
33685
33770
|
} | null;
|
|
33686
33771
|
/** @description Unique URL-safe identifier for the entity. */
|
|
33687
33772
|
Slug?: string | null;
|
|
33688
|
-
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one.
|
|
33773
|
+
/** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. A workflow governing a ChangeOrder needs at least one; one governing a ChangeSet has none. */
|
|
33689
33774
|
Stages?: (Record<string, never> | null)[] | null;
|
|
33690
33775
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
33691
33776
|
Version?: number | null;
|
|
@@ -43137,6 +43222,10 @@ interface operations {
|
|
|
43137
43222
|
prior_revisions?: string;
|
|
43138
43223
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
43139
43224
|
subgroup?: string;
|
|
43225
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
43226
|
+
force_close?: boolean;
|
|
43227
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
43228
|
+
force_reason?: string;
|
|
43140
43229
|
/**
|
|
43141
43230
|
* @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
43142
43231
|
*
|
|
@@ -43448,6 +43537,10 @@ interface operations {
|
|
|
43448
43537
|
prior_revisions?: string;
|
|
43449
43538
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
43450
43539
|
subgroup?: string;
|
|
43540
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
43541
|
+
force_close?: boolean;
|
|
43542
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
43543
|
+
force_reason?: string;
|
|
43451
43544
|
/**
|
|
43452
43545
|
* @description Comma-separated parts of the result to return in addition to the Unit: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
43453
43546
|
*
|
|
@@ -52131,6 +52224,10 @@ interface operations {
|
|
|
52131
52224
|
prior_revisions?: string;
|
|
52132
52225
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
52133
52226
|
subgroup?: string;
|
|
52227
|
+
/** @description Close a ChangeSet a ChangeWorkflow governs although the gates of the workflow's Final do not hold. Applies to a write that clears a Unit's ChangeSetID, which closes its ChangeSet. Requires force_reason, and Edit permission on the ChangeSet, whose CloseOverride records the override. */
|
|
52228
|
+
force_close?: boolean;
|
|
52229
|
+
/** @description Why a ChangeSet's gates are overridden; required with force_close. */
|
|
52230
|
+
force_reason?: string;
|
|
52134
52231
|
};
|
|
52135
52232
|
header?: never;
|
|
52136
52233
|
path?: never;
|