@confighub/rtk-query 0.4.17 → 0.4.18
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 +10 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +111 -16
- package/dist/index.d.ts +111 -16
- package/dist/index.js +10 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1360,7 +1360,7 @@ type BulkDeleteChangeOrdersApiArg = {
|
|
|
1360
1360
|
An example conjunction is:
|
|
1361
1361
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1362
1362
|
|
|
1363
|
-
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
1363
|
+
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
1364
1364
|
|
|
1365
1365
|
The whole string must be query-encoded. */
|
|
1366
1366
|
where?: string;
|
|
@@ -1396,7 +1396,7 @@ type BulkDeleteChangeOrdersApiArg = {
|
|
|
1396
1396
|
The attribute names are case-sensitive, PascalCase, and
|
|
1397
1397
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1398
1398
|
|
|
1399
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1399
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
1400
1400
|
|
|
1401
1401
|
The whole string must be query-encoded. */
|
|
1402
1402
|
include?: string;
|
|
@@ -1438,7 +1438,7 @@ type ListAllChangeOrdersApiArg = {
|
|
|
1438
1438
|
An example conjunction is:
|
|
1439
1439
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1440
1440
|
|
|
1441
|
-
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
1441
|
+
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
1442
1442
|
|
|
1443
1443
|
The whole string must be query-encoded. */
|
|
1444
1444
|
where?: string;
|
|
@@ -1474,7 +1474,7 @@ type ListAllChangeOrdersApiArg = {
|
|
|
1474
1474
|
The attribute names are case-sensitive, PascalCase, and
|
|
1475
1475
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1476
1476
|
|
|
1477
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1477
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
1478
1478
|
|
|
1479
1479
|
The whole string must be query-encoded. */
|
|
1480
1480
|
include?: string;
|
|
@@ -1524,7 +1524,7 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1524
1524
|
An example conjunction is:
|
|
1525
1525
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1526
1526
|
|
|
1527
|
-
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
1527
|
+
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
1528
1528
|
|
|
1529
1529
|
The whole string must be query-encoded. */
|
|
1530
1530
|
where?: string;
|
|
@@ -1560,10 +1560,12 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1560
1560
|
The attribute names are case-sensitive, PascalCase, and
|
|
1561
1561
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1562
1562
|
|
|
1563
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1563
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
1564
1564
|
|
|
1565
1565
|
The whole string must be query-encoded. */
|
|
1566
1566
|
include?: string;
|
|
1567
|
+
/** If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */
|
|
1568
|
+
refreshSpaces?: boolean;
|
|
1567
1569
|
body: {
|
|
1568
1570
|
AbortedReason?: string | null;
|
|
1569
1571
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -1588,10 +1590,12 @@ type BulkPatchChangeOrdersApiArg = {
|
|
|
1588
1590
|
Parameters?: object | null;
|
|
1589
1591
|
/** Unique URL-safe identifier for the entity. */
|
|
1590
1592
|
Slug?: string | null;
|
|
1593
|
+
SpaceFilterID?: string | null;
|
|
1591
1594
|
UnitFilterID?: string | null;
|
|
1592
1595
|
UpdateType?: string | null;
|
|
1593
1596
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
1594
1597
|
Version?: number | null;
|
|
1598
|
+
WhereSpace?: string | null;
|
|
1595
1599
|
WhereUnit?: string | null;
|
|
1596
1600
|
};
|
|
1597
1601
|
};
|
|
@@ -1631,7 +1635,7 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1631
1635
|
An example conjunction is:
|
|
1632
1636
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
1633
1637
|
|
|
1634
|
-
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
1638
|
+
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
1635
1639
|
|
|
1636
1640
|
The whole string must be query-encoded. */
|
|
1637
1641
|
where?: string;
|
|
@@ -1667,7 +1671,7 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1667
1671
|
The attribute names are case-sensitive, PascalCase, and
|
|
1668
1672
|
expected in a comma-separated list format as in the JSON encoding.
|
|
1669
1673
|
|
|
1670
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
1674
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
1671
1675
|
|
|
1672
1676
|
The whole string must be query-encoded. */
|
|
1673
1677
|
include?: string;
|
|
@@ -1755,10 +1759,12 @@ type BulkCreateChangeOrdersApiArg = {
|
|
|
1755
1759
|
Parameters?: object | null;
|
|
1756
1760
|
/** Unique URL-safe identifier for the entity. */
|
|
1757
1761
|
Slug?: string | null;
|
|
1762
|
+
SpaceFilterID?: string | null;
|
|
1758
1763
|
UnitFilterID?: string | null;
|
|
1759
1764
|
UpdateType?: string | null;
|
|
1760
1765
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
1761
1766
|
Version?: number | null;
|
|
1767
|
+
WhereSpace?: string | null;
|
|
1762
1768
|
WhereUnit?: string | null;
|
|
1763
1769
|
};
|
|
1764
1770
|
};
|
|
@@ -4386,7 +4392,7 @@ type ListAllReleasesApiArg = {
|
|
|
4386
4392
|
An example conjunction is:
|
|
4387
4393
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4388
4394
|
|
|
4389
|
-
Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, UnitCount, UpdatedAt.
|
|
4395
|
+
Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt.
|
|
4390
4396
|
|
|
4391
4397
|
The whole string must be query-encoded. */
|
|
4392
4398
|
where?: string;
|
|
@@ -5502,7 +5508,7 @@ type ListChangeOrdersApiArg = {
|
|
|
5502
5508
|
An example conjunction is:
|
|
5503
5509
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
5504
5510
|
|
|
5505
|
-
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereUnit.
|
|
5511
|
+
Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
5506
5512
|
|
|
5507
5513
|
The whole string must be query-encoded. */
|
|
5508
5514
|
where?: string;
|
|
@@ -5538,7 +5544,7 @@ type ListChangeOrdersApiArg = {
|
|
|
5538
5544
|
The attribute names are case-sensitive, PascalCase, and
|
|
5539
5545
|
expected in a comma-separated list format as in the JSON encoding.
|
|
5540
5546
|
|
|
5541
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
5547
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
5542
5548
|
|
|
5543
5549
|
The whole string must be query-encoded. */
|
|
5544
5550
|
include?: string;
|
|
@@ -5578,7 +5584,7 @@ type GetChangeOrderApiArg = {
|
|
|
5578
5584
|
The attribute names are case-sensitive, PascalCase, and
|
|
5579
5585
|
expected in a comma-separated list format as in the JSON encoding.
|
|
5580
5586
|
|
|
5581
|
-
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceID, StartTagID, UnitFilterID.
|
|
5587
|
+
Supported attributes for ChangeOrder are EndTagID, InvocationID, OrganizationID, RestoreTagID, SpaceFilterID, SpaceID, StartTagID, UnitFilterID.
|
|
5582
5588
|
|
|
5583
5589
|
The whole string must be query-encoded. */
|
|
5584
5590
|
include?: string;
|
|
@@ -5601,6 +5607,8 @@ type PatchChangeOrderApiArg = {
|
|
|
5601
5607
|
spaceId: string;
|
|
5602
5608
|
/** Unique identifier for a change_order_id */
|
|
5603
5609
|
changeOrderId: string;
|
|
5610
|
+
/** If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */
|
|
5611
|
+
refreshSpaces?: boolean;
|
|
5604
5612
|
body: {
|
|
5605
5613
|
AbortedReason?: string | null;
|
|
5606
5614
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -5625,10 +5633,12 @@ type PatchChangeOrderApiArg = {
|
|
|
5625
5633
|
Parameters?: object | null;
|
|
5626
5634
|
/** Unique URL-safe identifier for the entity. */
|
|
5627
5635
|
Slug?: string | null;
|
|
5636
|
+
SpaceFilterID?: string | null;
|
|
5628
5637
|
UnitFilterID?: string | null;
|
|
5629
5638
|
UpdateType?: string | null;
|
|
5630
5639
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
5631
5640
|
Version?: number | null;
|
|
5641
|
+
WhereSpace?: string | null;
|
|
5632
5642
|
WhereUnit?: string | null;
|
|
5633
5643
|
};
|
|
5634
5644
|
};
|
|
@@ -5639,6 +5649,8 @@ type UpdateChangeOrderApiArg = {
|
|
|
5639
5649
|
spaceId: string;
|
|
5640
5650
|
/** Unique identifier for a change_order_id */
|
|
5641
5651
|
changeOrderId: string;
|
|
5652
|
+
/** If true, re-evaluate WhereSpace and/or SpaceFilterID into InScopeSpaceIDs, and re-derive what the ChangeOrder covers if the Spaces they select have changed, even if neither field has changed. Has no effect on a ChangeOrder with neither set. */
|
|
5653
|
+
refreshSpaces?: boolean;
|
|
5642
5654
|
changeOrder: ChangeOrder;
|
|
5643
5655
|
};
|
|
5644
5656
|
type ListChangeSetsApiResponse =
|
|
@@ -6717,7 +6729,7 @@ type ListExtendedReleasesApiArg = {
|
|
|
6717
6729
|
An example conjunction is:
|
|
6718
6730
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6719
6731
|
|
|
6720
|
-
Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, UnitCount, UpdatedAt.
|
|
6732
|
+
Supported attributes for filtering on Release: Annotations, CreatedAt, DeleteGates, Digest, Labels, ManifestDigest, OrganizationID, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt.
|
|
6721
6733
|
|
|
6722
6734
|
The whole string must be query-encoded. */
|
|
6723
6735
|
where?: string;
|
|
@@ -12523,7 +12535,7 @@ type ChangeOrder = {
|
|
|
12523
12535
|
DisplayName?: string;
|
|
12524
12536
|
/** 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. */
|
|
12525
12537
|
EndTagID?: string;
|
|
12526
|
-
/** InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into,
|
|
12538
|
+
/** InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into, recorded as a list rather than asked again on each read. When WhereSpace or SpaceFilterID is set, the server writes it from that selection, and a write naming a different list is refused; otherwise the client supplies it. 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. Changing it re-derives what the ChangeOrder covers. */
|
|
12527
12539
|
InScopeSpaceIDs?: Uuid[];
|
|
12528
12540
|
/** 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. */
|
|
12529
12541
|
InvocationID?: string;
|
|
@@ -12539,6 +12551,8 @@ type ChangeOrder = {
|
|
|
12539
12551
|
};
|
|
12540
12552
|
/** Unique URL-safe identifier for the entity. */
|
|
12541
12553
|
Slug: string;
|
|
12554
|
+
/** SpaceFilterID references a Filter (with From=Space) selecting where the ChangeOrder is headed, ANDed with WhereSpace when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs. */
|
|
12555
|
+
SpaceFilterID?: string;
|
|
12542
12556
|
/** Unique identifier for a space. */
|
|
12543
12557
|
SpaceID?: string;
|
|
12544
12558
|
/** UnitFilterID references a Filter (with From=Unit) narrowing the same selection as WhereUnit, conjoined with it. Refused on the other UpdateTypes. Immutable. */
|
|
@@ -12547,6 +12561,44 @@ type ChangeOrder = {
|
|
|
12547
12561
|
UpdateType?: string;
|
|
12548
12562
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12549
12563
|
Version?: number;
|
|
12564
|
+
/** Filter expression selecting where the ChangeOrder is headed, ANDed with SpaceFilterID when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs when the ChangeOrder is created, when either field changes, and on an update or patch with refresh_spaces. The specified string is an expression for the purpose of filtering
|
|
12565
|
+
the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
12566
|
+
It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
12567
|
+
*operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
12568
|
+
as in the JSON encoding.
|
|
12569
|
+
Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
12570
|
+
String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
12571
|
+
`ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
12572
|
+
String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
12573
|
+
`!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
12574
|
+
Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
12575
|
+
UUIDs and boolean attributes support equality and inequality only.
|
|
12576
|
+
UUID and time literals must be quoted as string literals.
|
|
12577
|
+
String literals are quoted with single quotes, such as `'string'`.
|
|
12578
|
+
Time literals use the same form as when serialized as JSON,
|
|
12579
|
+
such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
12580
|
+
Integer and boolean literals are also supported for attributes of those types.
|
|
12581
|
+
Arrays support the `?` operator to to match any element of the array,
|
|
12582
|
+
as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
12583
|
+
Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
12584
|
+
An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
12585
|
+
as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
12586
|
+
Without the `*` such a reference is an error, since it names no single value to compare.
|
|
12587
|
+
Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
12588
|
+
Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
12589
|
+
as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
12590
|
+
Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
12591
|
+
These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
12592
|
+
The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
12593
|
+
such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
12594
|
+
Conjunctions are supported using the `AND` operator.
|
|
12595
|
+
An example conjunction is:
|
|
12596
|
+
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12597
|
+
|
|
12598
|
+
Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Permissions, ReleaseBridgeWorkerID, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt.
|
|
12599
|
+
|
|
12600
|
+
The whole string must be query-encoded. */
|
|
12601
|
+
WhereSpace?: string;
|
|
12550
12602
|
/** 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. */
|
|
12551
12603
|
WhereUnit?: string;
|
|
12552
12604
|
};
|
|
@@ -12585,7 +12637,7 @@ type ChangeOrderRead = {
|
|
|
12585
12637
|
EndTagID?: string;
|
|
12586
12638
|
/** The type of entity. */
|
|
12587
12639
|
EntityType?: string;
|
|
12588
|
-
/** InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into,
|
|
12640
|
+
/** InScopeSpaceIDs is where the ChangeOrder is headed: the Spaces it propagates into, recorded as a list rather than asked again on each read. When WhereSpace or SpaceFilterID is set, the server writes it from that selection, and a write naming a different list is refused; otherwise the client supplies it. 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. Changing it re-derives what the ChangeOrder covers. */
|
|
12589
12641
|
InScopeSpaceIDs?: Uuid[];
|
|
12590
12642
|
/** 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. */
|
|
12591
12643
|
InvocationID?: string;
|
|
@@ -12616,6 +12668,8 @@ type ChangeOrderRead = {
|
|
|
12616
12668
|
};
|
|
12617
12669
|
/** Unique URL-safe identifier for the entity. */
|
|
12618
12670
|
Slug: string;
|
|
12671
|
+
/** SpaceFilterID references a Filter (with From=Space) selecting where the ChangeOrder is headed, ANDed with WhereSpace when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs. */
|
|
12672
|
+
SpaceFilterID?: string;
|
|
12619
12673
|
/** Unique identifier for a space. */
|
|
12620
12674
|
SpaceID?: string;
|
|
12621
12675
|
/** Slug of the Space this entity belongs to. (readonly) */
|
|
@@ -12632,6 +12686,44 @@ type ChangeOrderRead = {
|
|
|
12632
12686
|
UpdatedAt?: string;
|
|
12633
12687
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
12634
12688
|
Version?: number;
|
|
12689
|
+
/** Filter expression selecting where the ChangeOrder is headed, ANDed with SpaceFilterID when both are set. While either is set, the server evaluates the selection into InScopeSpaceIDs when the ChangeOrder is created, when either field changes, and on an update or patch with refresh_spaces. The specified string is an expression for the purpose of filtering
|
|
12690
|
+
the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
12691
|
+
It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
12692
|
+
*operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
12693
|
+
as in the JSON encoding.
|
|
12694
|
+
Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
12695
|
+
String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
12696
|
+
`ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
12697
|
+
String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
12698
|
+
`!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
12699
|
+
Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
12700
|
+
UUIDs and boolean attributes support equality and inequality only.
|
|
12701
|
+
UUID and time literals must be quoted as string literals.
|
|
12702
|
+
String literals are quoted with single quotes, such as `'string'`.
|
|
12703
|
+
Time literals use the same form as when serialized as JSON,
|
|
12704
|
+
such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
12705
|
+
Integer and boolean literals are also supported for attributes of those types.
|
|
12706
|
+
Arrays support the `?` operator to to match any element of the array,
|
|
12707
|
+
as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
12708
|
+
Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
12709
|
+
An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
12710
|
+
as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
12711
|
+
Without the `*` such a reference is an error, since it names no single value to compare.
|
|
12712
|
+
Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
12713
|
+
Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
12714
|
+
as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
12715
|
+
Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
12716
|
+
These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
12717
|
+
The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
12718
|
+
such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
12719
|
+
Conjunctions are supported using the `AND` operator.
|
|
12720
|
+
An example conjunction is:
|
|
12721
|
+
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12722
|
+
|
|
12723
|
+
Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Permissions, ReleaseBridgeWorkerID, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt.
|
|
12724
|
+
|
|
12725
|
+
The whole string must be query-encoded. */
|
|
12726
|
+
WhereSpace?: string;
|
|
12635
12727
|
/** 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. */
|
|
12636
12728
|
WhereUnit?: string;
|
|
12637
12729
|
};
|
|
@@ -12897,6 +12989,7 @@ type ExtendedChangeOrder = {
|
|
|
12897
12989
|
Organization?: Organization;
|
|
12898
12990
|
RestoreTag?: Tag;
|
|
12899
12991
|
Space?: Space;
|
|
12992
|
+
SpaceFilter?: Filter;
|
|
12900
12993
|
StartTag?: Tag;
|
|
12901
12994
|
UnitFilter?: Filter;
|
|
12902
12995
|
};
|
|
@@ -12908,6 +13001,7 @@ type ExtendedChangeOrderRead = {
|
|
|
12908
13001
|
Organization?: OrganizationRead;
|
|
12909
13002
|
RestoreTag?: TagRead;
|
|
12910
13003
|
Space?: SpaceRead;
|
|
13004
|
+
SpaceFilter?: FilterRead;
|
|
12911
13005
|
StartTag?: TagRead;
|
|
12912
13006
|
UnitFilter?: FilterRead;
|
|
12913
13007
|
};
|
|
@@ -13879,7 +13973,7 @@ type PromoteSpaceResult = {
|
|
|
13879
13973
|
type PromoteGateResult = {
|
|
13880
13974
|
/** Why the gate does not hold. */
|
|
13881
13975
|
Message?: string;
|
|
13882
|
-
/** Promoted, Released, Healthy, or a custom prerequisite's name. */
|
|
13976
|
+
/** Promoted, Validated, Released, Healthy, or a custom prerequisite's name. */
|
|
13883
13977
|
Prerequisite?: string;
|
|
13884
13978
|
Satisfied?: boolean;
|
|
13885
13979
|
SpaceID?: string;
|
|
@@ -13987,6 +14081,7 @@ type ReleaseRead = {
|
|
|
13987
14081
|
SpaceSlug?: string;
|
|
13988
14082
|
/** Tag identifying the bundled Revision of each Unit in the Release. When publishing supplied a TagID, this is that Tag. Otherwise publishing creates a Tag named release-<ReleaseNum> in the Release's Space, applies it to each bundled Revision, and sets it here. */
|
|
13989
14083
|
TagID?: string;
|
|
14084
|
+
TargetID?: string;
|
|
13990
14085
|
/** Number of Units bundled in the Release, captured at publish time. */
|
|
13991
14086
|
UnitCount?: number;
|
|
13992
14087
|
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|