@confighub/api 0.10.9 → 0.10.11

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;
@@ -4094,6 +4094,8 @@ interface components {
4094
4094
  Guards?: {
4095
4095
  [key: string]: string;
4096
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[];
4097
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. */
4098
4100
  Needed?: components["schemas"]["BlameNeededPath"][];
4099
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. */
@@ -6067,12 +6069,8 @@ interface components {
6067
6069
  FunctionInvocation: {
6068
6070
  /** @description Function arguments */
6069
6071
  Arguments?: components["schemas"]["FunctionArgument"][] | null;
6070
- /** @description Classes of guarded reason this invocation is cleared for; combined by union with the clearance of whatever drove the execution */
6071
- Clearance?: components["schemas"]["Clearance"];
6072
6072
  /** @description Function name */
6073
6073
  FunctionName?: string;
6074
- /** @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 */
6075
- Guards?: components["schemas"]["GuardStamp"];
6076
6074
  /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
6077
6075
  Params?: {
6078
6076
  [key: string]: unknown;
@@ -6279,12 +6277,18 @@ interface components {
6279
6277
  GuardDelta: {
6280
6278
  /** @description The path whose guards changed; empty for the resource as a whole */
6281
6279
  Path?: string;
6282
- /** @description Guard keys removed */
6280
+ /** @description Inherited guard keys removed */
6283
6281
  Remove?: string[];
6284
- /** @description Guard keys added or changed, with their new values */
6282
+ /** @description Guard keys removed that stay with the Unit, not inherited; a restore taking out guards the restored Revision did not have */
6283
+ RemoveLocal?: string[];
6284
+ /** @description Inherited guard keys added or changed, with their new values */
6285
6285
  Set?: {
6286
6286
  [key: string]: string;
6287
6287
  };
6288
+ /** @description Guard keys added or changed as guards that stay with the Unit, with their new values; a restore putting back the Unit's own guards */
6289
+ SetLocal?: {
6290
+ [key: string]: string;
6291
+ };
6288
6292
  };
6289
6293
  GuardStamp: {
6290
6294
  [key: string]: string;
@@ -6306,6 +6310,8 @@ interface components {
6306
6310
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6307
6311
  */
6308
6312
  ChannelID?: string;
6313
+ /** @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 */
6314
+ Clearance?: components["schemas"]["Clearance"];
6309
6315
  /**
6310
6316
  * Format: date-time
6311
6317
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6321,6 +6327,8 @@ interface components {
6321
6327
  /** @description The type of entity. */
6322
6328
  readonly EntityType?: string;
6323
6329
  FunctionInvocations: components["schemas"]["FunctionInvocationList"];
6330
+ /** @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. */
6331
+ Guards?: components["schemas"]["GuardStamp"];
6324
6332
  /** @description SHA256 hash of the functions and their arguments encoded as hexadecimal. */
6325
6333
  readonly Hash?: string;
6326
6334
  /** @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. */
@@ -6603,6 +6611,8 @@ interface components {
6603
6611
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6604
6612
  */
6605
6613
  ChannelID?: string;
6614
+ /** @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; on an apply of withheld conflicts, the request's */
6615
+ Clearance?: components["schemas"]["Clearance"];
6606
6616
  /**
6607
6617
  * Format: date-time
6608
6618
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6613,8 +6623,12 @@ interface components {
6613
6623
  readonly EntityType?: string;
6614
6624
  /** @description The function invoked if the change was made by a function. */
6615
6625
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
6626
+ /** @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 */
6627
+ Guards?: components["schemas"]["GuardStamp"];
6616
6628
  /** @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. */
6617
6629
  HiddenReason?: string;
6630
+ /** @description The guards the change recorded as inherited on the paths it wrote, which clones receive and merges carry to the units downstream */
6631
+ InheritedGuards?: components["schemas"]["GuardStamp"];
6618
6632
  /**
6619
6633
  * Format: uuid
6620
6634
  * @description InvocationID is the identifier of the function invoked, if there is a corresponding Invocation.
@@ -7450,12 +7464,18 @@ interface components {
7450
7464
  };
7451
7465
  /** @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. */
7452
7466
  Resource?: components["schemas"]["ResourceInfo"];
7453
- /** @description Guard key/value pairs to add or overwrite, by path. 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 */
7467
+ /** @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 */
7454
7468
  Set?: {
7455
7469
  [key: string]: {
7456
7470
  [key: string]: string;
7457
7471
  };
7458
7472
  };
7473
+ /** @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 */
7474
+ SetInherited?: {
7475
+ [key: string]: {
7476
+ [key: string]: string;
7477
+ };
7478
+ };
7459
7479
  };
7460
7480
  ResourceInfo: {
7461
7481
  /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */
@@ -8727,6 +8747,8 @@ interface components {
8727
8747
  UnitConflictsRequest: {
8728
8748
  /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */
8729
8749
  Action?: string;
8750
+ /** @description With Apply, the classes of guarded reason the applied changes are cleared for, as a list of {Key, Operator, Values} requirements. A withheld value is written only where the guards at its path admit this clearance, and a withheld guard change only where the guards already at its path do; the request is refused otherwise. Not taken by Dismiss or Undismiss, which write no configuration data and no guards. */
8751
+ Clearance?: components["schemas"]["Clearance"];
8730
8752
  /** @description Report what the request would do without writing anything. The response carries the Unit as it would be. */
8731
8753
  DryRun?: boolean;
8732
8754
  /** @description With Dismiss, also dismiss the conflicts each selector matches whenever a later merge reports them. Each selector names one resource, by ResourceName or ResourceNameWithoutScope, and a Reason, and Guards for a guard-caused reason; an empty Path covers every path of the resource. */
@@ -8756,6 +8778,7 @@ interface components {
8756
8778
  ChangeSetClose?: components["schemas"]["ChangeSetCloseResult"];
8757
8779
  /** @description The configuration the operation produced; returned when include names ConfigData. */
8758
8780
  ConfigData?: string;
8781
+ /** @description What this write could not apply: for an upgrade, merge or resolve, each change it withheld, and for any write, each value whose guards its clearance did not cover (Guarded) and each guard change it was not cleared to make (GuardWithheld). For a dry run, what it would withhold. Unit.Conflicts lists every conflict outstanding on the Unit, including those earlier operations left. */
8759
8782
  Conflicts?: components["schemas"]["MutationConflictList"];
8760
8783
  /** @description What the operation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */
8761
8784
  Diff?: components["schemas"]["ConfigDiff"];
@@ -8967,7 +8990,7 @@ interface components {
8967
8990
  UnitID?: string;
8968
8991
  };
8969
8992
  UnitPathReport: {
8970
- /** @description The path's own annotations other than guards and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8993
+ /** @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. */
8971
8994
  Annotations?: {
8972
8995
  [key: string]: {
8973
8996
  [key: string]: string;
@@ -20177,6 +20200,8 @@ interface operations {
20177
20200
  clearance?: string;
20178
20201
  /** @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). */
20179
20202
  guards?: string;
20203
+ /** @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. */
20204
+ inherited_guards?: string;
20180
20205
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
20181
20206
  change_set_id?: string;
20182
20207
  /** @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. */
@@ -20936,7 +20961,7 @@ interface operations {
20936
20961
  * An example conjunction is:
20937
20962
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20938
20963
  *
20939
- * 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.
20964
+ * 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.
20940
20965
  *
20941
20966
  * 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.
20942
20967
  *
@@ -21160,7 +21185,7 @@ interface operations {
21160
21185
  * An example conjunction is:
21161
21186
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21162
21187
  *
21163
- * 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.
21188
+ * 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.
21164
21189
  *
21165
21190
  * 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.
21166
21191
  *
@@ -21353,6 +21378,8 @@ interface operations {
21353
21378
  } | null;
21354
21379
  /** Format: uuid */
21355
21380
  ChannelID?: string | null;
21381
+ /** @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 */
21382
+ Clearance?: (Record<string, never> | null)[] | null;
21356
21383
  /** @description An optional set of gates that, if any is present, will block deletion */
21357
21384
  DeleteGates?: {
21358
21385
  [key: string]: boolean | null;
@@ -21360,6 +21387,10 @@ interface operations {
21360
21387
  /** @description Friendly name for the entity. */
21361
21388
  DisplayName?: string | null;
21362
21389
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21390
+ /** @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. */
21391
+ Guards?: {
21392
+ [key: string]: string | null;
21393
+ } | null;
21363
21394
  /** @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. */
21364
21395
  HiddenReason?: string | null;
21365
21396
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21511,7 +21542,7 @@ interface operations {
21511
21542
  * An example conjunction is:
21512
21543
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21513
21544
  *
21514
- * 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.
21545
+ * 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.
21515
21546
  *
21516
21547
  * 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.
21517
21548
  *
@@ -21715,7 +21746,7 @@ interface operations {
21715
21746
  * An example conjunction is:
21716
21747
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21717
21748
  *
21718
- * 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.
21749
+ * 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.
21719
21750
  *
21720
21751
  * 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.
21721
21752
  *
@@ -21798,6 +21829,8 @@ interface operations {
21798
21829
  } | null;
21799
21830
  /** Format: uuid */
21800
21831
  ChannelID?: string | null;
21832
+ /** @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 */
21833
+ Clearance?: (Record<string, never> | null)[] | null;
21801
21834
  /** @description An optional set of gates that, if any is present, will block deletion */
21802
21835
  DeleteGates?: {
21803
21836
  [key: string]: boolean | null;
@@ -21805,6 +21838,10 @@ interface operations {
21805
21838
  /** @description Friendly name for the entity. */
21806
21839
  DisplayName?: string | null;
21807
21840
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21841
+ /** @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. */
21842
+ Guards?: {
21843
+ [key: string]: string | null;
21844
+ } | null;
21808
21845
  /** @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. */
21809
21846
  HiddenReason?: string | null;
21810
21847
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21956,7 +21993,7 @@ interface operations {
21956
21993
  * An example conjunction is:
21957
21994
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21958
21995
  *
21959
- * 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.
21996
+ * 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.
21960
21997
  *
21961
21998
  * The whole string must be query-encoded.
21962
21999
  */
@@ -36014,6 +36051,8 @@ interface operations {
36014
36051
  clearance?: string;
36015
36052
  /** @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). */
36016
36053
  guards?: string;
36054
+ /** @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. */
36055
+ inherited_guards?: string;
36017
36056
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
36018
36057
  change_set_id?: string;
36019
36058
  /** @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. */
@@ -36270,7 +36309,7 @@ interface operations {
36270
36309
  * An example conjunction is:
36271
36310
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
36272
36311
  *
36273
- * 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.
36312
+ * 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.
36274
36313
  *
36275
36314
  * 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.
36276
36315
  *
@@ -36873,6 +36912,8 @@ interface operations {
36873
36912
  } | null;
36874
36913
  /** Format: uuid */
36875
36914
  ChannelID?: string | null;
36915
+ /** @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 */
36916
+ Clearance?: (Record<string, never> | null)[] | null;
36876
36917
  /** @description An optional set of gates that, if any is present, will block deletion */
36877
36918
  DeleteGates?: {
36878
36919
  [key: string]: boolean | null;
@@ -36880,6 +36921,10 @@ interface operations {
36880
36921
  /** @description Friendly name for the entity. */
36881
36922
  DisplayName?: string | null;
36882
36923
  FunctionInvocations?: (Record<string, never> | null)[] | null;
36924
+ /** @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. */
36925
+ Guards?: {
36926
+ [key: string]: string | null;
36927
+ } | null;
36883
36928
  /** @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. */
36884
36929
  HiddenReason?: string | null;
36885
36930
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -42120,6 +42165,8 @@ interface operations {
42120
42165
  clearance?: string;
42121
42166
  /** @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). */
42122
42167
  guards?: string;
42168
+ /** @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. */
42169
+ inherited_guards?: string;
42123
42170
  /** @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. */
42124
42171
  squash?: boolean;
42125
42172
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42173,7 +42220,7 @@ interface operations {
42173
42220
  * An example conjunction is:
42174
42221
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42175
42222
  *
42176
- * 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.
42223
+ * 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.
42177
42224
  *
42178
42225
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42179
42226
  *
@@ -42435,6 +42482,8 @@ interface operations {
42435
42482
  clearance?: string;
42436
42483
  /** @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). */
42437
42484
  guards?: string;
42485
+ /** @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. */
42486
+ inherited_guards?: string;
42438
42487
  /** @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. */
42439
42488
  squash?: boolean;
42440
42489
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42488,7 +42537,7 @@ interface operations {
42488
42537
  * An example conjunction is:
42489
42538
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42490
42539
  *
42491
- * 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.
42540
+ * 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.
42492
42541
  *
42493
42542
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42494
42543
  *
@@ -42952,6 +43001,8 @@ interface operations {
42952
43001
  clearance?: string;
42953
43002
  /** @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). */
42954
43003
  guards?: string;
43004
+ /** @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. */
43005
+ inherited_guards?: string;
42955
43006
  /** @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. */
42956
43007
  merge_base?: string;
42957
43008
  /** @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. */
@@ -43279,9 +43330,9 @@ interface operations {
43279
43330
  * An example conjunction is:
43280
43331
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
43281
43332
  *
43282
- * 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.
43333
+ * 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.
43283
43334
  *
43284
- * 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.
43335
+ * 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.
43285
43336
  *
43286
43337
  * The whole string must be query-encoded.
43287
43338
  */
@@ -51117,6 +51168,8 @@ interface operations {
51117
51168
  clearance?: string;
51118
51169
  /** @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). */
51119
51170
  guards?: string;
51171
+ /** @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. */
51172
+ inherited_guards?: string;
51120
51173
  /** @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. */
51121
51174
  squash?: boolean;
51122
51175
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -51170,7 +51223,7 @@ interface operations {
51170
51223
  * An example conjunction is:
51171
51224
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51172
51225
  *
51173
- * 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.
51226
+ * 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.
51174
51227
  *
51175
51228
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
51176
51229
  *
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;
@@ -4094,6 +4094,8 @@ interface components {
4094
4094
  Guards?: {
4095
4095
  [key: string]: string;
4096
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[];
4097
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. */
4098
4100
  Needed?: components["schemas"]["BlameNeededPath"][];
4099
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. */
@@ -6067,12 +6069,8 @@ interface components {
6067
6069
  FunctionInvocation: {
6068
6070
  /** @description Function arguments */
6069
6071
  Arguments?: components["schemas"]["FunctionArgument"][] | null;
6070
- /** @description Classes of guarded reason this invocation is cleared for; combined by union with the clearance of whatever drove the execution */
6071
- Clearance?: components["schemas"]["Clearance"];
6072
6072
  /** @description Function name */
6073
6073
  FunctionName?: string;
6074
- /** @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 */
6075
- Guards?: components["schemas"]["GuardStamp"];
6076
6074
  /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
6077
6075
  Params?: {
6078
6076
  [key: string]: unknown;
@@ -6279,12 +6277,18 @@ interface components {
6279
6277
  GuardDelta: {
6280
6278
  /** @description The path whose guards changed; empty for the resource as a whole */
6281
6279
  Path?: string;
6282
- /** @description Guard keys removed */
6280
+ /** @description Inherited guard keys removed */
6283
6281
  Remove?: string[];
6284
- /** @description Guard keys added or changed, with their new values */
6282
+ /** @description Guard keys removed that stay with the Unit, not inherited; a restore taking out guards the restored Revision did not have */
6283
+ RemoveLocal?: string[];
6284
+ /** @description Inherited guard keys added or changed, with their new values */
6285
6285
  Set?: {
6286
6286
  [key: string]: string;
6287
6287
  };
6288
+ /** @description Guard keys added or changed as guards that stay with the Unit, with their new values; a restore putting back the Unit's own guards */
6289
+ SetLocal?: {
6290
+ [key: string]: string;
6291
+ };
6288
6292
  };
6289
6293
  GuardStamp: {
6290
6294
  [key: string]: string;
@@ -6306,6 +6310,8 @@ interface components {
6306
6310
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6307
6311
  */
6308
6312
  ChannelID?: string;
6313
+ /** @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 */
6314
+ Clearance?: components["schemas"]["Clearance"];
6309
6315
  /**
6310
6316
  * Format: date-time
6311
6317
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6321,6 +6327,8 @@ interface components {
6321
6327
  /** @description The type of entity. */
6322
6328
  readonly EntityType?: string;
6323
6329
  FunctionInvocations: components["schemas"]["FunctionInvocationList"];
6330
+ /** @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. */
6331
+ Guards?: components["schemas"]["GuardStamp"];
6324
6332
  /** @description SHA256 hash of the functions and their arguments encoded as hexadecimal. */
6325
6333
  readonly Hash?: string;
6326
6334
  /** @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. */
@@ -6603,6 +6611,8 @@ interface components {
6603
6611
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6604
6612
  */
6605
6613
  ChannelID?: string;
6614
+ /** @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; on an apply of withheld conflicts, the request's */
6615
+ Clearance?: components["schemas"]["Clearance"];
6606
6616
  /**
6607
6617
  * Format: date-time
6608
6618
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -6613,8 +6623,12 @@ interface components {
6613
6623
  readonly EntityType?: string;
6614
6624
  /** @description The function invoked if the change was made by a function. */
6615
6625
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
6626
+ /** @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 */
6627
+ Guards?: components["schemas"]["GuardStamp"];
6616
6628
  /** @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. */
6617
6629
  HiddenReason?: string;
6630
+ /** @description The guards the change recorded as inherited on the paths it wrote, which clones receive and merges carry to the units downstream */
6631
+ InheritedGuards?: components["schemas"]["GuardStamp"];
6618
6632
  /**
6619
6633
  * Format: uuid
6620
6634
  * @description InvocationID is the identifier of the function invoked, if there is a corresponding Invocation.
@@ -7450,12 +7464,18 @@ interface components {
7450
7464
  };
7451
7465
  /** @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. */
7452
7466
  Resource?: components["schemas"]["ResourceInfo"];
7453
- /** @description Guard key/value pairs to add or overwrite, by path. 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 */
7467
+ /** @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 */
7454
7468
  Set?: {
7455
7469
  [key: string]: {
7456
7470
  [key: string]: string;
7457
7471
  };
7458
7472
  };
7473
+ /** @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 */
7474
+ SetInherited?: {
7475
+ [key: string]: {
7476
+ [key: string]: string;
7477
+ };
7478
+ };
7459
7479
  };
7460
7480
  ResourceInfo: {
7461
7481
  /** @description Category of configuration element represented in the configuration data; Kubernetes resources are of category Resource, and application configuration files are of category AppConfig */
@@ -8727,6 +8747,8 @@ interface components {
8727
8747
  UnitConflictsRequest: {
8728
8748
  /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */
8729
8749
  Action?: string;
8750
+ /** @description With Apply, the classes of guarded reason the applied changes are cleared for, as a list of {Key, Operator, Values} requirements. A withheld value is written only where the guards at its path admit this clearance, and a withheld guard change only where the guards already at its path do; the request is refused otherwise. Not taken by Dismiss or Undismiss, which write no configuration data and no guards. */
8751
+ Clearance?: components["schemas"]["Clearance"];
8730
8752
  /** @description Report what the request would do without writing anything. The response carries the Unit as it would be. */
8731
8753
  DryRun?: boolean;
8732
8754
  /** @description With Dismiss, also dismiss the conflicts each selector matches whenever a later merge reports them. Each selector names one resource, by ResourceName or ResourceNameWithoutScope, and a Reason, and Guards for a guard-caused reason; an empty Path covers every path of the resource. */
@@ -8756,6 +8778,7 @@ interface components {
8756
8778
  ChangeSetClose?: components["schemas"]["ChangeSetCloseResult"];
8757
8779
  /** @description The configuration the operation produced; returned when include names ConfigData. */
8758
8780
  ConfigData?: string;
8781
+ /** @description What this write could not apply: for an upgrade, merge or resolve, each change it withheld, and for any write, each value whose guards its clearance did not cover (Guarded) and each guard change it was not cleared to make (GuardWithheld). For a dry run, what it would withhold. Unit.Conflicts lists every conflict outstanding on the Unit, including those earlier operations left. */
8759
8782
  Conflicts?: components["schemas"]["MutationConflictList"];
8760
8783
  /** @description What the operation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */
8761
8784
  Diff?: components["schemas"]["ConfigDiff"];
@@ -8967,7 +8990,7 @@ interface components {
8967
8990
  UnitID?: string;
8968
8991
  };
8969
8992
  UnitPathReport: {
8970
- /** @description The path's own annotations other than guards and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8993
+ /** @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. */
8971
8994
  Annotations?: {
8972
8995
  [key: string]: {
8973
8996
  [key: string]: string;
@@ -20177,6 +20200,8 @@ interface operations {
20177
20200
  clearance?: string;
20178
20201
  /** @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). */
20179
20202
  guards?: string;
20203
+ /** @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. */
20204
+ inherited_guards?: string;
20180
20205
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
20181
20206
  change_set_id?: string;
20182
20207
  /** @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. */
@@ -20936,7 +20961,7 @@ interface operations {
20936
20961
  * An example conjunction is:
20937
20962
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20938
20963
  *
20939
- * 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.
20964
+ * 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.
20940
20965
  *
20941
20966
  * 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.
20942
20967
  *
@@ -21160,7 +21185,7 @@ interface operations {
21160
21185
  * An example conjunction is:
21161
21186
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21162
21187
  *
21163
- * 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.
21188
+ * 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.
21164
21189
  *
21165
21190
  * 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.
21166
21191
  *
@@ -21353,6 +21378,8 @@ interface operations {
21353
21378
  } | null;
21354
21379
  /** Format: uuid */
21355
21380
  ChannelID?: string | null;
21381
+ /** @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 */
21382
+ Clearance?: (Record<string, never> | null)[] | null;
21356
21383
  /** @description An optional set of gates that, if any is present, will block deletion */
21357
21384
  DeleteGates?: {
21358
21385
  [key: string]: boolean | null;
@@ -21360,6 +21387,10 @@ interface operations {
21360
21387
  /** @description Friendly name for the entity. */
21361
21388
  DisplayName?: string | null;
21362
21389
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21390
+ /** @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. */
21391
+ Guards?: {
21392
+ [key: string]: string | null;
21393
+ } | null;
21363
21394
  /** @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. */
21364
21395
  HiddenReason?: string | null;
21365
21396
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21511,7 +21542,7 @@ interface operations {
21511
21542
  * An example conjunction is:
21512
21543
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21513
21544
  *
21514
- * 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.
21545
+ * 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.
21515
21546
  *
21516
21547
  * 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.
21517
21548
  *
@@ -21715,7 +21746,7 @@ interface operations {
21715
21746
  * An example conjunction is:
21716
21747
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21717
21748
  *
21718
- * 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.
21749
+ * 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.
21719
21750
  *
21720
21751
  * 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.
21721
21752
  *
@@ -21798,6 +21829,8 @@ interface operations {
21798
21829
  } | null;
21799
21830
  /** Format: uuid */
21800
21831
  ChannelID?: string | null;
21832
+ /** @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 */
21833
+ Clearance?: (Record<string, never> | null)[] | null;
21801
21834
  /** @description An optional set of gates that, if any is present, will block deletion */
21802
21835
  DeleteGates?: {
21803
21836
  [key: string]: boolean | null;
@@ -21805,6 +21838,10 @@ interface operations {
21805
21838
  /** @description Friendly name for the entity. */
21806
21839
  DisplayName?: string | null;
21807
21840
  FunctionInvocations?: (Record<string, never> | null)[] | null;
21841
+ /** @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. */
21842
+ Guards?: {
21843
+ [key: string]: string | null;
21844
+ } | null;
21808
21845
  /** @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. */
21809
21846
  HiddenReason?: string | null;
21810
21847
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -21956,7 +21993,7 @@ interface operations {
21956
21993
  * An example conjunction is:
21957
21994
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21958
21995
  *
21959
- * 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.
21996
+ * 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.
21960
21997
  *
21961
21998
  * The whole string must be query-encoded.
21962
21999
  */
@@ -36014,6 +36051,8 @@ interface operations {
36014
36051
  clearance?: string;
36015
36052
  /** @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). */
36016
36053
  guards?: string;
36054
+ /** @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. */
36055
+ inherited_guards?: string;
36017
36056
  /** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
36018
36057
  change_set_id?: string;
36019
36058
  /** @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. */
@@ -36270,7 +36309,7 @@ interface operations {
36270
36309
  * An example conjunction is:
36271
36310
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
36272
36311
  *
36273
- * 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.
36312
+ * 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.
36274
36313
  *
36275
36314
  * 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.
36276
36315
  *
@@ -36873,6 +36912,8 @@ interface operations {
36873
36912
  } | null;
36874
36913
  /** Format: uuid */
36875
36914
  ChannelID?: string | null;
36915
+ /** @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 */
36916
+ Clearance?: (Record<string, never> | null)[] | null;
36876
36917
  /** @description An optional set of gates that, if any is present, will block deletion */
36877
36918
  DeleteGates?: {
36878
36919
  [key: string]: boolean | null;
@@ -36880,6 +36921,10 @@ interface operations {
36880
36921
  /** @description Friendly name for the entity. */
36881
36922
  DisplayName?: string | null;
36882
36923
  FunctionInvocations?: (Record<string, never> | null)[] | null;
36924
+ /** @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. */
36925
+ Guards?: {
36926
+ [key: string]: string | null;
36927
+ } | null;
36883
36928
  /** @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. */
36884
36929
  HiddenReason?: string | null;
36885
36930
  /** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
@@ -42120,6 +42165,8 @@ interface operations {
42120
42165
  clearance?: string;
42121
42166
  /** @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). */
42122
42167
  guards?: string;
42168
+ /** @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. */
42169
+ inherited_guards?: string;
42123
42170
  /** @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. */
42124
42171
  squash?: boolean;
42125
42172
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42173,7 +42220,7 @@ interface operations {
42173
42220
  * An example conjunction is:
42174
42221
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42175
42222
  *
42176
- * 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.
42223
+ * 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.
42177
42224
  *
42178
42225
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42179
42226
  *
@@ -42435,6 +42482,8 @@ interface operations {
42435
42482
  clearance?: string;
42436
42483
  /** @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). */
42437
42484
  guards?: string;
42485
+ /** @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. */
42486
+ inherited_guards?: string;
42438
42487
  /** @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. */
42439
42488
  squash?: boolean;
42440
42489
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -42488,7 +42537,7 @@ interface operations {
42488
42537
  * An example conjunction is:
42489
42538
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
42490
42539
  *
42491
- * 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.
42540
+ * 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.
42492
42541
  *
42493
42542
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
42494
42543
  *
@@ -42952,6 +43001,8 @@ interface operations {
42952
43001
  clearance?: string;
42953
43002
  /** @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). */
42954
43003
  guards?: string;
43004
+ /** @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. */
43005
+ inherited_guards?: string;
42955
43006
  /** @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. */
42956
43007
  merge_base?: string;
42957
43008
  /** @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. */
@@ -43279,9 +43330,9 @@ interface operations {
43279
43330
  * An example conjunction is:
43280
43331
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
43281
43332
  *
43282
- * 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.
43333
+ * 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.
43283
43334
  *
43284
- * 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.
43335
+ * 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.
43285
43336
  *
43286
43337
  * The whole string must be query-encoded.
43287
43338
  */
@@ -51117,6 +51168,8 @@ interface operations {
51117
51168
  clearance?: string;
51118
51169
  /** @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). */
51119
51170
  guards?: string;
51171
+ /** @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. */
51172
+ inherited_guards?: string;
51120
51173
  /** @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. */
51121
51174
  squash?: boolean;
51122
51175
  /** @description Upgrade the unit to the latest version of its upstream unit */
@@ -51170,7 +51223,7 @@ interface operations {
51170
51223
  * An example conjunction is:
51171
51224
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51172
51225
  *
51173
- * 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.
51226
+ * 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.
51174
51227
  *
51175
51228
  * Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
51176
51229
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.10.9",
3
+ "version": "0.10.11",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {