@confighub/api 0.4.5 → 0.4.7
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 +165 -54
- package/dist/index.d.ts +165 -54
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1604,7 +1604,8 @@ interface paths {
|
|
|
1604
1604
|
};
|
|
1605
1605
|
/**
|
|
1606
1606
|
* Get Unit details with expanded relationships
|
|
1607
|
-
* @
|
|
1607
|
+
* @deprecated
|
|
1608
|
+
* @description Get Unit details with expanded relationships. Deprecated: use GET /space/{space_id}/unit/{unit_id} with the include query parameter, which returns the same expanded entities and is how every other entity is read.
|
|
1608
1609
|
*/
|
|
1609
1610
|
get: operations["GetUnitExtended"];
|
|
1610
1611
|
put?: never;
|
|
@@ -2851,8 +2852,14 @@ interface components {
|
|
|
2851
2852
|
EndTagID?: string;
|
|
2852
2853
|
/** @description The type of entity. */
|
|
2853
2854
|
readonly EntityType?: string;
|
|
2854
|
-
/** @description InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into, supplied by the client rather than derived from a query. Empty names a change without saying where it is headed, in which case the Spaces the ChangeOrder's Links reach when its scope is derived are recorded instead. ResolvedSpaceIDs and ReleasedSpaceIDs are measured against it. Editing it re-derives what the ChangeOrder covers. */
|
|
2855
|
+
/** @description InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into, supplied by the client rather than derived from a query. Empty names a change without saying where it is headed, in which case the Spaces the ChangeOrder's Links reach when its scope is derived are recorded instead; an Invoke ChangeOrder has no Links to fall back on and requires a non-empty list. ResolvedSpaceIDs and ReleasedSpaceIDs are measured against it. Editing it re-derives what the ChangeOrder covers. */
|
|
2855
2856
|
InScopeSpaceIDs?: components["schemas"]["UUID"][];
|
|
2857
|
+
/**
|
|
2858
|
+
* Format: uuid
|
|
2859
|
+
* @description InvocationID is the Invocation an Invoke ChangeOrder runs. Required for that UpdateType and refused for the others. Naming it here is what makes every Space in scope receive the same update: the invoke API takes what it runs from the ChangeOrder. Immutable.
|
|
2860
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2861
|
+
*/
|
|
2862
|
+
InvocationID?: string;
|
|
2856
2863
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
2857
2864
|
Labels?: {
|
|
2858
2865
|
[key: string]: string;
|
|
@@ -2863,11 +2870,15 @@ interface components {
|
|
|
2863
2870
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2864
2871
|
*/
|
|
2865
2872
|
OrganizationID?: string;
|
|
2873
|
+
/** @description Parameters supplies values for the declared Parameters of a parameterized Invocation, keyed by parameter name, validated against the declaration the way ParameterizedInvocations are on a direct call. One set for the whole ChangeOrder, not one per Space. Immutable. */
|
|
2874
|
+
Parameters?: {
|
|
2875
|
+
[key: string]: unknown;
|
|
2876
|
+
};
|
|
2866
2877
|
/** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
|
|
2867
2878
|
readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
2868
2879
|
/** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. Derived when the ChangeOrder is read. */
|
|
2869
2880
|
readonly ReleasedSpaceIDs?: components["schemas"]["UUID"][];
|
|
2870
|
-
/** @description ResolvedSpaceIDs is where the ChangeOrder has been fully propagated to: the Spaces in scope whose Links of its UpdateType have all merged it, plus the Space it resides in. Derived when the ChangeOrder is read. */
|
|
2881
|
+
/** @description ResolvedSpaceIDs is where the ChangeOrder has been fully propagated to: the Spaces in scope whose Links of its UpdateType have all merged it, plus the Space it resides in. For an Invoke ChangeOrder it is the Spaces in scope where every Unit WhereUnit selects carries the end Tag, and its own Space counts only if it is one of them. Derived when the ChangeOrder is read. */
|
|
2871
2882
|
readonly ResolvedSpaceIDs?: components["schemas"]["UUID"][];
|
|
2872
2883
|
/**
|
|
2873
2884
|
* Format: uuid
|
|
@@ -2899,7 +2910,13 @@ interface components {
|
|
|
2899
2910
|
readonly StartTagID?: string;
|
|
2900
2911
|
/** @description State is how far the ChangeOrder has got: New until a Space other than its own has taken it, InProgress while some have and some have not, Resolved once every Space in scope has, Released once every Space in scope has released what it took, Aborted whenever AbortedReason is set, Restored once every Space that had taken it has been restored to the Revisions before it, and RestoreReleased once every Space that had released it has released the restored Revisions. Derived when the ChangeOrder is read. */
|
|
2901
2912
|
readonly State?: string;
|
|
2902
|
-
/**
|
|
2913
|
+
/**
|
|
2914
|
+
* Format: uuid
|
|
2915
|
+
* @description UnitFilterID references a Filter (with From=Unit) narrowing the same selection as WhereUnit, conjoined with it. Refused on the other UpdateTypes. Immutable.
|
|
2916
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
2917
|
+
*/
|
|
2918
|
+
UnitFilterID?: string;
|
|
2919
|
+
/** @description UpdateType is how this ChangeOrder propagates. UpgradeUnit, the clone lineage, is the default, and MergeUnits is the other Link type it follows; both take the change from Revisions the source Unit already has. Invoke is the third: the change is one Invocation run in each Space in scope, and the ChangeOrder is created before any of it has happened. */
|
|
2903
2920
|
UpdateType?: string;
|
|
2904
2921
|
/**
|
|
2905
2922
|
* Format: date-time
|
|
@@ -2912,6 +2929,8 @@ interface components {
|
|
|
2912
2929
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
2913
2930
|
*/
|
|
2914
2931
|
Version?: number;
|
|
2932
|
+
/** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
|
|
2933
|
+
WhereUnit?: string;
|
|
2915
2934
|
};
|
|
2916
2935
|
ChangeOrderCreateOrUpdateResponse: {
|
|
2917
2936
|
ChangeOrder?: components["schemas"]["ChangeOrder"];
|
|
@@ -3069,10 +3088,12 @@ interface components {
|
|
|
3069
3088
|
ChangeOrder?: components["schemas"]["ChangeOrder"];
|
|
3070
3089
|
EndTag?: components["schemas"]["Tag"];
|
|
3071
3090
|
Error?: components["schemas"]["ResponseError"];
|
|
3091
|
+
Invocation?: components["schemas"]["Invocation"];
|
|
3072
3092
|
Organization?: components["schemas"]["Organization"];
|
|
3073
3093
|
RestoreTag?: components["schemas"]["Tag"];
|
|
3074
3094
|
Space?: components["schemas"]["Space"];
|
|
3075
3095
|
StartTag?: components["schemas"]["Tag"];
|
|
3096
|
+
UnitFilter?: components["schemas"]["Filter"];
|
|
3076
3097
|
};
|
|
3077
3098
|
ExtendedChangeSet: {
|
|
3078
3099
|
ChangeSet?: components["schemas"]["ChangeSet"];
|
|
@@ -3382,7 +3403,13 @@ interface components {
|
|
|
3382
3403
|
ToolchainType?: string;
|
|
3383
3404
|
/** @description Triggers is a list of Trigger IDs to execute. The triggers must be within the same Organization. Triggers will be executed after the FunctionInvocations list. Functions are grouped by executor (built-in vs bridge worker) and executed in phases: general mutating functions first, then final mutating functions (like ensure-context), then validating functions. Functions that don't match the unit's toolchain type are ignored. */
|
|
3384
3405
|
Triggers?: components["schemas"]["UUID"][];
|
|
3406
|
+
/**
|
|
3407
|
+
* @deprecated
|
|
3408
|
+
* @description Deprecated: use UpdateValidationResults, which this means the same thing as. Setting either has the same effect.
|
|
3409
|
+
*/
|
|
3385
3410
|
UpdateApplyGates?: boolean;
|
|
3411
|
+
/** @description UpdateValidationResults indicates that the results of Trigger execution should be used to update ValidationErrors and ValidationWarnings on the affected Units. Requires Triggers to be specified. */
|
|
3412
|
+
UpdateValidationResults?: boolean;
|
|
3386
3413
|
/** @description WhereResource restricts which resources functions operate on using ConfigHub metadata path expressions (ConfigHub.ResourceName, ConfigHub.ResourceNameWithoutScope, ConfigHub.ResourceType, ConfigHub.ResourceCategory). */
|
|
3387
3414
|
WhereResource?: string;
|
|
3388
3415
|
};
|
|
@@ -4510,12 +4537,18 @@ interface components {
|
|
|
4510
4537
|
};
|
|
4511
4538
|
/** @description Revision is a historial view of a Config Unit. */
|
|
4512
4539
|
Revision: {
|
|
4513
|
-
/**
|
|
4514
|
-
|
|
4540
|
+
/**
|
|
4541
|
+
* @deprecated
|
|
4542
|
+
* @description Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set.
|
|
4543
|
+
*/
|
|
4544
|
+
readonly ApplyGates?: {
|
|
4515
4545
|
[key: string]: boolean;
|
|
4516
4546
|
};
|
|
4517
|
-
/**
|
|
4518
|
-
|
|
4547
|
+
/**
|
|
4548
|
+
* @deprecated
|
|
4549
|
+
* @description Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set.
|
|
4550
|
+
*/
|
|
4551
|
+
readonly ApplyWarnings?: {
|
|
4519
4552
|
[key: string]: boolean;
|
|
4520
4553
|
};
|
|
4521
4554
|
/** @description the users that have approved the latest version of the config data for the Unit. */
|
|
@@ -4552,6 +4585,8 @@ interface components {
|
|
|
4552
4585
|
Description?: string;
|
|
4553
4586
|
/** @description The type of entity. */
|
|
4554
4587
|
readonly EntityType?: string;
|
|
4588
|
+
/** @description Attribute paths this Revision's configuration needs from upstream Units via NeedsProvides Links. */
|
|
4589
|
+
NeededPaths?: components["schemas"]["AttributeValue"][];
|
|
4555
4590
|
/**
|
|
4556
4591
|
* Format: uuid
|
|
4557
4592
|
* @description Unique identifier for an Organization.
|
|
@@ -4559,6 +4594,8 @@ interface components {
|
|
|
4559
4594
|
*/
|
|
4560
4595
|
OrganizationID?: string;
|
|
4561
4596
|
PathAnnotations?: components["schemas"]["PathAnnotationList"];
|
|
4597
|
+
/** @description Attribute paths this Revision's configuration provides to downstream Units via NeedsProvides Links. */
|
|
4598
|
+
ProvidedPaths?: components["schemas"]["AttributeInfo"][];
|
|
4562
4599
|
/** @description A set (map) of ReleaseIDs of any Releases that have bundled this Revision. The string values have no particular meaning for now. */
|
|
4563
4600
|
Releases?: {
|
|
4564
4601
|
[key: string]: string;
|
|
@@ -4610,6 +4647,26 @@ interface components {
|
|
|
4610
4647
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4611
4648
|
*/
|
|
4612
4649
|
UserID?: string;
|
|
4650
|
+
/** @description A map of "<space slug>/<trigger slug>/<function name>" to true of Triggers invoking validating functions that did not pass on the configuration data at this Revision. These block Release operations. */
|
|
4651
|
+
ValidationErrors?: {
|
|
4652
|
+
[key: string]: boolean;
|
|
4653
|
+
};
|
|
4654
|
+
/** @description A map of "<space slug>/<trigger slug>/<function name>" to true of Triggers invoking validating functions that executed and passed on the configuration data at this Revision. Disjoint from ValidationErrors and ValidationWarnings. */
|
|
4655
|
+
ValidationPassed?: {
|
|
4656
|
+
[key: string]: boolean;
|
|
4657
|
+
};
|
|
4658
|
+
/** @description A map from gate/warning name to the validation results that caused it, for the configuration data at this Revision. */
|
|
4659
|
+
ValidationResults?: {
|
|
4660
|
+
[key: string]: components["schemas"]["ValidationResultList"];
|
|
4661
|
+
};
|
|
4662
|
+
/** @description A map of "<space slug>/<trigger slug>/<function name>" to true of Triggers with Warn=true invoking validating functions that did not pass on the configuration data at this Revision. These do not block Release operations. */
|
|
4663
|
+
ValidationWarnings?: {
|
|
4664
|
+
[key: string]: boolean;
|
|
4665
|
+
};
|
|
4666
|
+
/** @description Map from "<trigger slug>/<attribute name>" to the first output Value with that attribute name of the function invocation specified by the Trigger, as of this Revision. */
|
|
4667
|
+
Values?: {
|
|
4668
|
+
[key: string]: string;
|
|
4669
|
+
};
|
|
4613
4670
|
/**
|
|
4614
4671
|
* Format: int64
|
|
4615
4672
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
@@ -5126,7 +5183,7 @@ interface components {
|
|
|
5126
5183
|
*
|
|
5127
5184
|
* Triggers can be either validating (checking configuration validity without modifying it)
|
|
5128
5185
|
* or mutating (making changes to the configuration). They can be disabled, and validating
|
|
5129
|
-
* triggers can be set to Warn mode to produce non-blocking
|
|
5186
|
+
* triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors.
|
|
5130
5187
|
*/
|
|
5131
5188
|
Trigger: {
|
|
5132
5189
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -5253,7 +5310,7 @@ interface components {
|
|
|
5253
5310
|
*/
|
|
5254
5311
|
Version?: number;
|
|
5255
5312
|
/**
|
|
5256
|
-
* @description Warn indicates whether this trigger produces
|
|
5313
|
+
* @description Warn indicates whether this trigger produces ValidationWarnings instead of ValidationErrors when its validating function fails. ValidationWarnings are non-blocking.
|
|
5257
5314
|
* @example false
|
|
5258
5315
|
*/
|
|
5259
5316
|
Warn?: boolean;
|
|
@@ -5290,11 +5347,17 @@ interface components {
|
|
|
5290
5347
|
Annotations?: {
|
|
5291
5348
|
[key: string]: string;
|
|
5292
5349
|
};
|
|
5293
|
-
/**
|
|
5350
|
+
/**
|
|
5351
|
+
* @deprecated
|
|
5352
|
+
* @description Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set.
|
|
5353
|
+
*/
|
|
5294
5354
|
readonly ApplyGates?: {
|
|
5295
5355
|
[key: string]: boolean;
|
|
5296
5356
|
};
|
|
5297
|
-
/**
|
|
5357
|
+
/**
|
|
5358
|
+
* @deprecated
|
|
5359
|
+
* @description Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set.
|
|
5360
|
+
*/
|
|
5298
5361
|
readonly ApplyWarnings?: {
|
|
5299
5362
|
[key: string]: boolean;
|
|
5300
5363
|
};
|
|
@@ -5350,6 +5413,12 @@ interface components {
|
|
|
5350
5413
|
* @description Sequence number the head Mutation.
|
|
5351
5414
|
*/
|
|
5352
5415
|
readonly HeadMutationNum?: number;
|
|
5416
|
+
/**
|
|
5417
|
+
* Format: uuid
|
|
5418
|
+
* @description Unique identifier of the head Revision -- the same Revision HeadRevisionNum numbers. Use include=HeadRevisionNum to expand it.
|
|
5419
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5420
|
+
*/
|
|
5421
|
+
readonly HeadRevisionID?: string;
|
|
5353
5422
|
/**
|
|
5354
5423
|
* Format: int64
|
|
5355
5424
|
* @description Sequence number the head Revision.
|
|
@@ -5440,10 +5509,18 @@ interface components {
|
|
|
5440
5509
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5441
5510
|
*/
|
|
5442
5511
|
readonly UpstreamUnitID?: string;
|
|
5512
|
+
/** @description A map of "<space slug>/<trigger slug>/<function name>" to true of Triggers invoking validating functions that did not pass on the latest configuration data. These block Release operations. */
|
|
5513
|
+
readonly ValidationErrors?: {
|
|
5514
|
+
[key: string]: boolean;
|
|
5515
|
+
};
|
|
5443
5516
|
/** @description A map from gate/warning name to the list of validation results that caused the gate or warning. */
|
|
5444
5517
|
readonly ValidationResults?: {
|
|
5445
5518
|
[key: string]: components["schemas"]["ValidationResultList"];
|
|
5446
5519
|
};
|
|
5520
|
+
/** @description A map of "<space slug>/<trigger slug>/<function name>" to true of Triggers with Warn=true invoking validating functions that did not pass on the latest configuration data. These do not block Release operations. */
|
|
5521
|
+
readonly ValidationWarnings?: {
|
|
5522
|
+
[key: string]: boolean;
|
|
5523
|
+
};
|
|
5447
5524
|
/** @description Map from "<trigger slug>/<attribute name>" to the first output Value with that attribute name of the function invocation specified by the Trigger. */
|
|
5448
5525
|
readonly Values?: {
|
|
5449
5526
|
[key: string]: string;
|
|
@@ -8255,7 +8332,7 @@ interface operations {
|
|
|
8255
8332
|
* An example conjunction is:
|
|
8256
8333
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8257
8334
|
*
|
|
8258
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
|
|
8335
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
8259
8336
|
*
|
|
8260
8337
|
* The whole string must be query-encoded.
|
|
8261
8338
|
*/
|
|
@@ -8297,7 +8374,7 @@ interface operations {
|
|
|
8297
8374
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8298
8375
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8299
8376
|
*
|
|
8300
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
8377
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
8301
8378
|
*
|
|
8302
8379
|
* The whole string must be query-encoded.
|
|
8303
8380
|
*/
|
|
@@ -8423,7 +8500,7 @@ interface operations {
|
|
|
8423
8500
|
* An example conjunction is:
|
|
8424
8501
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8425
8502
|
*
|
|
8426
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
|
|
8503
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
8427
8504
|
*
|
|
8428
8505
|
* The whole string must be query-encoded.
|
|
8429
8506
|
*/
|
|
@@ -8465,7 +8542,7 @@ interface operations {
|
|
|
8465
8542
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8466
8543
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8467
8544
|
*
|
|
8468
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
8545
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
8469
8546
|
*
|
|
8470
8547
|
* The whole string must be query-encoded.
|
|
8471
8548
|
*/
|
|
@@ -8557,15 +8634,21 @@ interface operations {
|
|
|
8557
8634
|
/** Format: uuid */
|
|
8558
8635
|
EndTagID?: string | null;
|
|
8559
8636
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
8637
|
+
/** Format: uuid */
|
|
8638
|
+
InvocationID?: string | null;
|
|
8560
8639
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
8561
8640
|
Labels?: {
|
|
8562
8641
|
[key: string]: string | null;
|
|
8563
8642
|
} | null;
|
|
8643
|
+
Parameters?: Record<string, never> | null;
|
|
8564
8644
|
/** @description Unique URL-safe identifier for the entity. */
|
|
8565
8645
|
Slug?: string | null;
|
|
8646
|
+
/** Format: uuid */
|
|
8647
|
+
UnitFilterID?: string | null;
|
|
8566
8648
|
UpdateType?: string | null;
|
|
8567
8649
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
8568
8650
|
Version?: number | null;
|
|
8651
|
+
WhereUnit?: string | null;
|
|
8569
8652
|
};
|
|
8570
8653
|
};
|
|
8571
8654
|
};
|
|
@@ -8691,7 +8774,7 @@ interface operations {
|
|
|
8691
8774
|
* An example conjunction is:
|
|
8692
8775
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8693
8776
|
*
|
|
8694
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
|
|
8777
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
8695
8778
|
*
|
|
8696
8779
|
* The whole string must be query-encoded.
|
|
8697
8780
|
*/
|
|
@@ -8733,7 +8816,7 @@ interface operations {
|
|
|
8733
8816
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8734
8817
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8735
8818
|
*
|
|
8736
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
8819
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
8737
8820
|
*
|
|
8738
8821
|
* The whole string must be query-encoded.
|
|
8739
8822
|
*/
|
|
@@ -8875,7 +8958,7 @@ interface operations {
|
|
|
8875
8958
|
* An example conjunction is:
|
|
8876
8959
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8877
8960
|
*
|
|
8878
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
|
|
8961
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
8879
8962
|
*
|
|
8880
8963
|
* The whole string must be query-encoded.
|
|
8881
8964
|
*/
|
|
@@ -8917,7 +9000,7 @@ interface operations {
|
|
|
8917
9000
|
* The attribute names are case-sensitive, PascalCase, and
|
|
8918
9001
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
8919
9002
|
*
|
|
8920
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
9003
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
8921
9004
|
*
|
|
8922
9005
|
* The whole string must be query-encoded.
|
|
8923
9006
|
*/
|
|
@@ -8945,15 +9028,21 @@ interface operations {
|
|
|
8945
9028
|
/** Format: uuid */
|
|
8946
9029
|
EndTagID?: string | null;
|
|
8947
9030
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
9031
|
+
/** Format: uuid */
|
|
9032
|
+
InvocationID?: string | null;
|
|
8948
9033
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
8949
9034
|
Labels?: {
|
|
8950
9035
|
[key: string]: string | null;
|
|
8951
9036
|
} | null;
|
|
9037
|
+
Parameters?: Record<string, never> | null;
|
|
8952
9038
|
/** @description Unique URL-safe identifier for the entity. */
|
|
8953
9039
|
Slug?: string | null;
|
|
9040
|
+
/** Format: uuid */
|
|
9041
|
+
UnitFilterID?: string | null;
|
|
8954
9042
|
UpdateType?: string | null;
|
|
8955
9043
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
8956
9044
|
Version?: number | null;
|
|
9045
|
+
WhereUnit?: string | null;
|
|
8957
9046
|
};
|
|
8958
9047
|
};
|
|
8959
9048
|
};
|
|
@@ -10819,6 +10908,8 @@ interface operations {
|
|
|
10819
10908
|
guards?: string;
|
|
10820
10909
|
/** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
10821
10910
|
change_set_id?: string;
|
|
10911
|
+
/** @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. */
|
|
10912
|
+
change_order?: string;
|
|
10822
10913
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
10823
10914
|
subgroup?: string;
|
|
10824
10915
|
/** @description Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers: LastReleasedRevisionNum, HeadRevisionNum. Can be prefixed with 'Before:' (e.g., Before:HeadRevisionNum). May be repeated for multiple sources. */
|
|
@@ -10858,7 +10949,7 @@ interface operations {
|
|
|
10858
10949
|
* An example conjunction is:
|
|
10859
10950
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10860
10951
|
*
|
|
10861
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
10952
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
10862
10953
|
*
|
|
10863
10954
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
10864
10955
|
*
|
|
@@ -10883,8 +10974,10 @@ interface operations {
|
|
|
10883
10974
|
include?: string;
|
|
10884
10975
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
10885
10976
|
resource_type?: string;
|
|
10886
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
10977
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
10887
10978
|
where_data?: string;
|
|
10979
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
10980
|
+
where_data_engine?: string;
|
|
10888
10981
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
10889
10982
|
where_trigger?: string;
|
|
10890
10983
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
@@ -14589,7 +14682,7 @@ interface operations {
|
|
|
14589
14682
|
* An example conjunction is:
|
|
14590
14683
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14591
14684
|
*
|
|
14592
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
14685
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
14593
14686
|
*
|
|
14594
14687
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
14595
14688
|
*
|
|
@@ -14658,7 +14751,7 @@ interface operations {
|
|
|
14658
14751
|
*
|
|
14659
14752
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
14660
14753
|
*
|
|
14661
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
14754
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
14662
14755
|
*
|
|
14663
14756
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
14664
14757
|
*
|
|
@@ -14787,7 +14880,7 @@ interface operations {
|
|
|
14787
14880
|
* An example conjunction is:
|
|
14788
14881
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14789
14882
|
*
|
|
14790
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
14883
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
14791
14884
|
*
|
|
14792
14885
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
14793
14886
|
*
|
|
@@ -14856,7 +14949,7 @@ interface operations {
|
|
|
14856
14949
|
*
|
|
14857
14950
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
14858
14951
|
*
|
|
14859
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
14952
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
14860
14953
|
*
|
|
14861
14954
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
14862
14955
|
*
|
|
@@ -14985,7 +15078,7 @@ interface operations {
|
|
|
14985
15078
|
* An example conjunction is:
|
|
14986
15079
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
14987
15080
|
*
|
|
14988
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
15081
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
14989
15082
|
*
|
|
14990
15083
|
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
14991
15084
|
*
|
|
@@ -15054,7 +15147,7 @@ interface operations {
|
|
|
15054
15147
|
*
|
|
15055
15148
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
15056
15149
|
*
|
|
15057
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
15150
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
15058
15151
|
*
|
|
15059
15152
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
15060
15153
|
*
|
|
@@ -17432,7 +17525,7 @@ interface operations {
|
|
|
17432
17525
|
* An example conjunction is:
|
|
17433
17526
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17434
17527
|
*
|
|
17435
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, Labels, OrganizationID, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UpdateType, UpdatedAt.
|
|
17528
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
17436
17529
|
*
|
|
17437
17530
|
* The whole string must be query-encoded.
|
|
17438
17531
|
*/
|
|
@@ -17474,7 +17567,7 @@ interface operations {
|
|
|
17474
17567
|
* The attribute names are case-sensitive, PascalCase, and
|
|
17475
17568
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
17476
17569
|
*
|
|
17477
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
17570
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
17478
17571
|
*
|
|
17479
17572
|
* The whole string must be query-encoded.
|
|
17480
17573
|
*/
|
|
@@ -17666,7 +17759,7 @@ interface operations {
|
|
|
17666
17759
|
* The attribute names are case-sensitive, PascalCase, and
|
|
17667
17760
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
17668
17761
|
*
|
|
17669
|
-
* Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
17762
|
+
* Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
17670
17763
|
*
|
|
17671
17764
|
* The whole string must be query-encoded.
|
|
17672
17765
|
*/
|
|
@@ -17978,15 +18071,21 @@ interface operations {
|
|
|
17978
18071
|
/** Format: uuid */
|
|
17979
18072
|
EndTagID?: string | null;
|
|
17980
18073
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
18074
|
+
/** Format: uuid */
|
|
18075
|
+
InvocationID?: string | null;
|
|
17981
18076
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
17982
18077
|
Labels?: {
|
|
17983
18078
|
[key: string]: string | null;
|
|
17984
18079
|
} | null;
|
|
18080
|
+
Parameters?: Record<string, never> | null;
|
|
17985
18081
|
/** @description Unique URL-safe identifier for the entity. */
|
|
17986
18082
|
Slug?: string | null;
|
|
18083
|
+
/** Format: uuid */
|
|
18084
|
+
UnitFilterID?: string | null;
|
|
17987
18085
|
UpdateType?: string | null;
|
|
17988
18086
|
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
17989
18087
|
Version?: number | null;
|
|
18088
|
+
WhereUnit?: string | null;
|
|
17990
18089
|
};
|
|
17991
18090
|
};
|
|
17992
18091
|
};
|
|
@@ -19549,6 +19648,8 @@ interface operations {
|
|
|
19549
19648
|
guards?: string;
|
|
19550
19649
|
/** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
19551
19650
|
change_set_id?: string;
|
|
19651
|
+
/** @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. */
|
|
19652
|
+
change_order?: string;
|
|
19552
19653
|
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
19553
19654
|
subgroup?: string;
|
|
19554
19655
|
/** @description Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers: LastReleasedRevisionNum, HeadRevisionNum. Can be prefixed with 'Before:' (e.g., Before:HeadRevisionNum). May be repeated for multiple sources. */
|
|
@@ -19588,7 +19689,7 @@ interface operations {
|
|
|
19588
19689
|
* An example conjunction is:
|
|
19589
19690
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
19590
19691
|
*
|
|
19591
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
19692
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
19592
19693
|
*
|
|
19593
19694
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
19594
19695
|
*
|
|
@@ -19613,8 +19714,10 @@ interface operations {
|
|
|
19613
19714
|
include?: string;
|
|
19614
19715
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
19615
19716
|
resource_type?: string;
|
|
19616
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
19717
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
19617
19718
|
where_data?: string;
|
|
19719
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
19720
|
+
where_data_engine?: string;
|
|
19618
19721
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
19619
19722
|
where_trigger?: string;
|
|
19620
19723
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
@@ -21379,7 +21482,7 @@ interface operations {
|
|
|
21379
21482
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
21380
21483
|
};
|
|
21381
21484
|
};
|
|
21382
|
-
/** @description A Unit to be bundled has outstanding
|
|
21485
|
+
/** @description A Unit to be bundled has outstanding validation errors */
|
|
21383
21486
|
422: {
|
|
21384
21487
|
headers: {
|
|
21385
21488
|
[name: string]: unknown;
|
|
@@ -23538,7 +23641,7 @@ interface operations {
|
|
|
23538
23641
|
*
|
|
23539
23642
|
* Triggers can be either validating (checking configuration validity without modifying it)
|
|
23540
23643
|
* or mutating (making changes to the configuration). They can be disabled, and validating
|
|
23541
|
-
* triggers can be set to Warn mode to produce non-blocking
|
|
23644
|
+
* triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors.
|
|
23542
23645
|
*/
|
|
23543
23646
|
200: {
|
|
23544
23647
|
headers: {
|
|
@@ -23741,7 +23844,7 @@ interface operations {
|
|
|
23741
23844
|
*
|
|
23742
23845
|
* Triggers can be either validating (checking configuration validity without modifying it)
|
|
23743
23846
|
* or mutating (making changes to the configuration). They can be disabled, and validating
|
|
23744
|
-
* triggers can be set to Warn mode to produce non-blocking
|
|
23847
|
+
* triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors.
|
|
23745
23848
|
*/
|
|
23746
23849
|
200: {
|
|
23747
23850
|
headers: {
|
|
@@ -23987,7 +24090,7 @@ interface operations {
|
|
|
23987
24090
|
*
|
|
23988
24091
|
* Triggers can be either validating (checking configuration validity without modifying it)
|
|
23989
24092
|
* or mutating (making changes to the configuration). They can be disabled, and validating
|
|
23990
|
-
* triggers can be set to Warn mode to produce non-blocking
|
|
24093
|
+
* triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors.
|
|
23991
24094
|
*/
|
|
23992
24095
|
200: {
|
|
23993
24096
|
headers: {
|
|
@@ -24100,7 +24203,7 @@ interface operations {
|
|
|
24100
24203
|
* An example conjunction is:
|
|
24101
24204
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24102
24205
|
*
|
|
24103
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
24206
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
24104
24207
|
*
|
|
24105
24208
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
24106
24209
|
*
|
|
@@ -24162,8 +24265,10 @@ interface operations {
|
|
|
24162
24265
|
select?: string;
|
|
24163
24266
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
24164
24267
|
resource_type?: string;
|
|
24165
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
24268
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
24166
24269
|
where_data?: string;
|
|
24270
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
24271
|
+
where_data_engine?: string;
|
|
24167
24272
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
24168
24273
|
where_trigger?: string;
|
|
24169
24274
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
@@ -26361,7 +26466,7 @@ interface operations {
|
|
|
26361
26466
|
* An example conjunction is:
|
|
26362
26467
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
26363
26468
|
*
|
|
26364
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
26469
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
26365
26470
|
*
|
|
26366
26471
|
* To list a tagged Revision use `Tags ? '<tag-id>'`.
|
|
26367
26472
|
*
|
|
@@ -26430,7 +26535,7 @@ interface operations {
|
|
|
26430
26535
|
*
|
|
26431
26536
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
26432
26537
|
*
|
|
26433
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
26538
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
26434
26539
|
*
|
|
26435
26540
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
26436
26541
|
*
|
|
@@ -26549,7 +26654,7 @@ interface operations {
|
|
|
26549
26654
|
*
|
|
26550
26655
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
26551
26656
|
*
|
|
26552
|
-
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, OrganizationID, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID.
|
|
26657
|
+
* Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationWarnings, Values.
|
|
26553
26658
|
*
|
|
26554
26659
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
26555
26660
|
*
|
|
@@ -30276,7 +30381,7 @@ interface operations {
|
|
|
30276
30381
|
* An example conjunction is:
|
|
30277
30382
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30278
30383
|
*
|
|
30279
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
30384
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
30280
30385
|
*
|
|
30281
30386
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
30282
30387
|
*
|
|
@@ -30338,8 +30443,10 @@ interface operations {
|
|
|
30338
30443
|
select?: string;
|
|
30339
30444
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
30340
30445
|
resource_type?: string;
|
|
30341
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
30446
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
30342
30447
|
where_data?: string;
|
|
30448
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
30449
|
+
where_data_engine?: string;
|
|
30343
30450
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
30344
30451
|
where_trigger?: string;
|
|
30345
30452
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
@@ -30458,7 +30565,7 @@ interface operations {
|
|
|
30458
30565
|
* An example conjunction is:
|
|
30459
30566
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30460
30567
|
*
|
|
30461
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
30568
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
30462
30569
|
*
|
|
30463
30570
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
30464
30571
|
*
|
|
@@ -30800,7 +30907,7 @@ interface operations {
|
|
|
30800
30907
|
* An example conjunction is:
|
|
30801
30908
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30802
30909
|
*
|
|
30803
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
30910
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
30804
30911
|
*
|
|
30805
30912
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
30806
30913
|
*
|
|
@@ -30995,7 +31102,7 @@ interface operations {
|
|
|
30995
31102
|
* An example conjunction is:
|
|
30996
31103
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30997
31104
|
*
|
|
30998
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
31105
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
30999
31106
|
*
|
|
31000
31107
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
31001
31108
|
*
|
|
@@ -31317,7 +31424,7 @@ interface operations {
|
|
|
31317
31424
|
* An example conjunction is:
|
|
31318
31425
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
31319
31426
|
*
|
|
31320
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
31427
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
31321
31428
|
*
|
|
31322
31429
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
31323
31430
|
*
|
|
@@ -31496,7 +31603,7 @@ interface operations {
|
|
|
31496
31603
|
* An example conjunction is:
|
|
31497
31604
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
31498
31605
|
*
|
|
31499
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
31606
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
31500
31607
|
*
|
|
31501
31608
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
31502
31609
|
*
|
|
@@ -31682,7 +31789,7 @@ interface operations {
|
|
|
31682
31789
|
* An example conjunction is:
|
|
31683
31790
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
31684
31791
|
*
|
|
31685
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
31792
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
31686
31793
|
*
|
|
31687
31794
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
31688
31795
|
*
|
|
@@ -32010,7 +32117,7 @@ interface operations {
|
|
|
32010
32117
|
* An example conjunction is:
|
|
32011
32118
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
32012
32119
|
*
|
|
32013
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
32120
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
32014
32121
|
*
|
|
32015
32122
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
32016
32123
|
*
|
|
@@ -32072,8 +32179,10 @@ interface operations {
|
|
|
32072
32179
|
select?: string;
|
|
32073
32180
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
32074
32181
|
resource_type?: string;
|
|
32075
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
32182
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
32076
32183
|
where_data?: string;
|
|
32184
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
32185
|
+
where_data_engine?: string;
|
|
32077
32186
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
32078
32187
|
where_trigger?: string;
|
|
32079
32188
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
@@ -32367,7 +32476,7 @@ interface operations {
|
|
|
32367
32476
|
* An example conjunction is:
|
|
32368
32477
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
32369
32478
|
*
|
|
32370
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
32479
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
32371
32480
|
*
|
|
32372
32481
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
32373
32482
|
*
|
|
@@ -32429,8 +32538,10 @@ interface operations {
|
|
|
32429
32538
|
select?: string;
|
|
32430
32539
|
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
32431
32540
|
resource_type?: string;
|
|
32432
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|`
|
|
32541
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
32433
32542
|
where_data?: string;
|
|
32543
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
32544
|
+
where_data_engine?: string;
|
|
32434
32545
|
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
32435
32546
|
where_trigger?: string;
|
|
32436
32547
|
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|