@confighub/rtk-query 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.cjs +8 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +339 -234
- package/dist/index.d.ts +339 -234
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1349,7 +1349,7 @@ type BulkDeleteChangeOrdersApiArg = {
|
|
|
1349
1349
|
An example conjunction is:
|
|
1350
1350
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1351
1351
|
|
|
1352
|
-
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.
|
|
1352
|
+
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.
|
|
1353
1353
|
|
|
1354
1354
|
The whole string must be query-encoded. */
|
|
1355
1355
|
where?: string;
|
|
@@ -1385,7 +1385,7 @@ type BulkDeleteChangeOrdersApiArg = {
|
|
|
1385
1385
|
The attribute names are case-sensitive, PascalCase, and
|
|
1386
1386
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1387
1387
|
|
|
1388
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
1388
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1389
1389
|
|
|
1390
1390
|
The whole string must be query-encoded. */
|
|
1391
1391
|
include?: string;
|
|
@@ -1427,7 +1427,7 @@ type ListAllChangeOrdersApiArg = {
|
|
|
1427
1427
|
An example conjunction is:
|
|
1428
1428
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1429
1429
|
|
|
1430
|
-
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.
|
|
1430
|
+
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.
|
|
1431
1431
|
|
|
1432
1432
|
The whole string must be query-encoded. */
|
|
1433
1433
|
where?: string;
|
|
@@ -1463,7 +1463,7 @@ type ListAllChangeOrdersApiArg = {
|
|
|
1463
1463
|
The attribute names are case-sensitive, PascalCase, and
|
|
1464
1464
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1465
1465
|
|
|
1466
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
1466
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1467
1467
|
|
|
1468
1468
|
The whole string must be query-encoded. */
|
|
1469
1469
|
include?: string;
|
|
@@ -1513,7 +1513,7 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1513
1513
|
An example conjunction is:
|
|
1514
1514
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1515
1515
|
|
|
1516
|
-
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.
|
|
1516
|
+
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.
|
|
1517
1517
|
|
|
1518
1518
|
The whole string must be query-encoded. */
|
|
1519
1519
|
where?: string;
|
|
@@ -1549,7 +1549,7 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1549
1549
|
The attribute names are case-sensitive, PascalCase, and
|
|
1550
1550
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1551
1551
|
|
|
1552
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
1552
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1553
1553
|
|
|
1554
1554
|
The whole string must be query-encoded. */
|
|
1555
1555
|
include?: string;
|
|
@@ -1568,15 +1568,19 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1568
1568
|
DisplayName?: string | null;
|
|
1569
1569
|
EndTagID?: string | null;
|
|
1570
1570
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
1571
|
+
InvocationID?: string | null;
|
|
1571
1572
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
1572
1573
|
Labels?: {
|
|
1573
1574
|
[key: string]: string | null;
|
|
1574
1575
|
} | null;
|
|
1576
|
+
Parameters?: object | null;
|
|
1575
1577
|
/** Unique URL-safe identifier for the entity. */
|
|
1576
1578
|
Slug?: string | null;
|
|
1579
|
+
UnitFilterID?: string | null;
|
|
1577
1580
|
UpdateType?: string | null;
|
|
1578
1581
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
1579
1582
|
Version?: number | null;
|
|
1583
|
+
WhereUnit?: string | null;
|
|
1580
1584
|
};
|
|
1581
1585
|
};
|
|
1582
1586
|
type BulkCreateChangeOrdersApiResponse = /** status 200 OK */ ChangeOrderCreateOrUpdateResponseRead[] | /** status 207 Multi-Status (partial success) */ ChangeOrderCreateOrUpdateResponseRead[];
|
|
@@ -1615,7 +1619,7 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1615
1619
|
An example conjunction is:
|
|
1616
1620
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1617
1621
|
|
|
1618
|
-
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.
|
|
1622
|
+
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.
|
|
1619
1623
|
|
|
1620
1624
|
The whole string must be query-encoded. */
|
|
1621
1625
|
where?: string;
|
|
@@ -1651,7 +1655,7 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1651
1655
|
The attribute names are case-sensitive, PascalCase, and
|
|
1652
1656
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1653
1657
|
|
|
1654
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
1658
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1655
1659
|
|
|
1656
1660
|
The whole string must be query-encoded. */
|
|
1657
1661
|
include?: string;
|
|
@@ -1730,15 +1734,19 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1730
1734
|
DisplayName?: string | null;
|
|
1731
1735
|
EndTagID?: string | null;
|
|
1732
1736
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
1737
|
+
InvocationID?: string | null;
|
|
1733
1738
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
1734
1739
|
Labels?: {
|
|
1735
1740
|
[key: string]: string | null;
|
|
1736
1741
|
} | null;
|
|
1742
|
+
Parameters?: object | null;
|
|
1737
1743
|
/** Unique URL-safe identifier for the entity. */
|
|
1738
1744
|
Slug?: string | null;
|
|
1745
|
+
UnitFilterID?: string | null;
|
|
1739
1746
|
UpdateType?: string | null;
|
|
1740
1747
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
1741
1748
|
Version?: number | null;
|
|
1749
|
+
WhereUnit?: string | null;
|
|
1742
1750
|
};
|
|
1743
1751
|
};
|
|
1744
1752
|
type BulkDeleteChangeSetsApiResponse = /** status 200 OK */ DeleteResponse[] | /** status 207 Multi-Status: Mixed success and failure results */ DeleteResponse[];
|
|
@@ -2654,6 +2662,8 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
2654
2662
|
guards?: string;
|
|
2655
2663
|
/** Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
2656
2664
|
changeSetId?: string;
|
|
2665
|
+
/** 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. */
|
|
2666
|
+
changeOrder?: string;
|
|
2657
2667
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
2658
2668
|
subgroup?: string;
|
|
2659
2669
|
/** 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. */
|
|
@@ -2692,7 +2702,7 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
2692
2702
|
An example conjunction is:
|
|
2693
2703
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
2694
2704
|
|
|
2695
|
-
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.
|
|
2705
|
+
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.
|
|
2696
2706
|
|
|
2697
2707
|
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`.
|
|
2698
2708
|
|
|
@@ -2714,8 +2724,10 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
2714
2724
|
include?: string;
|
|
2715
2725
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
2716
2726
|
resourceType?: string;
|
|
2717
|
-
/** 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 `.|`
|
|
2727
|
+
/** 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. */
|
|
2718
2728
|
whereData?: string;
|
|
2729
|
+
/** 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. */
|
|
2730
|
+
whereDataEngine?: string;
|
|
2719
2731
|
/** 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). */
|
|
2720
2732
|
whereTrigger?: string;
|
|
2721
2733
|
/** 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. */
|
|
@@ -4119,7 +4131,7 @@ type ListAllRevisionsApiArg = {
|
|
|
4119
4131
|
An example conjunction is:
|
|
4120
4132
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4121
4133
|
|
|
4122
|
-
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.
|
|
4134
|
+
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.
|
|
4123
4135
|
|
|
4124
4136
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4125
4137
|
|
|
@@ -4178,7 +4190,7 @@ type ListAllRevisionsApiArg = {
|
|
|
4178
4190
|
|
|
4179
4191
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4180
4192
|
|
|
4181
|
-
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.
|
|
4193
|
+
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.
|
|
4182
4194
|
|
|
4183
4195
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4184
4196
|
|
|
@@ -4231,7 +4243,7 @@ type SearchRevisionDataApiArg = {
|
|
|
4231
4243
|
An example conjunction is:
|
|
4232
4244
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4233
4245
|
|
|
4234
|
-
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.
|
|
4246
|
+
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.
|
|
4235
4247
|
|
|
4236
4248
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4237
4249
|
|
|
@@ -4290,7 +4302,7 @@ type SearchRevisionDataApiArg = {
|
|
|
4290
4302
|
|
|
4291
4303
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4292
4304
|
|
|
4293
|
-
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.
|
|
4305
|
+
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.
|
|
4294
4306
|
|
|
4295
4307
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4296
4308
|
|
|
@@ -4344,7 +4356,7 @@ type SearchRevisionMutationSourcesApiArg = {
|
|
|
4344
4356
|
An example conjunction is:
|
|
4345
4357
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4346
4358
|
|
|
4347
|
-
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.
|
|
4359
|
+
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.
|
|
4348
4360
|
|
|
4349
4361
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4350
4362
|
|
|
@@ -4403,7 +4415,7 @@ type SearchRevisionMutationSourcesApiArg = {
|
|
|
4403
4415
|
|
|
4404
4416
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4405
4417
|
|
|
4406
|
-
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.
|
|
4418
|
+
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.
|
|
4407
4419
|
|
|
4408
4420
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4409
4421
|
|
|
@@ -5039,7 +5051,7 @@ type ListChangeOrdersApiArg = {
|
|
|
5039
5051
|
An example conjunction is:
|
|
5040
5052
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
5041
5053
|
|
|
5042
|
-
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.
|
|
5054
|
+
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.
|
|
5043
5055
|
|
|
5044
5056
|
The whole string must be query-encoded. */
|
|
5045
5057
|
where?: string;
|
|
@@ -5075,7 +5087,7 @@ type ListChangeOrdersApiArg = {
|
|
|
5075
5087
|
The attribute names are case-sensitive, PascalCase, and
|
|
5076
5088
|
expected in a comma-separated list format as in the JSON encoding.
|
|
5077
5089
|
|
|
5078
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
5090
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
5079
5091
|
|
|
5080
5092
|
The whole string must be query-encoded. */
|
|
5081
5093
|
include?: string;
|
|
@@ -5115,7 +5127,7 @@ type GetChangeOrderApiArg = {
|
|
|
5115
5127
|
The attribute names are case-sensitive, PascalCase, and
|
|
5116
5128
|
expected in a comma-separated list format as in the JSON encoding.
|
|
5117
5129
|
|
|
5118
|
-
Supported attributes for ChangeOrder are EndTagID, OrganizationID, RestoreTagID, SpaceID, StartTagID.
|
|
5130
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
5119
5131
|
|
|
5120
5132
|
The whole string must be query-encoded. */
|
|
5121
5133
|
include?: string;
|
|
@@ -5153,15 +5165,19 @@ type PatchChangeOrderApiArg = {
|
|
|
5153
5165
|
DisplayName?: string | null;
|
|
5154
5166
|
EndTagID?: string | null;
|
|
5155
5167
|
InScopeSpaceIDs?: (string | null)[] | null;
|
|
5168
|
+
InvocationID?: string | null;
|
|
5156
5169
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
5157
5170
|
Labels?: {
|
|
5158
5171
|
[key: string]: string | null;
|
|
5159
5172
|
} | null;
|
|
5173
|
+
Parameters?: object | null;
|
|
5160
5174
|
/** Unique URL-safe identifier for the entity. */
|
|
5161
5175
|
Slug?: string | null;
|
|
5176
|
+
UnitFilterID?: string | null;
|
|
5162
5177
|
UpdateType?: string | null;
|
|
5163
5178
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
5164
5179
|
Version?: number | null;
|
|
5180
|
+
WhereUnit?: string | null;
|
|
5165
5181
|
};
|
|
5166
5182
|
};
|
|
5167
5183
|
type UpdateChangeOrderApiResponse =
|
|
@@ -5586,6 +5602,8 @@ type InvokeFunctionsApiArg = {
|
|
|
5586
5602
|
guards?: string;
|
|
5587
5603
|
/** Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
5588
5604
|
changeSetId?: string;
|
|
5605
|
+
/** 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. */
|
|
5606
|
+
changeOrder?: string;
|
|
5589
5607
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
5590
5608
|
subgroup?: string;
|
|
5591
5609
|
/** 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. */
|
|
@@ -5624,7 +5642,7 @@ type InvokeFunctionsApiArg = {
|
|
|
5624
5642
|
An example conjunction is:
|
|
5625
5643
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
5626
5644
|
|
|
5627
|
-
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.
|
|
5645
|
+
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.
|
|
5628
5646
|
|
|
5629
5647
|
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`.
|
|
5630
5648
|
|
|
@@ -5646,8 +5664,10 @@ type InvokeFunctionsApiArg = {
|
|
|
5646
5664
|
include?: string;
|
|
5647
5665
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
5648
5666
|
resourceType?: string;
|
|
5649
|
-
/** 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 `.|`
|
|
5667
|
+
/** 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. */
|
|
5650
5668
|
whereData?: string;
|
|
5669
|
+
/** 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. */
|
|
5670
|
+
whereDataEngine?: string;
|
|
5651
5671
|
/** 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). */
|
|
5652
5672
|
whereTrigger?: string;
|
|
5653
5673
|
/** 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. */
|
|
@@ -6663,7 +6683,7 @@ to execute on events.
|
|
|
6663
6683
|
|
|
6664
6684
|
Triggers can be either validating (checking configuration validity without modifying it)
|
|
6665
6685
|
or mutating (making changes to the configuration). They can be disabled, and validating
|
|
6666
|
-
triggers can be set to Warn mode to produce non-blocking
|
|
6686
|
+
triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ TriggerRead;
|
|
6667
6687
|
type CreateTriggerApiArg = {
|
|
6668
6688
|
/** Unique identifier for a space_id */
|
|
6669
6689
|
spaceId: string;
|
|
@@ -6712,7 +6732,7 @@ to execute on events.
|
|
|
6712
6732
|
|
|
6713
6733
|
Triggers can be either validating (checking configuration validity without modifying it)
|
|
6714
6734
|
or mutating (making changes to the configuration). They can be disabled, and validating
|
|
6715
|
-
triggers can be set to Warn mode to produce non-blocking
|
|
6735
|
+
triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ TriggerRead;
|
|
6716
6736
|
type PatchTriggerApiArg = {
|
|
6717
6737
|
/** Unique identifier for a space_id */
|
|
6718
6738
|
spaceId: string;
|
|
@@ -6773,7 +6793,7 @@ to execute on events.
|
|
|
6773
6793
|
|
|
6774
6794
|
Triggers can be either validating (checking configuration validity without modifying it)
|
|
6775
6795
|
or mutating (making changes to the configuration). They can be disabled, and validating
|
|
6776
|
-
triggers can be set to Warn mode to produce non-blocking
|
|
6796
|
+
triggers can be set to Warn mode to produce non-blocking ValidationWarnings instead of ValidationErrors. */ TriggerRead;
|
|
6777
6797
|
type UpdateTriggerApiArg = {
|
|
6778
6798
|
/** Unique identifier for a space_id */
|
|
6779
6799
|
spaceId: string;
|
|
@@ -6819,7 +6839,7 @@ type ListUnitsApiArg = {
|
|
|
6819
6839
|
An example conjunction is:
|
|
6820
6840
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6821
6841
|
|
|
6822
|
-
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.
|
|
6842
|
+
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.
|
|
6823
6843
|
|
|
6824
6844
|
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`.
|
|
6825
6845
|
|
|
@@ -6872,8 +6892,10 @@ type ListUnitsApiArg = {
|
|
|
6872
6892
|
select?: string;
|
|
6873
6893
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
6874
6894
|
resourceType?: string;
|
|
6875
|
-
/** 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 `.|`
|
|
6895
|
+
/** 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. */
|
|
6876
6896
|
whereData?: string;
|
|
6897
|
+
/** 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. */
|
|
6898
|
+
whereDataEngine?: string;
|
|
6877
6899
|
/** 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). */
|
|
6878
6900
|
whereTrigger?: string;
|
|
6879
6901
|
/** 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. */
|
|
@@ -7582,7 +7604,7 @@ type ListExtendedRevisionsApiArg = {
|
|
|
7582
7604
|
An example conjunction is:
|
|
7583
7605
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
7584
7606
|
|
|
7585
|
-
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.
|
|
7607
|
+
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.
|
|
7586
7608
|
|
|
7587
7609
|
To list a tagged Revision use `Tags ? '<tag-id>'`.
|
|
7588
7610
|
|
|
@@ -7641,7 +7663,7 @@ type ListExtendedRevisionsApiArg = {
|
|
|
7641
7663
|
|
|
7642
7664
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
7643
7665
|
|
|
7644
|
-
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.
|
|
7666
|
+
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.
|
|
7645
7667
|
|
|
7646
7668
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
7647
7669
|
|
|
@@ -7682,7 +7704,7 @@ type GetExtendedRevisionApiArg = {
|
|
|
7682
7704
|
|
|
7683
7705
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
7684
7706
|
|
|
7685
|
-
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.
|
|
7707
|
+
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.
|
|
7686
7708
|
|
|
7687
7709
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
7688
7710
|
|
|
@@ -9294,7 +9316,7 @@ type BulkDeleteUnitsApiArg = {
|
|
|
9294
9316
|
An example conjunction is:
|
|
9295
9317
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9296
9318
|
|
|
9297
|
-
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.
|
|
9319
|
+
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.
|
|
9298
9320
|
|
|
9299
9321
|
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`.
|
|
9300
9322
|
|
|
@@ -9373,7 +9395,7 @@ type ListAllUnitsApiArg = {
|
|
|
9373
9395
|
An example conjunction is:
|
|
9374
9396
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9375
9397
|
|
|
9376
|
-
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.
|
|
9398
|
+
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.
|
|
9377
9399
|
|
|
9378
9400
|
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`.
|
|
9379
9401
|
|
|
@@ -9426,8 +9448,10 @@ type ListAllUnitsApiArg = {
|
|
|
9426
9448
|
select?: string;
|
|
9427
9449
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
9428
9450
|
resourceType?: string;
|
|
9429
|
-
/** 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 `.|`
|
|
9451
|
+
/** 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. */
|
|
9430
9452
|
whereData?: string;
|
|
9453
|
+
/** 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. */
|
|
9454
|
+
whereDataEngine?: string;
|
|
9431
9455
|
/** 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). */
|
|
9432
9456
|
whereTrigger?: string;
|
|
9433
9457
|
/** 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. */
|
|
@@ -9473,7 +9497,7 @@ type BulkPatchUnitsApiArg = {
|
|
|
9473
9497
|
An example conjunction is:
|
|
9474
9498
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9475
9499
|
|
|
9476
|
-
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.
|
|
9500
|
+
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.
|
|
9477
9501
|
|
|
9478
9502
|
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`.
|
|
9479
9503
|
|
|
@@ -9675,7 +9699,7 @@ type BulkCreateUnitsApiArg = {
|
|
|
9675
9699
|
An example conjunction is:
|
|
9676
9700
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9677
9701
|
|
|
9678
|
-
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.
|
|
9702
|
+
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.
|
|
9679
9703
|
|
|
9680
9704
|
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`.
|
|
9681
9705
|
|
|
@@ -9895,7 +9919,7 @@ type BulkApproveUnitsApiArg = {
|
|
|
9895
9919
|
An example conjunction is:
|
|
9896
9920
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9897
9921
|
|
|
9898
|
-
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.
|
|
9922
|
+
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.
|
|
9899
9923
|
|
|
9900
9924
|
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`.
|
|
9901
9925
|
|
|
@@ -9976,7 +10000,7 @@ type BulkCancelUnitsApiArg = {
|
|
|
9976
10000
|
An example conjunction is:
|
|
9977
10001
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9978
10002
|
|
|
9979
|
-
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.
|
|
10003
|
+
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.
|
|
9980
10004
|
|
|
9981
10005
|
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`.
|
|
9982
10006
|
|
|
@@ -10055,7 +10079,7 @@ type BulkTagUnitsApiArg = {
|
|
|
10055
10079
|
An example conjunction is:
|
|
10056
10080
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10057
10081
|
|
|
10058
|
-
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.
|
|
10082
|
+
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.
|
|
10059
10083
|
|
|
10060
10084
|
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`.
|
|
10061
10085
|
|
|
@@ -10204,7 +10228,7 @@ type SearchUnitDataApiArg = {
|
|
|
10204
10228
|
An example conjunction is:
|
|
10205
10229
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10206
10230
|
|
|
10207
|
-
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.
|
|
10231
|
+
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.
|
|
10208
10232
|
|
|
10209
10233
|
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`.
|
|
10210
10234
|
|
|
@@ -10257,8 +10281,10 @@ type SearchUnitDataApiArg = {
|
|
|
10257
10281
|
select?: string;
|
|
10258
10282
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
10259
10283
|
resourceType?: string;
|
|
10260
|
-
/** 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 `.|`
|
|
10284
|
+
/** 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. */
|
|
10261
10285
|
whereData?: string;
|
|
10286
|
+
/** 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. */
|
|
10287
|
+
whereDataEngine?: string;
|
|
10262
10288
|
/** 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). */
|
|
10263
10289
|
whereTrigger?: string;
|
|
10264
10290
|
/** 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. */
|
|
@@ -10398,7 +10424,7 @@ type SearchUnitMutationSourcesApiArg = {
|
|
|
10398
10424
|
An example conjunction is:
|
|
10399
10425
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10400
10426
|
|
|
10401
|
-
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.
|
|
10427
|
+
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.
|
|
10402
10428
|
|
|
10403
10429
|
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`.
|
|
10404
10430
|
|
|
@@ -10451,8 +10477,10 @@ type SearchUnitMutationSourcesApiArg = {
|
|
|
10451
10477
|
select?: string;
|
|
10452
10478
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
10453
10479
|
resourceType?: string;
|
|
10454
|
-
/** 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 `.|`
|
|
10480
|
+
/** 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. */
|
|
10455
10481
|
whereData?: string;
|
|
10482
|
+
/** 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. */
|
|
10483
|
+
whereDataEngine?: string;
|
|
10456
10484
|
/** 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). */
|
|
10457
10485
|
whereTrigger?: string;
|
|
10458
10486
|
/** 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. */
|
|
@@ -11846,22 +11874,32 @@ type ChangeOrder = {
|
|
|
11846
11874
|
DisplayName?: string;
|
|
11847
11875
|
/** EndTagID is the identifier of the set of Revisions that end the ChangeOrder. The ChangeOrder always mints this Tag itself; supplying one at creation adopts its marks as the boundary, and the supplied Tag is recorded as AdoptedEndTagID and never written to. Without one the boundary is each Unit's head Revision. */
|
|
11848
11876
|
EndTagID?: string;
|
|
11849
|
-
/** 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. */
|
|
11877
|
+
/** 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. */
|
|
11850
11878
|
InScopeSpaceIDs?: Uuid[];
|
|
11879
|
+
/** 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. */
|
|
11880
|
+
InvocationID?: string;
|
|
11851
11881
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
11852
11882
|
Labels?: {
|
|
11853
11883
|
[key: string]: string;
|
|
11854
11884
|
};
|
|
11855
11885
|
/** Unique identifier for an organization. */
|
|
11856
11886
|
OrganizationID?: string;
|
|
11887
|
+
/** 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. */
|
|
11888
|
+
Parameters?: {
|
|
11889
|
+
[key: string]: any;
|
|
11890
|
+
};
|
|
11857
11891
|
/** Unique URL-safe identifier for the entity. */
|
|
11858
11892
|
Slug: string;
|
|
11859
11893
|
/** Unique identifier for a space. */
|
|
11860
11894
|
SpaceID?: string;
|
|
11861
|
-
/**
|
|
11895
|
+
/** UnitFilterID references a Filter (with From=Unit) narrowing the same selection as WhereUnit, conjoined with it. Refused on the other UpdateTypes. Immutable. */
|
|
11896
|
+
UnitFilterID?: string;
|
|
11897
|
+
/** 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. */
|
|
11862
11898
|
UpdateType?: string;
|
|
11863
11899
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
11864
11900
|
Version?: number;
|
|
11901
|
+
/** 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. */
|
|
11902
|
+
WhereUnit?: string;
|
|
11865
11903
|
};
|
|
11866
11904
|
type ChangeOrderRead = {
|
|
11867
11905
|
/** AbortedReason says why the ChangeOrder was given up on. Setting it is what aborts one: a ChangeOrder with a reason is Aborted whatever its Links say. */
|
|
@@ -11890,19 +11928,25 @@ type ChangeOrderRead = {
|
|
|
11890
11928
|
EndTagID?: string;
|
|
11891
11929
|
/** The type of entity. */
|
|
11892
11930
|
EntityType?: string;
|
|
11893
|
-
/** 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. */
|
|
11931
|
+
/** 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. */
|
|
11894
11932
|
InScopeSpaceIDs?: Uuid[];
|
|
11933
|
+
/** 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. */
|
|
11934
|
+
InvocationID?: string;
|
|
11895
11935
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
11896
11936
|
Labels?: {
|
|
11897
11937
|
[key: string]: string;
|
|
11898
11938
|
};
|
|
11899
11939
|
/** Unique identifier for an organization. */
|
|
11900
11940
|
OrganizationID?: string;
|
|
11941
|
+
/** 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. */
|
|
11942
|
+
Parameters?: {
|
|
11943
|
+
[key: string]: any;
|
|
11944
|
+
};
|
|
11901
11945
|
/** 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. */
|
|
11902
11946
|
ReleasedRestoredSpaceIDs?: Uuid[];
|
|
11903
11947
|
/** 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. */
|
|
11904
11948
|
ReleasedSpaceIDs?: Uuid[];
|
|
11905
|
-
/** 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. */
|
|
11949
|
+
/** 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. */
|
|
11906
11950
|
ResolvedSpaceIDs?: Uuid[];
|
|
11907
11951
|
/** RestoreTagID is the Tag marking the Revisions that undid the ChangeOrder. The first restore mints it; every restore after that marks with the same Tag. Empty until something has been restored. */
|
|
11908
11952
|
RestoreTagID?: string;
|
|
@@ -11922,12 +11966,16 @@ type ChangeOrderRead = {
|
|
|
11922
11966
|
StartTagID?: string;
|
|
11923
11967
|
/** 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. */
|
|
11924
11968
|
State?: string;
|
|
11925
|
-
/**
|
|
11969
|
+
/** UnitFilterID references a Filter (with From=Unit) narrowing the same selection as WhereUnit, conjoined with it. Refused on the other UpdateTypes. Immutable. */
|
|
11970
|
+
UnitFilterID?: string;
|
|
11971
|
+
/** 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. */
|
|
11926
11972
|
UpdateType?: string;
|
|
11927
11973
|
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|
|
11928
11974
|
UpdatedAt?: string;
|
|
11929
11975
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
11930
11976
|
Version?: number;
|
|
11977
|
+
/** 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. */
|
|
11978
|
+
WhereUnit?: string;
|
|
11931
11979
|
};
|
|
11932
11980
|
type Tag = {
|
|
11933
11981
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -11995,67 +12043,78 @@ type TagRead = {
|
|
|
11995
12043
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
11996
12044
|
Version?: number;
|
|
11997
12045
|
};
|
|
11998
|
-
type
|
|
11999
|
-
|
|
12000
|
-
|
|
12001
|
-
|
|
12002
|
-
Organization?: Organization;
|
|
12003
|
-
RestoreTag?: Tag;
|
|
12004
|
-
Space?: Space;
|
|
12005
|
-
StartTag?: Tag;
|
|
12046
|
+
type FunctionArgument = {
|
|
12047
|
+
Evaluator?: string;
|
|
12048
|
+
ParameterName?: string;
|
|
12049
|
+
Value?: string | number | boolean;
|
|
12006
12050
|
};
|
|
12007
|
-
type
|
|
12008
|
-
|
|
12009
|
-
|
|
12010
|
-
|
|
12011
|
-
|
|
12012
|
-
|
|
12013
|
-
|
|
12014
|
-
StartTag?: TagRead;
|
|
12051
|
+
type ClearanceRequirement = {
|
|
12052
|
+
/** The guard key this requirement is about */
|
|
12053
|
+
Key?: string;
|
|
12054
|
+
/** Exists, In, NotIn, or DoesNotExist */
|
|
12055
|
+
Operator?: string;
|
|
12056
|
+
/** The values In and NotIn compare against; unused by Exists and DoesNotExist */
|
|
12057
|
+
Values?: string[];
|
|
12015
12058
|
};
|
|
12016
|
-
type
|
|
12017
|
-
|
|
12018
|
-
|
|
12059
|
+
type Clearance = ClearanceRequirement[];
|
|
12060
|
+
type GuardStamp = {
|
|
12061
|
+
[key: string]: string;
|
|
12019
12062
|
};
|
|
12020
|
-
type
|
|
12021
|
-
|
|
12022
|
-
|
|
12063
|
+
type FunctionInvocation = {
|
|
12064
|
+
/** Function arguments */
|
|
12065
|
+
Arguments?: FunctionArgument[] | null;
|
|
12066
|
+
Clearance?: Clearance;
|
|
12067
|
+
/** Function name */
|
|
12068
|
+
FunctionName?: string;
|
|
12069
|
+
Guards?: GuardStamp;
|
|
12070
|
+
/** Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
12071
|
+
Params?: {
|
|
12072
|
+
[key: string]: any;
|
|
12073
|
+
};
|
|
12074
|
+
/** Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */
|
|
12075
|
+
WhereResource?: string;
|
|
12023
12076
|
};
|
|
12024
|
-
type
|
|
12077
|
+
type FunctionInvocationList = FunctionInvocation[] | null;
|
|
12078
|
+
type Invocation = {
|
|
12025
12079
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12026
12080
|
Annotations?: {
|
|
12027
12081
|
[key: string]: string;
|
|
12028
12082
|
};
|
|
12029
|
-
/**
|
|
12030
|
-
|
|
12083
|
+
/** Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If unspecified, use the builtin function executor. */
|
|
12084
|
+
BridgeWorkerID?: string;
|
|
12031
12085
|
/** An optional set of gates that, if any is present, will block deletion. */
|
|
12032
12086
|
DeleteGates?: {
|
|
12033
12087
|
[key: string]: boolean;
|
|
12034
12088
|
};
|
|
12035
|
-
/** Description is a human-readable description of the change. */
|
|
12036
|
-
Description?: string;
|
|
12037
12089
|
/** Friendly name for the entity. */
|
|
12038
12090
|
DisplayName?: string;
|
|
12091
|
+
FunctionInvocations: FunctionInvocationList;
|
|
12092
|
+
/** InvocationID uniquely identifies a invocation within the system. */
|
|
12093
|
+
InvocationID?: string;
|
|
12039
12094
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12040
12095
|
Labels?: {
|
|
12041
12096
|
[key: string]: string;
|
|
12042
12097
|
};
|
|
12043
12098
|
/** Unique identifier for an organization. */
|
|
12044
12099
|
OrganizationID?: string;
|
|
12100
|
+
Parameters?: FunctionParameter[];
|
|
12045
12101
|
/** Unique URL-safe identifier for the entity. */
|
|
12046
12102
|
Slug: string;
|
|
12047
12103
|
/** Unique identifier for a space. */
|
|
12048
12104
|
SpaceID?: string;
|
|
12105
|
+
/** ToolchainType specifies the type of toolchain this invocation works with.
|
|
12106
|
+
This determines which configuration formats the invocation can process. */
|
|
12107
|
+
ToolchainType: string;
|
|
12049
12108
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12050
12109
|
Version?: number;
|
|
12051
12110
|
};
|
|
12052
|
-
type
|
|
12111
|
+
type InvocationRead = {
|
|
12053
12112
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12054
12113
|
Annotations?: {
|
|
12055
12114
|
[key: string]: string;
|
|
12056
12115
|
};
|
|
12057
|
-
/**
|
|
12058
|
-
|
|
12116
|
+
/** Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If unspecified, use the builtin function executor. */
|
|
12117
|
+
BridgeWorkerID?: string;
|
|
12059
12118
|
/** The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. */
|
|
12060
12119
|
CreatedAt?: string;
|
|
12061
12120
|
/** An auto-incrementing sequence number used for pagination. */
|
|
@@ -12064,61 +12123,36 @@ type ChangeSetRead = {
|
|
|
12064
12123
|
DeleteGates?: {
|
|
12065
12124
|
[key: string]: boolean;
|
|
12066
12125
|
};
|
|
12067
|
-
/** Description is a human-readable description of the change. */
|
|
12068
|
-
Description?: string;
|
|
12069
12126
|
/** Friendly name for the entity. */
|
|
12070
12127
|
DisplayName?: string;
|
|
12071
|
-
/** EndTagID is the identifier of the set of revisions that end the ChangeSet. */
|
|
12072
|
-
EndTagID?: string;
|
|
12073
12128
|
/** The type of entity. */
|
|
12074
12129
|
EntityType?: string;
|
|
12130
|
+
FunctionInvocations: FunctionInvocationList;
|
|
12131
|
+
/** SHA256 hash of the functions and their arguments encoded as hexadecimal. */
|
|
12132
|
+
Hash?: string;
|
|
12133
|
+
/** InvocationID uniquely identifies a invocation within the system. */
|
|
12134
|
+
InvocationID?: string;
|
|
12075
12135
|
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12076
12136
|
Labels?: {
|
|
12077
12137
|
[key: string]: string;
|
|
12078
12138
|
};
|
|
12079
12139
|
/** Unique identifier for an organization. */
|
|
12080
12140
|
OrganizationID?: string;
|
|
12141
|
+
Parameters?: FunctionParameter[];
|
|
12081
12142
|
/** Unique URL-safe identifier for the entity. */
|
|
12082
12143
|
Slug: string;
|
|
12083
12144
|
/** Unique identifier for a space. */
|
|
12084
12145
|
SpaceID?: string;
|
|
12085
12146
|
/** Slug of the Space this entity belongs to. (readonly) */
|
|
12086
12147
|
SpaceSlug?: string;
|
|
12087
|
-
/**
|
|
12088
|
-
|
|
12089
|
-
|
|
12090
|
-
StartTagIsPriorRevision?: boolean;
|
|
12091
|
-
/** State represents the current state of the ChangeSet. */
|
|
12092
|
-
State?: string;
|
|
12148
|
+
/** ToolchainType specifies the type of toolchain this invocation works with.
|
|
12149
|
+
This determines which configuration formats the invocation can process. */
|
|
12150
|
+
ToolchainType: string;
|
|
12093
12151
|
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|
|
12094
12152
|
UpdatedAt?: string;
|
|
12095
12153
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12096
12154
|
Version?: number;
|
|
12097
12155
|
};
|
|
12098
|
-
type ExtendedChangeSet = {
|
|
12099
|
-
ChangeSet?: ChangeSet;
|
|
12100
|
-
EndTag?: Tag;
|
|
12101
|
-
Error?: ResponseError;
|
|
12102
|
-
Organization?: Organization;
|
|
12103
|
-
Space?: Space;
|
|
12104
|
-
StartTag?: Tag;
|
|
12105
|
-
};
|
|
12106
|
-
type ExtendedChangeSetRead = {
|
|
12107
|
-
ChangeSet?: ChangeSetRead;
|
|
12108
|
-
EndTag?: TagRead;
|
|
12109
|
-
Error?: ResponseError;
|
|
12110
|
-
Organization?: OrganizationRead;
|
|
12111
|
-
Space?: SpaceRead;
|
|
12112
|
-
StartTag?: TagRead;
|
|
12113
|
-
};
|
|
12114
|
-
type ChangeSetCreateOrUpdateResponse = {
|
|
12115
|
-
ChangeSet?: ChangeSet;
|
|
12116
|
-
Error?: ResponseError;
|
|
12117
|
-
};
|
|
12118
|
-
type ChangeSetCreateOrUpdateResponseRead = {
|
|
12119
|
-
ChangeSet?: ChangeSetRead;
|
|
12120
|
-
Error?: ResponseError;
|
|
12121
|
-
};
|
|
12122
12156
|
type Filter = {
|
|
12123
12157
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12124
12158
|
Annotations?: {
|
|
@@ -12203,6 +12237,134 @@ type FilterRead = {
|
|
|
12203
12237
|
/** WhereData specifies a filter expression for configuration data. Valid only for Units. (optional) */
|
|
12204
12238
|
WhereData?: string;
|
|
12205
12239
|
};
|
|
12240
|
+
type ExtendedChangeOrder = {
|
|
12241
|
+
ChangeOrder?: ChangeOrder;
|
|
12242
|
+
EndTag?: Tag;
|
|
12243
|
+
Error?: ResponseError;
|
|
12244
|
+
Invocation?: Invocation;
|
|
12245
|
+
Organization?: Organization;
|
|
12246
|
+
RestoreTag?: Tag;
|
|
12247
|
+
Space?: Space;
|
|
12248
|
+
StartTag?: Tag;
|
|
12249
|
+
UnitFilter?: Filter;
|
|
12250
|
+
};
|
|
12251
|
+
type ExtendedChangeOrderRead = {
|
|
12252
|
+
ChangeOrder?: ChangeOrderRead;
|
|
12253
|
+
EndTag?: TagRead;
|
|
12254
|
+
Error?: ResponseError;
|
|
12255
|
+
Invocation?: InvocationRead;
|
|
12256
|
+
Organization?: OrganizationRead;
|
|
12257
|
+
RestoreTag?: TagRead;
|
|
12258
|
+
Space?: SpaceRead;
|
|
12259
|
+
StartTag?: TagRead;
|
|
12260
|
+
UnitFilter?: FilterRead;
|
|
12261
|
+
};
|
|
12262
|
+
type ChangeOrderCreateOrUpdateResponse = {
|
|
12263
|
+
ChangeOrder?: ChangeOrder;
|
|
12264
|
+
Error?: ResponseError;
|
|
12265
|
+
};
|
|
12266
|
+
type ChangeOrderCreateOrUpdateResponseRead = {
|
|
12267
|
+
ChangeOrder?: ChangeOrderRead;
|
|
12268
|
+
Error?: ResponseError;
|
|
12269
|
+
};
|
|
12270
|
+
type ChangeSet = {
|
|
12271
|
+
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12272
|
+
Annotations?: {
|
|
12273
|
+
[key: string]: string;
|
|
12274
|
+
};
|
|
12275
|
+
/** ChangeSetID uniquely identifies a changeset within the system. */
|
|
12276
|
+
ChangeSetID?: string;
|
|
12277
|
+
/** An optional set of gates that, if any is present, will block deletion. */
|
|
12278
|
+
DeleteGates?: {
|
|
12279
|
+
[key: string]: boolean;
|
|
12280
|
+
};
|
|
12281
|
+
/** Description is a human-readable description of the change. */
|
|
12282
|
+
Description?: string;
|
|
12283
|
+
/** Friendly name for the entity. */
|
|
12284
|
+
DisplayName?: string;
|
|
12285
|
+
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12286
|
+
Labels?: {
|
|
12287
|
+
[key: string]: string;
|
|
12288
|
+
};
|
|
12289
|
+
/** Unique identifier for an organization. */
|
|
12290
|
+
OrganizationID?: string;
|
|
12291
|
+
/** Unique URL-safe identifier for the entity. */
|
|
12292
|
+
Slug: string;
|
|
12293
|
+
/** Unique identifier for a space. */
|
|
12294
|
+
SpaceID?: string;
|
|
12295
|
+
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12296
|
+
Version?: number;
|
|
12297
|
+
};
|
|
12298
|
+
type ChangeSetRead = {
|
|
12299
|
+
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12300
|
+
Annotations?: {
|
|
12301
|
+
[key: string]: string;
|
|
12302
|
+
};
|
|
12303
|
+
/** ChangeSetID uniquely identifies a changeset within the system. */
|
|
12304
|
+
ChangeSetID?: string;
|
|
12305
|
+
/** The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. */
|
|
12306
|
+
CreatedAt?: string;
|
|
12307
|
+
/** An auto-incrementing sequence number used for pagination. */
|
|
12308
|
+
CursorID?: number;
|
|
12309
|
+
/** An optional set of gates that, if any is present, will block deletion. */
|
|
12310
|
+
DeleteGates?: {
|
|
12311
|
+
[key: string]: boolean;
|
|
12312
|
+
};
|
|
12313
|
+
/** Description is a human-readable description of the change. */
|
|
12314
|
+
Description?: string;
|
|
12315
|
+
/** Friendly name for the entity. */
|
|
12316
|
+
DisplayName?: string;
|
|
12317
|
+
/** EndTagID is the identifier of the set of revisions that end the ChangeSet. */
|
|
12318
|
+
EndTagID?: string;
|
|
12319
|
+
/** The type of entity. */
|
|
12320
|
+
EntityType?: string;
|
|
12321
|
+
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12322
|
+
Labels?: {
|
|
12323
|
+
[key: string]: string;
|
|
12324
|
+
};
|
|
12325
|
+
/** Unique identifier for an organization. */
|
|
12326
|
+
OrganizationID?: string;
|
|
12327
|
+
/** Unique URL-safe identifier for the entity. */
|
|
12328
|
+
Slug: string;
|
|
12329
|
+
/** Unique identifier for a space. */
|
|
12330
|
+
SpaceID?: string;
|
|
12331
|
+
/** Slug of the Space this entity belongs to. (readonly) */
|
|
12332
|
+
SpaceSlug?: string;
|
|
12333
|
+
/** StartTagID is the identifier of the set of revisions that begin the ChangeSet. */
|
|
12334
|
+
StartTagID?: string;
|
|
12335
|
+
/** StartTagIsPriorRevision reports whether the start Tag marks the Revision before the ChangeSet, making the ChangeSet the half-open interval (start, end]. False, the original meaning, means it marks the ChangeSet's first Revision. */
|
|
12336
|
+
StartTagIsPriorRevision?: boolean;
|
|
12337
|
+
/** State represents the current state of the ChangeSet. */
|
|
12338
|
+
State?: string;
|
|
12339
|
+
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|
|
12340
|
+
UpdatedAt?: string;
|
|
12341
|
+
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12342
|
+
Version?: number;
|
|
12343
|
+
};
|
|
12344
|
+
type ExtendedChangeSet = {
|
|
12345
|
+
ChangeSet?: ChangeSet;
|
|
12346
|
+
EndTag?: Tag;
|
|
12347
|
+
Error?: ResponseError;
|
|
12348
|
+
Organization?: Organization;
|
|
12349
|
+
Space?: Space;
|
|
12350
|
+
StartTag?: Tag;
|
|
12351
|
+
};
|
|
12352
|
+
type ExtendedChangeSetRead = {
|
|
12353
|
+
ChangeSet?: ChangeSetRead;
|
|
12354
|
+
EndTag?: TagRead;
|
|
12355
|
+
Error?: ResponseError;
|
|
12356
|
+
Organization?: OrganizationRead;
|
|
12357
|
+
Space?: SpaceRead;
|
|
12358
|
+
StartTag?: TagRead;
|
|
12359
|
+
};
|
|
12360
|
+
type ChangeSetCreateOrUpdateResponse = {
|
|
12361
|
+
ChangeSet?: ChangeSet;
|
|
12362
|
+
Error?: ResponseError;
|
|
12363
|
+
};
|
|
12364
|
+
type ChangeSetCreateOrUpdateResponseRead = {
|
|
12365
|
+
ChangeSet?: ChangeSetRead;
|
|
12366
|
+
Error?: ResponseError;
|
|
12367
|
+
};
|
|
12206
12368
|
type ExtendedFilter = {
|
|
12207
12369
|
Error?: ResponseError;
|
|
12208
12370
|
Filter?: Filter;
|
|
@@ -12343,38 +12505,6 @@ type FunctionInvocationsResponse = {
|
|
|
12343
12505
|
/** Slug of the Unit */
|
|
12344
12506
|
UnitSlug?: string;
|
|
12345
12507
|
};
|
|
12346
|
-
type FunctionArgument = {
|
|
12347
|
-
Evaluator?: string;
|
|
12348
|
-
ParameterName?: string;
|
|
12349
|
-
Value?: string | number | boolean;
|
|
12350
|
-
};
|
|
12351
|
-
type ClearanceRequirement = {
|
|
12352
|
-
/** The guard key this requirement is about */
|
|
12353
|
-
Key?: string;
|
|
12354
|
-
/** Exists, In, NotIn, or DoesNotExist */
|
|
12355
|
-
Operator?: string;
|
|
12356
|
-
/** The values In and NotIn compare against; unused by Exists and DoesNotExist */
|
|
12357
|
-
Values?: string[];
|
|
12358
|
-
};
|
|
12359
|
-
type Clearance = ClearanceRequirement[];
|
|
12360
|
-
type GuardStamp = {
|
|
12361
|
-
[key: string]: string;
|
|
12362
|
-
};
|
|
12363
|
-
type FunctionInvocation = {
|
|
12364
|
-
/** Function arguments */
|
|
12365
|
-
Arguments?: FunctionArgument[] | null;
|
|
12366
|
-
Clearance?: Clearance;
|
|
12367
|
-
/** Function name */
|
|
12368
|
-
FunctionName?: string;
|
|
12369
|
-
Guards?: GuardStamp;
|
|
12370
|
-
/** Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
12371
|
-
Params?: {
|
|
12372
|
-
[key: string]: any;
|
|
12373
|
-
};
|
|
12374
|
-
/** Per-invocation resource filter. AND-combined with the request-level WhereResource. Same path syntax as the request-level field (see ParseAndValidateWhereResource). */
|
|
12375
|
-
WhereResource?: string;
|
|
12376
|
-
};
|
|
12377
|
-
type FunctionInvocationList = FunctionInvocation[] | null;
|
|
12378
12508
|
type ParameterizedInvocationRef = {
|
|
12379
12509
|
InvocationID?: string;
|
|
12380
12510
|
Parameters?: {
|
|
@@ -12400,7 +12530,10 @@ type FunctionInvocationsRequest = {
|
|
|
12400
12530
|
ToolchainType?: string;
|
|
12401
12531
|
/** 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. */
|
|
12402
12532
|
Triggers?: Uuid[];
|
|
12533
|
+
/** Deprecated: use UpdateValidationResults, which this means the same thing as. Setting either has the same effect. */
|
|
12403
12534
|
UpdateApplyGates?: boolean;
|
|
12535
|
+
/** 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. */
|
|
12536
|
+
UpdateValidationResults?: boolean;
|
|
12404
12537
|
/** WhereResource restricts which resources functions operate on using ConfigHub metadata path expressions (ConfigHub.ResourceName, ConfigHub.ResourceNameWithoutScope, ConfigHub.ResourceType, ConfigHub.ResourceCategory). */
|
|
12405
12538
|
WhereResource?: string;
|
|
12406
12539
|
};
|
|
@@ -12428,84 +12561,6 @@ type ApiInfoRead = {
|
|
|
12428
12561
|
/** Deprecated and always empty. Workers connect over long polling on the main API port; there is no separate worker port. */
|
|
12429
12562
|
WorkerPort?: string;
|
|
12430
12563
|
};
|
|
12431
|
-
type Invocation = {
|
|
12432
|
-
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12433
|
-
Annotations?: {
|
|
12434
|
-
[key: string]: string;
|
|
12435
|
-
};
|
|
12436
|
-
/** Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If unspecified, use the builtin function executor. */
|
|
12437
|
-
BridgeWorkerID?: string;
|
|
12438
|
-
/** An optional set of gates that, if any is present, will block deletion. */
|
|
12439
|
-
DeleteGates?: {
|
|
12440
|
-
[key: string]: boolean;
|
|
12441
|
-
};
|
|
12442
|
-
/** Friendly name for the entity. */
|
|
12443
|
-
DisplayName?: string;
|
|
12444
|
-
FunctionInvocations: FunctionInvocationList;
|
|
12445
|
-
/** InvocationID uniquely identifies a invocation within the system. */
|
|
12446
|
-
InvocationID?: string;
|
|
12447
|
-
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12448
|
-
Labels?: {
|
|
12449
|
-
[key: string]: string;
|
|
12450
|
-
};
|
|
12451
|
-
/** Unique identifier for an organization. */
|
|
12452
|
-
OrganizationID?: string;
|
|
12453
|
-
Parameters?: FunctionParameter[];
|
|
12454
|
-
/** Unique URL-safe identifier for the entity. */
|
|
12455
|
-
Slug: string;
|
|
12456
|
-
/** Unique identifier for a space. */
|
|
12457
|
-
SpaceID?: string;
|
|
12458
|
-
/** ToolchainType specifies the type of toolchain this invocation works with.
|
|
12459
|
-
This determines which configuration formats the invocation can process. */
|
|
12460
|
-
ToolchainType: string;
|
|
12461
|
-
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12462
|
-
Version?: number;
|
|
12463
|
-
};
|
|
12464
|
-
type InvocationRead = {
|
|
12465
|
-
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
12466
|
-
Annotations?: {
|
|
12467
|
-
[key: string]: string;
|
|
12468
|
-
};
|
|
12469
|
-
/** Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If unspecified, use the builtin function executor. */
|
|
12470
|
-
BridgeWorkerID?: string;
|
|
12471
|
-
/** The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. */
|
|
12472
|
-
CreatedAt?: string;
|
|
12473
|
-
/** An auto-incrementing sequence number used for pagination. */
|
|
12474
|
-
CursorID?: number;
|
|
12475
|
-
/** An optional set of gates that, if any is present, will block deletion. */
|
|
12476
|
-
DeleteGates?: {
|
|
12477
|
-
[key: string]: boolean;
|
|
12478
|
-
};
|
|
12479
|
-
/** Friendly name for the entity. */
|
|
12480
|
-
DisplayName?: string;
|
|
12481
|
-
/** The type of entity. */
|
|
12482
|
-
EntityType?: string;
|
|
12483
|
-
FunctionInvocations: FunctionInvocationList;
|
|
12484
|
-
/** SHA256 hash of the functions and their arguments encoded as hexadecimal. */
|
|
12485
|
-
Hash?: string;
|
|
12486
|
-
/** InvocationID uniquely identifies a invocation within the system. */
|
|
12487
|
-
InvocationID?: string;
|
|
12488
|
-
/** An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
12489
|
-
Labels?: {
|
|
12490
|
-
[key: string]: string;
|
|
12491
|
-
};
|
|
12492
|
-
/** Unique identifier for an organization. */
|
|
12493
|
-
OrganizationID?: string;
|
|
12494
|
-
Parameters?: FunctionParameter[];
|
|
12495
|
-
/** Unique URL-safe identifier for the entity. */
|
|
12496
|
-
Slug: string;
|
|
12497
|
-
/** Unique identifier for a space. */
|
|
12498
|
-
SpaceID?: string;
|
|
12499
|
-
/** Slug of the Space this entity belongs to. (readonly) */
|
|
12500
|
-
SpaceSlug?: string;
|
|
12501
|
-
/** ToolchainType specifies the type of toolchain this invocation works with.
|
|
12502
|
-
This determines which configuration formats the invocation can process. */
|
|
12503
|
-
ToolchainType: string;
|
|
12504
|
-
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|
|
12505
|
-
UpdatedAt?: string;
|
|
12506
|
-
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12507
|
-
Version?: number;
|
|
12508
|
-
};
|
|
12509
12564
|
type ExtendedInvocation = {
|
|
12510
12565
|
BridgeWorker?: BridgeWorker;
|
|
12511
12566
|
Error?: ResponseError;
|
|
@@ -12674,11 +12729,11 @@ type UnitRead = {
|
|
|
12674
12729
|
Annotations?: {
|
|
12675
12730
|
[key: string]: string;
|
|
12676
12731
|
};
|
|
12677
|
-
/**
|
|
12732
|
+
/** Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */
|
|
12678
12733
|
ApplyGates?: {
|
|
12679
12734
|
[key: string]: boolean;
|
|
12680
12735
|
};
|
|
12681
|
-
/**
|
|
12736
|
+
/** Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */
|
|
12682
12737
|
ApplyWarnings?: {
|
|
12683
12738
|
[key: string]: boolean;
|
|
12684
12739
|
};
|
|
@@ -12713,6 +12768,8 @@ type UnitRead = {
|
|
|
12713
12768
|
FromLinkID?: Uuid[];
|
|
12714
12769
|
/** Sequence number the head Mutation. */
|
|
12715
12770
|
HeadMutationNum?: number;
|
|
12771
|
+
/** Unique identifier of the head Revision -- the same Revision HeadRevisionNum numbers. Use include=HeadRevisionNum to expand it. */
|
|
12772
|
+
HeadRevisionID?: string;
|
|
12716
12773
|
/** Sequence number the head Revision. */
|
|
12717
12774
|
HeadRevisionNum?: number;
|
|
12718
12775
|
/** Sequence number of the head unit action (queued operation). */
|
|
@@ -12760,10 +12817,18 @@ type UnitRead = {
|
|
|
12760
12817
|
UpstreamSpaceID?: string;
|
|
12761
12818
|
/** Unique identifier for Unit this unit was cloned from, if any. To change or remove the upstream unit, change or delete the corresponding Link of UpdateType UpgradeUnit from this Unit to the upstream Unit. */
|
|
12762
12819
|
UpstreamUnitID?: string;
|
|
12820
|
+
/** 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. */
|
|
12821
|
+
ValidationErrors?: {
|
|
12822
|
+
[key: string]: boolean;
|
|
12823
|
+
};
|
|
12763
12824
|
/** A map from gate/warning name to the list of validation results that caused the gate or warning. */
|
|
12764
12825
|
ValidationResults?: {
|
|
12765
12826
|
[key: string]: ValidationResultList;
|
|
12766
12827
|
};
|
|
12828
|
+
/** 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. */
|
|
12829
|
+
ValidationWarnings?: {
|
|
12830
|
+
[key: string]: boolean;
|
|
12831
|
+
};
|
|
12767
12832
|
/** Map from "<trigger slug>/<attribute name>" to the first output Value with that attribute name of the function invocation specified by the Trigger. */
|
|
12768
12833
|
Values?: {
|
|
12769
12834
|
[key: string]: string;
|
|
@@ -13514,14 +13579,6 @@ type ExtendedResourceRead = {
|
|
|
13514
13579
|
ViewColumns?: ViewColumn[];
|
|
13515
13580
|
};
|
|
13516
13581
|
type Revision = {
|
|
13517
|
-
/** 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 Apply operations. */
|
|
13518
|
-
ApplyGates?: {
|
|
13519
|
-
[key: string]: boolean;
|
|
13520
|
-
};
|
|
13521
|
-
/** 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 Apply operations. */
|
|
13522
|
-
ApplyWarnings?: {
|
|
13523
|
-
[key: string]: boolean;
|
|
13524
|
-
};
|
|
13525
13582
|
/** the users that have approved the latest version of the config data for the Unit. */
|
|
13526
13583
|
ApprovedBy?: Uuid[];
|
|
13527
13584
|
/** Unique identifier for the ChangeSet to which this Revision belongs. Optional. Revisions are not required to belong to ChangeSets. */
|
|
@@ -13531,9 +13588,13 @@ type Revision = {
|
|
|
13531
13588
|
DataHash?: string;
|
|
13532
13589
|
/** User description of the change. It is copied from the LastChangeDescription field of the Unit at the time the change was made that created the Revision. */
|
|
13533
13590
|
Description?: string;
|
|
13591
|
+
/** Attribute paths this Revision's configuration needs from upstream Units via NeedsProvides Links. */
|
|
13592
|
+
NeededPaths?: AttributeValue[];
|
|
13534
13593
|
/** Unique identifier for an Organization. */
|
|
13535
13594
|
OrganizationID?: string;
|
|
13536
13595
|
PathAnnotations?: PathAnnotationList;
|
|
13596
|
+
/** Attribute paths this Revision's configuration provides to downstream Units via NeedsProvides Links. */
|
|
13597
|
+
ProvidedPaths?: AttributeInfo[];
|
|
13537
13598
|
/** A set (map) of ReleaseIDs of any Releases that have bundled this Revision. The string values have no particular meaning for now. */
|
|
13538
13599
|
Releases?: {
|
|
13539
13600
|
[key: string]: string;
|
|
@@ -13556,15 +13617,35 @@ type Revision = {
|
|
|
13556
13617
|
UserAgent?: string;
|
|
13557
13618
|
/** UserID if change was made by a user. Automated changes, such as by triggers and resolve, are currently made with the UserID "00000000-0000-0000-0000-000000000000". */
|
|
13558
13619
|
UserID?: string;
|
|
13620
|
+
/** 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. */
|
|
13621
|
+
ValidationErrors?: {
|
|
13622
|
+
[key: string]: boolean;
|
|
13623
|
+
};
|
|
13624
|
+
/** 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. */
|
|
13625
|
+
ValidationPassed?: {
|
|
13626
|
+
[key: string]: boolean;
|
|
13627
|
+
};
|
|
13628
|
+
/** A map from gate/warning name to the validation results that caused it, for the configuration data at this Revision. */
|
|
13629
|
+
ValidationResults?: {
|
|
13630
|
+
[key: string]: ValidationResultList;
|
|
13631
|
+
};
|
|
13632
|
+
/** 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. */
|
|
13633
|
+
ValidationWarnings?: {
|
|
13634
|
+
[key: string]: boolean;
|
|
13635
|
+
};
|
|
13636
|
+
/** 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. */
|
|
13637
|
+
Values?: {
|
|
13638
|
+
[key: string]: string;
|
|
13639
|
+
};
|
|
13559
13640
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
13560
13641
|
Version?: number;
|
|
13561
13642
|
};
|
|
13562
13643
|
type RevisionRead = {
|
|
13563
|
-
/**
|
|
13644
|
+
/** Deprecated: use ValidationErrors, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */
|
|
13564
13645
|
ApplyGates?: {
|
|
13565
13646
|
[key: string]: boolean;
|
|
13566
13647
|
};
|
|
13567
|
-
/**
|
|
13648
|
+
/** Deprecated: use ValidationWarnings, which this is a copy of. Returned for compatibility with clients written before the field was renamed; it cannot be set. */
|
|
13568
13649
|
ApplyWarnings?: {
|
|
13569
13650
|
[key: string]: boolean;
|
|
13570
13651
|
};
|
|
@@ -13588,9 +13669,13 @@ type RevisionRead = {
|
|
|
13588
13669
|
Description?: string;
|
|
13589
13670
|
/** The type of entity. */
|
|
13590
13671
|
EntityType?: string;
|
|
13672
|
+
/** Attribute paths this Revision's configuration needs from upstream Units via NeedsProvides Links. */
|
|
13673
|
+
NeededPaths?: AttributeValue[];
|
|
13591
13674
|
/** Unique identifier for an Organization. */
|
|
13592
13675
|
OrganizationID?: string;
|
|
13593
13676
|
PathAnnotations?: PathAnnotationList;
|
|
13677
|
+
/** Attribute paths this Revision's configuration provides to downstream Units via NeedsProvides Links. */
|
|
13678
|
+
ProvidedPaths?: AttributeInfo[];
|
|
13594
13679
|
/** A set (map) of ReleaseIDs of any Releases that have bundled this Revision. The string values have no particular meaning for now. */
|
|
13595
13680
|
Releases?: {
|
|
13596
13681
|
[key: string]: string;
|
|
@@ -13619,6 +13704,26 @@ type RevisionRead = {
|
|
|
13619
13704
|
UserAgent?: string;
|
|
13620
13705
|
/** UserID if change was made by a user. Automated changes, such as by triggers and resolve, are currently made with the UserID "00000000-0000-0000-0000-000000000000". */
|
|
13621
13706
|
UserID?: string;
|
|
13707
|
+
/** 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. */
|
|
13708
|
+
ValidationErrors?: {
|
|
13709
|
+
[key: string]: boolean;
|
|
13710
|
+
};
|
|
13711
|
+
/** 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. */
|
|
13712
|
+
ValidationPassed?: {
|
|
13713
|
+
[key: string]: boolean;
|
|
13714
|
+
};
|
|
13715
|
+
/** A map from gate/warning name to the validation results that caused it, for the configuration data at this Revision. */
|
|
13716
|
+
ValidationResults?: {
|
|
13717
|
+
[key: string]: ValidationResultList;
|
|
13718
|
+
};
|
|
13719
|
+
/** 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. */
|
|
13720
|
+
ValidationWarnings?: {
|
|
13721
|
+
[key: string]: boolean;
|
|
13722
|
+
};
|
|
13723
|
+
/** 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. */
|
|
13724
|
+
Values?: {
|
|
13725
|
+
[key: string]: string;
|
|
13726
|
+
};
|
|
13622
13727
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
13623
13728
|
Version?: number;
|
|
13624
13729
|
};
|
|
@@ -13768,7 +13873,7 @@ type Trigger = {
|
|
|
13768
13873
|
UnitFilterID?: string;
|
|
13769
13874
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
13770
13875
|
Version?: number;
|
|
13771
|
-
/** Warn indicates whether this trigger produces
|
|
13876
|
+
/** Warn indicates whether this trigger produces ValidationWarnings instead of ValidationErrors when its validating function fails. ValidationWarnings are non-blocking. */
|
|
13772
13877
|
Warn?: boolean;
|
|
13773
13878
|
/** Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions. */
|
|
13774
13879
|
WhereResource?: string;
|
|
@@ -13849,7 +13954,7 @@ type TriggerRead = {
|
|
|
13849
13954
|
Validating?: boolean;
|
|
13850
13955
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
13851
13956
|
Version?: number;
|
|
13852
|
-
/** Warn indicates whether this trigger produces
|
|
13957
|
+
/** Warn indicates whether this trigger produces ValidationWarnings instead of ValidationErrors when its validating function fails. ValidationWarnings are non-blocking. */
|
|
13853
13958
|
Warn?: boolean;
|
|
13854
13959
|
/** Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions. */
|
|
13855
13960
|
WhereResource?: string;
|