@confighub/api 0.10.8 → 0.10.10

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 CHANGED
@@ -2688,7 +2688,7 @@ interface paths {
2688
2688
  put?: never;
2689
2689
  /**
2690
2690
  * Set path guards on a unit
2691
- * @description Set or remove guards on the unit's PathAnnotations. A guard names a reason a path's value is what it is, so a later operation can be required to know about that reason before overwriting it. Nothing enforces guards yet: setting one records the reason and changes no behavior. A guard may name a path or resource the unit does not have, since it is policy about the configuration rather than a statement about its current contents. Creates a new revision only if the guards actually change. Requires Edit permission.
2691
+ * @description Set or remove guards on the unit's PathAnnotations. A guard names a reason a path's value is what it is, so a later operation can be required to know about that reason before overwriting it. An operation that is not cleared for the guards at a path does not write it, and reports what it withheld as a conflict; editing the guards at a path that already has some needs a clearance for them, and so does changing whether one is inherited. A guard set through Set stays with this unit; one set through SetInherited is copied to its clones and carried by merges to the units downstream. A guard may name a path or resource the unit does not have, since it is policy about the configuration rather than a statement about its current contents. Creates a new revision only if the guards actually change. Requires Edit permission.
2692
2692
  */
2693
2693
  post: operations["SetUnitGuard"];
2694
2694
  delete?: never;
@@ -4065,23 +4065,37 @@ interface components {
4065
4065
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4066
4066
  };
4067
4067
  BindingList: components["schemas"]["Binding"][];
4068
+ BlameConflictDismissal: {
4069
+ /** @description For a dismissal of what one guard withheld, the guard's key. */
4070
+ Guard?: string;
4071
+ /** @description The guard's value; empty for any value. */
4072
+ GuardValue?: string;
4073
+ /** @description Where the dismissal is recorded: a path, which may name any list element or map key with *, or empty for the resource as a whole. */
4074
+ Path?: string;
4075
+ /** @description The reason of the conflicts dismissed. */
4076
+ Reason?: string;
4077
+ };
4068
4078
  BlameField: {
4069
4079
  /** @description True for a field the unit does not have, listed because a conflict names it: a merge could not find the path, or the resource, to make an upstream change to. It has no value and no history. */
4070
4080
  Absent?: boolean;
4071
4081
  /** @description The changes that put the value here, from this unit out to where it was set, following each merge and Link resolve upstream. The last is the answer. */
4072
4082
  Chain?: components["schemas"]["BlameOrigin"][];
4083
+ /** @description The conflict dismissals recorded for this row: at the field's path or by a pattern naming it, or, on the row about a resource as a whole, on the resource. The unit's path report lists every dismissal covering the field, its resource's included. */
4084
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
4073
4085
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4086
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
4087
  /** @description True for a field, or a resource, that the unit does not have because a change deleted it: the unit's record still names the deletion. It has no value; its chain is the change that deleted it, and Protected says whether a merge from upstream leaves it deleted. */
4076
4088
  Deleted?: boolean;
4077
4089
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4078
4090
  Findings?: components["schemas"]["LinkFinding"][];
4079
- /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4091
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4080
4092
  Flags?: string[];
4081
4093
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4082
4094
  Guards?: {
4083
4095
  [key: string]: string;
4084
4096
  };
4097
+ /** @description The keys of Guards that are inherited: copied to the unit's clones and carried by merges to the units downstream of it. The others stay with this unit. */
4098
+ InheritedGuards?: string[];
4085
4099
  /** @description The unit's needed paths that are the field: a value it is to take from an upstream unit through a NeedsProvides Link. */
4086
4100
  Needed?: components["schemas"]["BlameNeededPath"][];
4087
4101
  /** @description The field's path, in the syntax functions and Links take. Empty on the row about the resource as a whole, which comes first among the resource's fields and carries what is recorded about the resource rather than one of its fields: the change that added or deleted it, whether it is protected as a whole, its guards, and its conflicts, findings and failed checks that name no path. */
@@ -4324,7 +4338,7 @@ interface components {
4324
4338
  readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
4325
4339
  /**
4326
4340
  * Format: uuid
4327
- * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key.
4341
+ * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key. Every Space the ChangeOrder is headed for has to be selected by one of the workflow's Stages, since a Space in none of them cannot be promoted into; the ChangeOrder's own Space is exempt when the change is already there, as it is for UpgradeUnit and MergeUnits. Creating a ChangeOrder, or an update adding a Space to InScopeSpaceIDs, is refused otherwise.
4328
4342
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4329
4343
  */
4330
4344
  ChangeWorkflowID?: string;
@@ -6055,12 +6069,8 @@ interface components {
6055
6069
  FunctionInvocation: {
6056
6070
  /** @description Function arguments */
6057
6071
  Arguments?: components["schemas"]["FunctionArgument"][] | null;
6058
- /** @description Classes of guarded reason this invocation is cleared for; combined by union with the clearance of whatever drove the execution */
6059
- Clearance?: components["schemas"]["Clearance"];
6060
6072
  /** @description Function name */
6061
6073
  FunctionName?: string;
6062
- /** @description Guards to record on the paths this invocation writes, so a later operation must be cleared for them; combined with the guards of whatever drove the execution, later winning per key */
6063
- Guards?: components["schemas"]["GuardStamp"];
6064
6074
  /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
6065
6075
  Params?: {
6066
6076
  [key: string]: unknown;
@@ -6265,11 +6275,11 @@ interface components {
6265
6275
  Version?: number;
6266
6276
  };
6267
6277
  GuardDelta: {
6268
- /** @description The path whose guards changed; empty for the resource as a whole */
6278
+ /** @description The path whose inherited guards changed; empty for the resource as a whole */
6269
6279
  Path?: string;
6270
- /** @description Guard keys removed */
6280
+ /** @description Inherited guard keys removed */
6271
6281
  Remove?: string[];
6272
- /** @description Guard keys added or changed, with their new values */
6282
+ /** @description Inherited guard keys added or changed, with their new values */
6273
6283
  Set?: {
6274
6284
  [key: string]: string;
6275
6285
  };
@@ -6294,6 +6304,8 @@ interface components {
6294
6304
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6295
6305
  */
6296
6306
  ChannelID?: string;
6307
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
6308
+ Clearance?: components["schemas"]["Clearance"];
6297
6309
  /**
6298
6310
  * Format: date-time
6299
6311
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6309,6 +6321,8 @@ interface components {
6309
6321
  /** @description The type of entity. */
6310
6322
  readonly EntityType?: string;
6311
6323
  FunctionInvocations: components["schemas"]["FunctionInvocationList"];
6324
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
6325
+ Guards?: components["schemas"]["GuardStamp"];
6312
6326
  /** @description SHA256 hash of the functions and their arguments encoded as hexadecimal. */
6313
6327
  readonly Hash?: string;
6314
6328
  /** @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. */
@@ -6591,6 +6605,8 @@ interface components {
6591
6605
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6592
6606
  */
6593
6607
  ChannelID?: string;
6608
+ /** @description The classes of guarded reason the change was filtered with. On a function invocation that is the request's clearance together with that of every Trigger and Invocation that wrote in the same execution; on a Link's change, the Link's */
6609
+ Clearance?: components["schemas"]["Clearance"];
6594
6610
  /**
6595
6611
  * Format: date-time
6596
6612
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6601,8 +6617,12 @@ interface components {
6601
6617
  readonly EntityType?: string;
6602
6618
  /** @description The function invoked if the change was made by a function. */
6603
6619
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
6620
+ /** @description The guards the change recorded on the paths it wrote: the operation's merged with those of the Trigger, Invocation, or Link that produced it */
6621
+ Guards?: components["schemas"]["GuardStamp"];
6604
6622
  /** @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. */
6605
6623
  HiddenReason?: string;
6624
+ /** @description The guards the change recorded as inherited on the paths it wrote, which clones receive and merges carry to the units downstream */
6625
+ InheritedGuards?: components["schemas"]["GuardStamp"];
6606
6626
  /**
6607
6627
  * Format: uuid
6608
6628
  * @description InvocationID is the identifier of the function invoked, if there is a corresponding Invocation.
@@ -7432,18 +7452,24 @@ interface components {
7432
7452
  ToValue?: string;
7433
7453
  };
7434
7454
  ResourceGuards: {
7435
- /** @description Guard keys to remove, by path. Removing a key that is not there is not an error */
7455
+ /** @description Guard keys to remove, by path, named as in Set; * also matches the paths guarded that the data no longer has. Removing a key that is not there is not an error */
7436
7456
  Remove?: {
7437
7457
  [key: string]: string[];
7438
7458
  };
7439
- /** @description Identifies the resource within the Unit whose guards are being edited */
7459
+ /** @description The resource whose guards are being edited: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional. A resource the unit does not have yet is named by ResourceType and ResourceName. */
7440
7460
  Resource?: components["schemas"]["ResourceInfo"];
7441
- /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole */
7461
+ /** @description Guard key/value pairs to add or overwrite, by path, as guards of this unit alone: clones and downstream units do not receive them, and one that was inherited stops being. The empty path addresses the resource as a whole. A list element is named by merge key or by position, and * stands for every element or key there is; a path that does not exist yet is kept as written */
7442
7462
  Set?: {
7443
7463
  [key: string]: {
7444
7464
  [key: string]: string;
7445
7465
  };
7446
7466
  };
7467
+ /** @description Guard key/value pairs to add or overwrite, by path, as inherited guards: a clone of the unit receives them, and a merge carries them, and any later change to them, to the units downstream of it. Named as in Set; a key may not be in both at the same path */
7468
+ SetInherited?: {
7469
+ [key: string]: {
7470
+ [key: string]: string;
7471
+ };
7472
+ };
7447
7473
  };
7448
7474
  ResourceInfo: {
7449
7475
  /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */
@@ -7507,11 +7533,11 @@ interface components {
7507
7533
  ResourceAnnotations?: components["schemas"]["PathAnnotations"];
7508
7534
  };
7509
7535
  ResourceProtection: {
7510
- /** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7536
+ /** @description Map of path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. A list element is named by merge key or by position, and * stands for every element or key there is; a path naming a field the unit deleted is set on the record of that deletion. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7511
7537
  Protected?: {
7512
7538
  [key: string]: boolean;
7513
7539
  } | null;
7514
- /** @description Identifies the resource within the unit whose protection is being set */
7540
+ /** @description The resource whose protection is being set: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional */
7515
7541
  Resource?: components["schemas"]["ResourceInfo"];
7516
7542
  };
7517
7543
  ResourceTypePathsEntry: {
@@ -8701,7 +8727,7 @@ interface components {
8701
8727
  UnitConflictSelector: {
8702
8728
  /** @description Match Guarded and GuardWithheld conflicts every one of whose guards is named here, as key or key=value; empty matches any conflict, guarded or not */
8703
8729
  Guards?: string[];
8704
- /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). */
8730
+ /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). With Undismiss, the path names dismissals as Permanent recorded them: empty, the one on the resource as a whole; *, every one; a path, the one recorded at that path, a pattern included. */
8705
8731
  Path?: string;
8706
8732
  /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8707
8733
  Reason?: string;
@@ -8955,7 +8981,7 @@ interface components {
8955
8981
  UnitID?: string;
8956
8982
  };
8957
8983
  UnitPathReport: {
8958
- /** @description The path's own annotations other than guards, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8984
+ /** @description The path's own annotations other than guards, their inheritance and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8959
8985
  Annotations?: {
8960
8986
  [key: string]: {
8961
8987
  [key: string]: string;
@@ -8963,6 +8989,8 @@ interface components {
8963
8989
  };
8964
8990
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
8965
8991
  Changes?: components["schemas"]["BlamePathChange"][];
8992
+ /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
8993
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
8966
8994
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
8967
8995
  Field?: components["schemas"]["BlameField"];
8968
8996
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
@@ -20163,6 +20191,8 @@ interface operations {
20163
20191
  clearance?: string;
20164
20192
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
20165
20193
  guards?: string;
20194
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
20195
+ inherited_guards?: string;
20166
20196
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
20167
20197
  change_set_id?: string;
20168
20198
  /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
@@ -20922,7 +20952,7 @@ interface operations {
20922
20952
  * An example conjunction is:
20923
20953
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20924
20954
  *
20925
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
20955
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
20926
20956
  *
20927
20957
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
20928
20958
  *
@@ -21146,7 +21176,7 @@ interface operations {
21146
21176
  * An example conjunction is:
21147
21177
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21148
21178
  *
21149
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21179
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21150
21180
  *
21151
21181
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21152
21182
  *
@@ -21339,6 +21369,8 @@ interface operations {
21339
21369
  } | null;
21340
21370
  /** Format: uuid */
21341
21371
  ChannelID?: string | null;
21372
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
21373
+ Clearance?: (Record<string, never> | null)[] | null;
21342
21374
  /** @description An optional set of gates that, if any is present, will block deletion */
21343
21375
  DeleteGates?: {
21344
21376
  [key: string]: boolean | null;
@@ -21346,6 +21378,10 @@ interface operations {
21346
21378
  /** @description Friendly name for the entity. */
21347
21379
  DisplayName?: string | null;
21348
21380
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21381
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
21382
+ Guards?: {
21383
+ [key: string]: string | null;
21384
+ } | null;
21349
21385
  /** @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. */
21350
21386
  HiddenReason?: string | null;
21351
21387
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21497,7 +21533,7 @@ interface operations {
21497
21533
  * An example conjunction is:
21498
21534
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21499
21535
  *
21500
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21536
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21501
21537
  *
21502
21538
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21503
21539
  *
@@ -21701,7 +21737,7 @@ interface operations {
21701
21737
  * An example conjunction is:
21702
21738
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21703
21739
  *
21704
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21740
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21705
21741
  *
21706
21742
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21707
21743
  *
@@ -21784,6 +21820,8 @@ interface operations {
21784
21820
  } | null;
21785
21821
  /** Format: uuid */
21786
21822
  ChannelID?: string | null;
21823
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
21824
+ Clearance?: (Record<string, never> | null)[] | null;
21787
21825
  /** @description An optional set of gates that, if any is present, will block deletion */
21788
21826
  DeleteGates?: {
21789
21827
  [key: string]: boolean | null;
@@ -21791,6 +21829,10 @@ interface operations {
21791
21829
  /** @description Friendly name for the entity. */
21792
21830
  DisplayName?: string | null;
21793
21831
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21832
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
21833
+ Guards?: {
21834
+ [key: string]: string | null;
21835
+ } | null;
21794
21836
  /** @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. */
21795
21837
  HiddenReason?: string | null;
21796
21838
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21942,7 +21984,7 @@ interface operations {
21942
21984
  * An example conjunction is:
21943
21985
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21944
21986
  *
21945
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21987
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21946
21988
  *
21947
21989
  * The whole string must be query-encoded.
21948
21990
  */
@@ -36000,6 +36042,8 @@ interface operations {
36000
36042
  clearance?: string;
36001
36043
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
36002
36044
  guards?: string;
36045
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
36046
+ inherited_guards?: string;
36003
36047
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
36004
36048
  change_set_id?: string;
36005
36049
  /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
@@ -36256,7 +36300,7 @@ interface operations {
36256
36300
  * An example conjunction is:
36257
36301
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
36258
36302
  *
36259
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
36303
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
36260
36304
  *
36261
36305
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
36262
36306
  *
@@ -36859,6 +36903,8 @@ interface operations {
36859
36903
  } | null;
36860
36904
  /** Format: uuid */
36861
36905
  ChannelID?: string | null;
36906
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
36907
+ Clearance?: (Record<string, never> | null)[] | null;
36862
36908
  /** @description An optional set of gates that, if any is present, will block deletion */
36863
36909
  DeleteGates?: {
36864
36910
  [key: string]: boolean | null;
@@ -36866,6 +36912,10 @@ interface operations {
36866
36912
  /** @description Friendly name for the entity. */
36867
36913
  DisplayName?: string | null;
36868
36914
  FunctionInvocations?: (Record<string, never> | null)[] | null;
36915
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
36916
+ Guards?: {
36917
+ [key: string]: string | null;
36918
+ } | null;
36869
36919
  /** @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. */
36870
36920
  HiddenReason?: string | null;
36871
36921
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -42106,6 +42156,8 @@ interface operations {
42106
42156
  clearance?: string;
42107
42157
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42108
42158
  guards?: string;
42159
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42160
+ inherited_guards?: string;
42109
42161
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
42110
42162
  squash?: boolean;
42111
42163
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42159,7 +42211,7 @@ interface operations {
42159
42211
  * An example conjunction is:
42160
42212
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42161
42213
  *
42162
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42214
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42163
42215
  *
42164
42216
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42165
42217
  *
@@ -42421,6 +42473,8 @@ interface operations {
42421
42473
  clearance?: string;
42422
42474
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42423
42475
  guards?: string;
42476
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42477
+ inherited_guards?: string;
42424
42478
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
42425
42479
  squash?: boolean;
42426
42480
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42474,7 +42528,7 @@ interface operations {
42474
42528
  * An example conjunction is:
42475
42529
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42476
42530
  *
42477
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42531
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42478
42532
  *
42479
42533
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42480
42534
  *
@@ -42662,7 +42716,7 @@ interface operations {
42662
42716
  /**
42663
42717
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42664
42718
  *
42665
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42719
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42666
42720
  */
42667
42721
  flags?: string;
42668
42722
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
@@ -42938,6 +42992,8 @@ interface operations {
42938
42992
  clearance?: string;
42939
42993
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42940
42994
  guards?: string;
42995
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42996
+ inherited_guards?: string;
42941
42997
  /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
42942
42998
  merge_base?: string;
42943
42999
  /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
@@ -43265,9 +43321,9 @@ interface operations {
43265
43321
  * An example conjunction is:
43266
43322
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
43267
43323
  *
43268
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
43324
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
43269
43325
  *
43270
- * The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName`, `FunctionInvocation.Guards.<reason>`, and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
43326
+ * The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName` and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. `Guards.<reason>` reads the guards the change recorded on the paths it wrote, as in `Guards.Link = 'TransformPaths'`, and `Clearance.*.Key = 'RunAsRoot'` finds the changes written under a clearance for that reason.
43271
43327
  *
43272
43328
  * The whole string must be query-encoded.
43273
43329
  */
@@ -51103,6 +51159,8 @@ interface operations {
51103
51159
  clearance?: string;
51104
51160
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
51105
51161
  guards?: string;
51162
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
51163
+ inherited_guards?: string;
51106
51164
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
51107
51165
  squash?: boolean;
51108
51166
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -51156,7 +51214,7 @@ interface operations {
51156
51214
  * An example conjunction is:
51157
51215
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51158
51216
  *
51159
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
51217
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
51160
51218
  *
51161
51219
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
51162
51220
  *
@@ -51867,7 +51925,7 @@ interface operations {
51867
51925
  /**
51868
51926
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51869
51927
  *
51870
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51928
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51871
51929
  */
51872
51930
  flags?: string;
51873
51931
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
package/dist/index.d.ts CHANGED
@@ -2688,7 +2688,7 @@ interface paths {
2688
2688
  put?: never;
2689
2689
  /**
2690
2690
  * Set path guards on a unit
2691
- * @description Set or remove guards on the unit's PathAnnotations. A guard names a reason a path's value is what it is, so a later operation can be required to know about that reason before overwriting it. Nothing enforces guards yet: setting one records the reason and changes no behavior. A guard may name a path or resource the unit does not have, since it is policy about the configuration rather than a statement about its current contents. Creates a new revision only if the guards actually change. Requires Edit permission.
2691
+ * @description Set or remove guards on the unit's PathAnnotations. A guard names a reason a path's value is what it is, so a later operation can be required to know about that reason before overwriting it. An operation that is not cleared for the guards at a path does not write it, and reports what it withheld as a conflict; editing the guards at a path that already has some needs a clearance for them, and so does changing whether one is inherited. A guard set through Set stays with this unit; one set through SetInherited is copied to its clones and carried by merges to the units downstream. A guard may name a path or resource the unit does not have, since it is policy about the configuration rather than a statement about its current contents. Creates a new revision only if the guards actually change. Requires Edit permission.
2692
2692
  */
2693
2693
  post: operations["SetUnitGuard"];
2694
2694
  delete?: never;
@@ -4065,23 +4065,37 @@ interface components {
4065
4065
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4066
4066
  };
4067
4067
  BindingList: components["schemas"]["Binding"][];
4068
+ BlameConflictDismissal: {
4069
+ /** @description For a dismissal of what one guard withheld, the guard's key. */
4070
+ Guard?: string;
4071
+ /** @description The guard's value; empty for any value. */
4072
+ GuardValue?: string;
4073
+ /** @description Where the dismissal is recorded: a path, which may name any list element or map key with *, or empty for the resource as a whole. */
4074
+ Path?: string;
4075
+ /** @description The reason of the conflicts dismissed. */
4076
+ Reason?: string;
4077
+ };
4068
4078
  BlameField: {
4069
4079
  /** @description True for a field the unit does not have, listed because a conflict names it: a merge could not find the path, or the resource, to make an upstream change to. It has no value and no history. */
4070
4080
  Absent?: boolean;
4071
4081
  /** @description The changes that put the value here, from this unit out to where it was set, following each merge and Link resolve upstream. The last is the answer. */
4072
4082
  Chain?: components["schemas"]["BlameOrigin"][];
4083
+ /** @description The conflict dismissals recorded for this row: at the field's path or by a pattern naming it, or, on the row about a resource as a whole, on the resource. The unit's path report lists every dismissal covering the field, its resource's included. */
4084
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
4073
4085
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4086
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
4087
  /** @description True for a field, or a resource, that the unit does not have because a change deleted it: the unit's record still names the deletion. It has no value; its chain is the change that deleted it, and Protected says whether a merge from upstream leaves it deleted. */
4076
4088
  Deleted?: boolean;
4077
4089
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4078
4090
  Findings?: components["schemas"]["LinkFinding"][];
4079
- /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4091
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4080
4092
  Flags?: string[];
4081
4093
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4082
4094
  Guards?: {
4083
4095
  [key: string]: string;
4084
4096
  };
4097
+ /** @description The keys of Guards that are inherited: copied to the unit's clones and carried by merges to the units downstream of it. The others stay with this unit. */
4098
+ InheritedGuards?: string[];
4085
4099
  /** @description The unit's needed paths that are the field: a value it is to take from an upstream unit through a NeedsProvides Link. */
4086
4100
  Needed?: components["schemas"]["BlameNeededPath"][];
4087
4101
  /** @description The field's path, in the syntax functions and Links take. Empty on the row about the resource as a whole, which comes first among the resource's fields and carries what is recorded about the resource rather than one of its fields: the change that added or deleted it, whether it is protected as a whole, its guards, and its conflicts, findings and failed checks that name no path. */
@@ -4324,7 +4338,7 @@ interface components {
4324
4338
  readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
4325
4339
  /**
4326
4340
  * Format: uuid
4327
- * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key.
4341
+ * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key. Every Space the ChangeOrder is headed for has to be selected by one of the workflow's Stages, since a Space in none of them cannot be promoted into; the ChangeOrder's own Space is exempt when the change is already there, as it is for UpgradeUnit and MergeUnits. Creating a ChangeOrder, or an update adding a Space to InScopeSpaceIDs, is refused otherwise.
4328
4342
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4329
4343
  */
4330
4344
  ChangeWorkflowID?: string;
@@ -6055,12 +6069,8 @@ interface components {
6055
6069
  FunctionInvocation: {
6056
6070
  /** @description Function arguments */
6057
6071
  Arguments?: components["schemas"]["FunctionArgument"][] | null;
6058
- /** @description Classes of guarded reason this invocation is cleared for; combined by union with the clearance of whatever drove the execution */
6059
- Clearance?: components["schemas"]["Clearance"];
6060
6072
  /** @description Function name */
6061
6073
  FunctionName?: string;
6062
- /** @description Guards to record on the paths this invocation writes, so a later operation must be cleared for them; combined with the guards of whatever drove the execution, later winning per key */
6063
- Guards?: components["schemas"]["GuardStamp"];
6064
6074
  /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
6065
6075
  Params?: {
6066
6076
  [key: string]: unknown;
@@ -6265,11 +6275,11 @@ interface components {
6265
6275
  Version?: number;
6266
6276
  };
6267
6277
  GuardDelta: {
6268
- /** @description The path whose guards changed; empty for the resource as a whole */
6278
+ /** @description The path whose inherited guards changed; empty for the resource as a whole */
6269
6279
  Path?: string;
6270
- /** @description Guard keys removed */
6280
+ /** @description Inherited guard keys removed */
6271
6281
  Remove?: string[];
6272
- /** @description Guard keys added or changed, with their new values */
6282
+ /** @description Inherited guard keys added or changed, with their new values */
6273
6283
  Set?: {
6274
6284
  [key: string]: string;
6275
6285
  };
@@ -6294,6 +6304,8 @@ interface components {
6294
6304
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6295
6305
  */
6296
6306
  ChannelID?: string;
6307
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
6308
+ Clearance?: components["schemas"]["Clearance"];
6297
6309
  /**
6298
6310
  * Format: date-time
6299
6311
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6309,6 +6321,8 @@ interface components {
6309
6321
  /** @description The type of entity. */
6310
6322
  readonly EntityType?: string;
6311
6323
  FunctionInvocations: components["schemas"]["FunctionInvocationList"];
6324
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
6325
+ Guards?: components["schemas"]["GuardStamp"];
6312
6326
  /** @description SHA256 hash of the functions and their arguments encoded as hexadecimal. */
6313
6327
  readonly Hash?: string;
6314
6328
  /** @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. */
@@ -6591,6 +6605,8 @@ interface components {
6591
6605
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6592
6606
  */
6593
6607
  ChannelID?: string;
6608
+ /** @description The classes of guarded reason the change was filtered with. On a function invocation that is the request's clearance together with that of every Trigger and Invocation that wrote in the same execution; on a Link's change, the Link's */
6609
+ Clearance?: components["schemas"]["Clearance"];
6594
6610
  /**
6595
6611
  * Format: date-time
6596
6612
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6601,8 +6617,12 @@ interface components {
6601
6617
  readonly EntityType?: string;
6602
6618
  /** @description The function invoked if the change was made by a function. */
6603
6619
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
6620
+ /** @description The guards the change recorded on the paths it wrote: the operation's merged with those of the Trigger, Invocation, or Link that produced it */
6621
+ Guards?: components["schemas"]["GuardStamp"];
6604
6622
  /** @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. */
6605
6623
  HiddenReason?: string;
6624
+ /** @description The guards the change recorded as inherited on the paths it wrote, which clones receive and merges carry to the units downstream */
6625
+ InheritedGuards?: components["schemas"]["GuardStamp"];
6606
6626
  /**
6607
6627
  * Format: uuid
6608
6628
  * @description InvocationID is the identifier of the function invoked, if there is a corresponding Invocation.
@@ -7432,18 +7452,24 @@ interface components {
7432
7452
  ToValue?: string;
7433
7453
  };
7434
7454
  ResourceGuards: {
7435
- /** @description Guard keys to remove, by path. Removing a key that is not there is not an error */
7455
+ /** @description Guard keys to remove, by path, named as in Set; * also matches the paths guarded that the data no longer has. Removing a key that is not there is not an error */
7436
7456
  Remove?: {
7437
7457
  [key: string]: string[];
7438
7458
  };
7439
- /** @description Identifies the resource within the Unit whose guards are being edited */
7459
+ /** @description The resource whose guards are being edited: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional. A resource the unit does not have yet is named by ResourceType and ResourceName. */
7440
7460
  Resource?: components["schemas"]["ResourceInfo"];
7441
- /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole */
7461
+ /** @description Guard key/value pairs to add or overwrite, by path, as guards of this unit alone: clones and downstream units do not receive them, and one that was inherited stops being. The empty path addresses the resource as a whole. A list element is named by merge key or by position, and * stands for every element or key there is; a path that does not exist yet is kept as written */
7442
7462
  Set?: {
7443
7463
  [key: string]: {
7444
7464
  [key: string]: string;
7445
7465
  };
7446
7466
  };
7467
+ /** @description Guard key/value pairs to add or overwrite, by path, as inherited guards: a clone of the unit receives them, and a merge carries them, and any later change to them, to the units downstream of it. Named as in Set; a key may not be in both at the same path */
7468
+ SetInherited?: {
7469
+ [key: string]: {
7470
+ [key: string]: string;
7471
+ };
7472
+ };
7447
7473
  };
7448
7474
  ResourceInfo: {
7449
7475
  /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */
@@ -7507,11 +7533,11 @@ interface components {
7507
7533
  ResourceAnnotations?: components["schemas"]["PathAnnotations"];
7508
7534
  };
7509
7535
  ResourceProtection: {
7510
- /** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7536
+ /** @description Map of path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. A list element is named by merge key or by position, and * stands for every element or key there is; a path naming a field the unit deleted is set on the record of that deletion. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7511
7537
  Protected?: {
7512
7538
  [key: string]: boolean;
7513
7539
  } | null;
7514
- /** @description Identifies the resource within the unit whose protection is being set */
7540
+ /** @description The resource whose protection is being set: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional */
7515
7541
  Resource?: components["schemas"]["ResourceInfo"];
7516
7542
  };
7517
7543
  ResourceTypePathsEntry: {
@@ -8701,7 +8727,7 @@ interface components {
8701
8727
  UnitConflictSelector: {
8702
8728
  /** @description Match Guarded and GuardWithheld conflicts every one of whose guards is named here, as key or key=value; empty matches any conflict, guarded or not */
8703
8729
  Guards?: string[];
8704
- /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). */
8730
+ /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). With Undismiss, the path names dismissals as Permanent recorded them: empty, the one on the resource as a whole; *, every one; a path, the one recorded at that path, a pattern included. */
8705
8731
  Path?: string;
8706
8732
  /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8707
8733
  Reason?: string;
@@ -8955,7 +8981,7 @@ interface components {
8955
8981
  UnitID?: string;
8956
8982
  };
8957
8983
  UnitPathReport: {
8958
- /** @description The path's own annotations other than guards, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8984
+ /** @description The path's own annotations other than guards, their inheritance and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8959
8985
  Annotations?: {
8960
8986
  [key: string]: {
8961
8987
  [key: string]: string;
@@ -8963,6 +8989,8 @@ interface components {
8963
8989
  };
8964
8990
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
8965
8991
  Changes?: components["schemas"]["BlamePathChange"][];
8992
+ /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
8993
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
8966
8994
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
8967
8995
  Field?: components["schemas"]["BlameField"];
8968
8996
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
@@ -20163,6 +20191,8 @@ interface operations {
20163
20191
  clearance?: string;
20164
20192
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
20165
20193
  guards?: string;
20194
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
20195
+ inherited_guards?: string;
20166
20196
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
20167
20197
  change_set_id?: string;
20168
20198
  /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
@@ -20922,7 +20952,7 @@ interface operations {
20922
20952
  * An example conjunction is:
20923
20953
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20924
20954
  *
20925
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
20955
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
20926
20956
  *
20927
20957
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
20928
20958
  *
@@ -21146,7 +21176,7 @@ interface operations {
21146
21176
  * An example conjunction is:
21147
21177
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21148
21178
  *
21149
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21179
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21150
21180
  *
21151
21181
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21152
21182
  *
@@ -21339,6 +21369,8 @@ interface operations {
21339
21369
  } | null;
21340
21370
  /** Format: uuid */
21341
21371
  ChannelID?: string | null;
21372
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
21373
+ Clearance?: (Record<string, never> | null)[] | null;
21342
21374
  /** @description An optional set of gates that, if any is present, will block deletion */
21343
21375
  DeleteGates?: {
21344
21376
  [key: string]: boolean | null;
@@ -21346,6 +21378,10 @@ interface operations {
21346
21378
  /** @description Friendly name for the entity. */
21347
21379
  DisplayName?: string | null;
21348
21380
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21381
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
21382
+ Guards?: {
21383
+ [key: string]: string | null;
21384
+ } | null;
21349
21385
  /** @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. */
21350
21386
  HiddenReason?: string | null;
21351
21387
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21497,7 +21533,7 @@ interface operations {
21497
21533
  * An example conjunction is:
21498
21534
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21499
21535
  *
21500
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21536
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21501
21537
  *
21502
21538
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21503
21539
  *
@@ -21701,7 +21737,7 @@ interface operations {
21701
21737
  * An example conjunction is:
21702
21738
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21703
21739
  *
21704
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21740
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21705
21741
  *
21706
21742
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
21707
21743
  *
@@ -21784,6 +21820,8 @@ interface operations {
21784
21820
  } | null;
21785
21821
  /** Format: uuid */
21786
21822
  ChannelID?: string | null;
21823
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
21824
+ Clearance?: (Record<string, never> | null)[] | null;
21787
21825
  /** @description An optional set of gates that, if any is present, will block deletion */
21788
21826
  DeleteGates?: {
21789
21827
  [key: string]: boolean | null;
@@ -21791,6 +21829,10 @@ interface operations {
21791
21829
  /** @description Friendly name for the entity. */
21792
21830
  DisplayName?: string | null;
21793
21831
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21832
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
21833
+ Guards?: {
21834
+ [key: string]: string | null;
21835
+ } | null;
21794
21836
  /** @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. */
21795
21837
  HiddenReason?: string | null;
21796
21838
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21942,7 +21984,7 @@ interface operations {
21942
21984
  * An example conjunction is:
21943
21985
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21944
21986
  *
21945
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21987
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
21946
21988
  *
21947
21989
  * The whole string must be query-encoded.
21948
21990
  */
@@ -36000,6 +36042,8 @@ interface operations {
36000
36042
  clearance?: string;
36001
36043
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
36002
36044
  guards?: string;
36045
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
36046
+ inherited_guards?: string;
36003
36047
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
36004
36048
  change_set_id?: string;
36005
36049
  /** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
@@ -36256,7 +36300,7 @@ interface operations {
36256
36300
  * An example conjunction is:
36257
36301
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
36258
36302
  *
36259
- * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
36303
+ * Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
36260
36304
  *
36261
36305
  * The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
36262
36306
  *
@@ -36859,6 +36903,8 @@ interface operations {
36859
36903
  } | null;
36860
36904
  /** Format: uuid */
36861
36905
  ChannelID?: string | null;
36906
+ /** @description Classes of guarded reason this Invocation's functions are cleared for; combined by union with the clearance of the Trigger or API call that runs it */
36907
+ Clearance?: (Record<string, never> | null)[] | null;
36862
36908
  /** @description An optional set of gates that, if any is present, will block deletion */
36863
36909
  DeleteGates?: {
36864
36910
  [key: string]: boolean | null;
@@ -36866,6 +36912,10 @@ interface operations {
36866
36912
  /** @description Friendly name for the entity. */
36867
36913
  DisplayName?: string | null;
36868
36914
  FunctionInvocations?: (Record<string, never> | null)[] | null;
36915
+ /** @description Guards to record on the paths this Invocation's functions write, so a later operation must be cleared for them; combined with the guards of a Trigger running it, the Trigger's winning per key. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Clearance must cover them. */
36916
+ Guards?: {
36917
+ [key: string]: string | null;
36918
+ } | null;
36869
36919
  /** @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. */
36870
36920
  HiddenReason?: string | null;
36871
36921
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -42106,6 +42156,8 @@ interface operations {
42106
42156
  clearance?: string;
42107
42157
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42108
42158
  guards?: string;
42159
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42160
+ inherited_guards?: string;
42109
42161
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
42110
42162
  squash?: boolean;
42111
42163
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42159,7 +42211,7 @@ interface operations {
42159
42211
  * An example conjunction is:
42160
42212
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42161
42213
  *
42162
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42214
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42163
42215
  *
42164
42216
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42165
42217
  *
@@ -42421,6 +42473,8 @@ interface operations {
42421
42473
  clearance?: string;
42422
42474
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42423
42475
  guards?: string;
42476
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42477
+ inherited_guards?: string;
42424
42478
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
42425
42479
  squash?: boolean;
42426
42480
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42474,7 +42528,7 @@ interface operations {
42474
42528
  * An example conjunction is:
42475
42529
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42476
42530
  *
42477
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42531
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
42478
42532
  *
42479
42533
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42480
42534
  *
@@ -42662,7 +42716,7 @@ interface operations {
42662
42716
  /**
42663
42717
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42664
42718
  *
42665
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42719
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42666
42720
  */
42667
42721
  flags?: string;
42668
42722
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
@@ -42938,6 +42992,8 @@ interface operations {
42938
42992
  clearance?: string;
42939
42993
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
42940
42994
  guards?: string;
42995
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
42996
+ inherited_guards?: string;
42941
42997
  /** @description Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
42942
42998
  merge_base?: string;
42943
42999
  /** @description Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
@@ -43265,9 +43321,9 @@ interface operations {
43265
43321
  * An example conjunction is:
43266
43322
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
43267
43323
  *
43268
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
43324
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
43269
43325
  *
43270
- * The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName`, `FunctionInvocation.Guards.<reason>`, and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
43326
+ * The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName` and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName. `Guards.<reason>` reads the guards the change recorded on the paths it wrote, as in `Guards.Link = 'TransformPaths'`, and `Clearance.*.Key = 'RunAsRoot'` finds the changes written under a clearance for that reason.
43271
43327
  *
43272
43328
  * The whole string must be query-encoded.
43273
43329
  */
@@ -51103,6 +51159,8 @@ interface operations {
51103
51159
  clearance?: string;
51104
51160
  /** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
51105
51161
  guards?: string;
51162
+ /** @description The guards this operation records on the paths it writes as inherited guards, in the form guards takes: a clone of the Unit receives them, and a merge carries them, and any later change to them, to the Units downstream of it. Guards set through guards stay with the Unit they are on. A key may not be in both. The clearance has to cover these as it covers guards. */
51163
+ inherited_guards?: string;
51106
51164
  /** @description Merge the range as one rebased diff and record it as one Revision, instead of walking it. By default a merge replays: it takes the source's Revisions in order and, where a Revision records function invocations that can be re-executed, runs them against this Unit rather than rebasing their recorded paths onto it -- so a change lands where this Unit's own structure puts it -- and records each source Revision that has an effect here as a Revision of its own, carrying that Revision's change description, its own conflicts, and one Mutation per source Mutation. Squashing gives up both: the range arrives as a single rebased patch in a single Revision, which is what a merge did before replay existed. Accepted with upgrade, merge_source, and resolve of an UpgradeUnit or MergeUnits Link, and refused elsewhere, since there is no range to walk. A Link can ask for it standingly with its Squash field. */
51107
51165
  squash?: boolean;
51108
51166
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -51156,7 +51214,7 @@ interface operations {
51156
51214
  * An example conjunction is:
51157
51215
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51158
51216
  *
51159
- * Supported attributes for filtering on Mutation: ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
51217
+ * Supported attributes for filtering on Mutation: ChannelID, Clearance, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.FunctionName, FunctionInvocation.WhereResource, FunctionName, Guards, HiddenReason, InheritedGuards, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
51160
51218
  *
51161
51219
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
51162
51220
  *
@@ -51867,7 +51925,7 @@ interface operations {
51867
51925
  /**
51868
51926
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51869
51927
  *
51870
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51928
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51871
51929
  */
51872
51930
  flags?: string;
51873
51931
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.10.8",
3
+ "version": "0.10.10",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {