@confighub/rtk-query 0.1.2 → 0.1.3
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.map +1 -1
- package/dist/index.d.cts +67 -81
- package/dist/index.d.ts +67 -81
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2653,7 +2653,7 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
2653
2653
|
changeSetId?: string;
|
|
2654
2654
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
2655
2655
|
subgroup?: string;
|
|
2656
|
-
/** Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers:
|
|
2656
|
+
/** 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. */
|
|
2657
2657
|
otherDataSource?: string;
|
|
2658
2658
|
/** The specified string is an expression for the purpose of filtering
|
|
2659
2659
|
the list of Units returned. The expression syntax was inspired by SQL.
|
|
@@ -2689,9 +2689,9 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
2689
2689
|
An example conjunction is:
|
|
2690
2690
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
2691
2691
|
|
|
2692
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
2692
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
2693
2693
|
|
|
2694
|
-
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 `
|
|
2694
|
+
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`.
|
|
2695
2695
|
|
|
2696
2696
|
The whole string must be query-encoded. */
|
|
2697
2697
|
where?: string;
|
|
@@ -4105,7 +4105,7 @@ type ListAllRevisionsApiArg = {
|
|
|
4105
4105
|
An example conjunction is:
|
|
4106
4106
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4107
4107
|
|
|
4108
|
-
Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4108
|
+
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.
|
|
4109
4109
|
|
|
4110
4110
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4111
4111
|
|
|
@@ -4164,7 +4164,7 @@ type ListAllRevisionsApiArg = {
|
|
|
4164
4164
|
|
|
4165
4165
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4166
4166
|
|
|
4167
|
-
Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4167
|
+
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.
|
|
4168
4168
|
|
|
4169
4169
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4170
4170
|
|
|
@@ -4217,7 +4217,7 @@ type SearchRevisionDataApiArg = {
|
|
|
4217
4217
|
An example conjunction is:
|
|
4218
4218
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4219
4219
|
|
|
4220
|
-
Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4220
|
+
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.
|
|
4221
4221
|
|
|
4222
4222
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4223
4223
|
|
|
@@ -4276,7 +4276,7 @@ type SearchRevisionDataApiArg = {
|
|
|
4276
4276
|
|
|
4277
4277
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4278
4278
|
|
|
4279
|
-
Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4279
|
+
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.
|
|
4280
4280
|
|
|
4281
4281
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4282
4282
|
|
|
@@ -4330,7 +4330,7 @@ type SearchRevisionMutationSourcesApiArg = {
|
|
|
4330
4330
|
An example conjunction is:
|
|
4331
4331
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4332
4332
|
|
|
4333
|
-
Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4333
|
+
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.
|
|
4334
4334
|
|
|
4335
4335
|
To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
4336
4336
|
|
|
@@ -4389,7 +4389,7 @@ type SearchRevisionMutationSourcesApiArg = {
|
|
|
4389
4389
|
|
|
4390
4390
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4391
4391
|
|
|
4392
|
-
Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
4392
|
+
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.
|
|
4393
4393
|
|
|
4394
4394
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4395
4395
|
|
|
@@ -5572,7 +5572,7 @@ type InvokeFunctionsApiArg = {
|
|
|
5572
5572
|
changeSetId?: string;
|
|
5573
5573
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
5574
5574
|
subgroup?: string;
|
|
5575
|
-
/** Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers:
|
|
5575
|
+
/** 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. */
|
|
5576
5576
|
otherDataSource?: string;
|
|
5577
5577
|
/** The specified string is an expression for the purpose of filtering
|
|
5578
5578
|
the list of Units returned. The expression syntax was inspired by SQL.
|
|
@@ -5608,9 +5608,9 @@ type InvokeFunctionsApiArg = {
|
|
|
5608
5608
|
An example conjunction is:
|
|
5609
5609
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
5610
5610
|
|
|
5611
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
5611
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
5612
5612
|
|
|
5613
|
-
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 `
|
|
5613
|
+
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`.
|
|
5614
5614
|
|
|
5615
5615
|
The whole string must be query-encoded. */
|
|
5616
5616
|
where?: string;
|
|
@@ -6793,9 +6793,9 @@ type ListUnitsApiArg = {
|
|
|
6793
6793
|
An example conjunction is:
|
|
6794
6794
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6795
6795
|
|
|
6796
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
6796
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
6797
6797
|
|
|
6798
|
-
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 `
|
|
6798
|
+
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`.
|
|
6799
6799
|
|
|
6800
6800
|
The whole string must be query-encoded. */
|
|
6801
6801
|
where?: string;
|
|
@@ -6831,7 +6831,7 @@ type ListUnitsApiArg = {
|
|
|
6831
6831
|
The attribute names are case-sensitive, PascalCase, and
|
|
6832
6832
|
expected in a comma-separated list format as in the JSON encoding.
|
|
6833
6833
|
|
|
6834
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
6834
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
6835
6835
|
|
|
6836
6836
|
The whole string must be query-encoded. */
|
|
6837
6837
|
include?: string;
|
|
@@ -6895,7 +6895,7 @@ type GetUnitApiArg = {
|
|
|
6895
6895
|
The attribute names are case-sensitive, PascalCase, and
|
|
6896
6896
|
expected in a comma-separated list format as in the JSON encoding.
|
|
6897
6897
|
|
|
6898
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
6898
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
6899
6899
|
|
|
6900
6900
|
The whole string must be query-encoded. */
|
|
6901
6901
|
include?: string;
|
|
@@ -6930,15 +6930,15 @@ type PatchUnitApiArg = {
|
|
|
6930
6930
|
squash?: boolean;
|
|
6931
6931
|
/** Upgrade the unit to the latest version of its upstream unit */
|
|
6932
6932
|
upgrade?: boolean;
|
|
6933
|
-
/** Restore revision source. Supports: Named revisions ('
|
|
6933
|
+
/** Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
6934
6934
|
restore?: string;
|
|
6935
6935
|
/** Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:<uuid>, or Link:<where expression>. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */
|
|
6936
6936
|
resolve?: string;
|
|
6937
6937
|
/** Merge source unit. Currently it must be a unit ID or 'Self'. */
|
|
6938
6938
|
mergeSource?: string;
|
|
6939
|
-
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('
|
|
6939
|
+
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
6940
6940
|
mergeBase?: string;
|
|
6941
|
-
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('
|
|
6941
|
+
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
6942
6942
|
mergeEnd?: string;
|
|
6943
6943
|
/** Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
|
|
6944
6944
|
mergeExternalSource?: string;
|
|
@@ -7063,15 +7063,15 @@ type UpdateUnitApiArg = {
|
|
|
7063
7063
|
squash?: boolean;
|
|
7064
7064
|
/** Upgrade the unit to the latest version of its upstream unit */
|
|
7065
7065
|
upgrade?: boolean;
|
|
7066
|
-
/** Restore revision source. Supports: Named revisions ('
|
|
7066
|
+
/** Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
7067
7067
|
restore?: string;
|
|
7068
7068
|
/** Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:<uuid>, or Link:<where expression>. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */
|
|
7069
7069
|
resolve?: string;
|
|
7070
7070
|
/** Merge source unit. Currently it must be a unit ID or 'Self'. */
|
|
7071
7071
|
mergeSource?: string;
|
|
7072
|
-
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('
|
|
7072
|
+
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
7073
7073
|
mergeBase?: string;
|
|
7074
|
-
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('
|
|
7074
|
+
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
7075
7075
|
mergeEnd?: string;
|
|
7076
7076
|
/** Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
|
|
7077
7077
|
mergeExternalSource?: string;
|
|
@@ -7147,7 +7147,7 @@ type ApproveUnitApiArg = {
|
|
|
7147
7147
|
spaceId: string;
|
|
7148
7148
|
/** Unique identifier for a unit_id */
|
|
7149
7149
|
unitId: string;
|
|
7150
|
-
/** Revision to approve (defaults to HeadRevisionNum). Can be a revision number, '
|
|
7150
|
+
/** Revision to approve (defaults to HeadRevisionNum). Can be a revision number, 'LastReleasedRevisionNum', 'Tag:uuid', 'ChangeSet:uuid', etc. */
|
|
7151
7151
|
revision?: string;
|
|
7152
7152
|
};
|
|
7153
7153
|
type ResolveUnitConflictsApiResponse =
|
|
@@ -7183,7 +7183,7 @@ type UploadUnitDataApiArg = {
|
|
|
7183
7183
|
protect?: boolean;
|
|
7184
7184
|
/** The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
|
|
7185
7185
|
clearance?: string;
|
|
7186
|
-
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('
|
|
7186
|
+
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
7187
7187
|
mergeBase?: string;
|
|
7188
7188
|
/** Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
|
|
7189
7189
|
mergeExternalSource?: string;
|
|
@@ -7548,7 +7548,7 @@ type ListExtendedRevisionsApiArg = {
|
|
|
7548
7548
|
An example conjunction is:
|
|
7549
7549
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
7550
7550
|
|
|
7551
|
-
Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
7551
|
+
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.
|
|
7552
7552
|
|
|
7553
7553
|
To list a tagged Revision use `Tags ? '<tag-id>'`.
|
|
7554
7554
|
|
|
@@ -7607,7 +7607,7 @@ type ListExtendedRevisionsApiArg = {
|
|
|
7607
7607
|
|
|
7608
7608
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
7609
7609
|
|
|
7610
|
-
Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
7610
|
+
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.
|
|
7611
7611
|
|
|
7612
7612
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
7613
7613
|
|
|
@@ -7648,7 +7648,7 @@ type GetExtendedRevisionApiArg = {
|
|
|
7648
7648
|
|
|
7649
7649
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
7650
7650
|
|
|
7651
|
-
Supported attributes for ordering Revision: ApplyGates, ApplyWarnings, ApprovedBy, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description,
|
|
7651
|
+
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.
|
|
7652
7652
|
|
|
7653
7653
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
7654
7654
|
|
|
@@ -9244,9 +9244,9 @@ type BulkDeleteUnitsApiArg = {
|
|
|
9244
9244
|
An example conjunction is:
|
|
9245
9245
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9246
9246
|
|
|
9247
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9247
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9248
9248
|
|
|
9249
|
-
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 `
|
|
9249
|
+
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`.
|
|
9250
9250
|
|
|
9251
9251
|
The whole string must be query-encoded. */
|
|
9252
9252
|
where?: string;
|
|
@@ -9282,7 +9282,7 @@ type BulkDeleteUnitsApiArg = {
|
|
|
9282
9282
|
The attribute names are case-sensitive, PascalCase, and
|
|
9283
9283
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9284
9284
|
|
|
9285
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9285
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9286
9286
|
|
|
9287
9287
|
The whole string must be query-encoded. */
|
|
9288
9288
|
include?: string;
|
|
@@ -9323,9 +9323,9 @@ type ListAllUnitsApiArg = {
|
|
|
9323
9323
|
An example conjunction is:
|
|
9324
9324
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9325
9325
|
|
|
9326
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9326
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9327
9327
|
|
|
9328
|
-
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 `
|
|
9328
|
+
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`.
|
|
9329
9329
|
|
|
9330
9330
|
The whole string must be query-encoded. */
|
|
9331
9331
|
where?: string;
|
|
@@ -9361,7 +9361,7 @@ type ListAllUnitsApiArg = {
|
|
|
9361
9361
|
The attribute names are case-sensitive, PascalCase, and
|
|
9362
9362
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9363
9363
|
|
|
9364
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9364
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9365
9365
|
|
|
9366
9366
|
The whole string must be query-encoded. */
|
|
9367
9367
|
include?: string;
|
|
@@ -9423,9 +9423,9 @@ type BulkPatchUnitsApiArg = {
|
|
|
9423
9423
|
An example conjunction is:
|
|
9424
9424
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9425
9425
|
|
|
9426
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9426
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9427
9427
|
|
|
9428
|
-
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 `
|
|
9428
|
+
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`.
|
|
9429
9429
|
|
|
9430
9430
|
The whole string must be query-encoded. */
|
|
9431
9431
|
where?: string;
|
|
@@ -9461,7 +9461,7 @@ type BulkPatchUnitsApiArg = {
|
|
|
9461
9461
|
The attribute names are case-sensitive, PascalCase, and
|
|
9462
9462
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9463
9463
|
|
|
9464
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9464
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9465
9465
|
|
|
9466
9466
|
The whole string must be query-encoded. */
|
|
9467
9467
|
include?: string;
|
|
@@ -9475,15 +9475,15 @@ type BulkPatchUnitsApiArg = {
|
|
|
9475
9475
|
squash?: boolean;
|
|
9476
9476
|
/** Upgrade the unit to the latest version of its upstream unit */
|
|
9477
9477
|
upgrade?: boolean;
|
|
9478
|
-
/** Restore revision source. Supports: Named revisions ('
|
|
9478
|
+
/** Restore revision source. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
9479
9479
|
restore?: string;
|
|
9480
9480
|
/** Resolve Links from this (downstream) Unit to another (upstream) Unit, propagating what each Link's UpdateType says to propagate. Expects Link:*, Link:<uuid>, or Link:<where expression>. Link:* selects every Link from this Unit that can resolve; a where expression selects among those, evaluated against the Links themselves (e.g. UpdateType = 'MergeUnits'), which is how to name one Link in a bulk operation, where a UUID cannot be. A Link with UpdateType None resolves nothing and is never selected. An AutoUpdate Link may be resolved by hand: it does what the queue would have done, and nothing when the Link is already level with its source. */
|
|
9481
9481
|
resolve?: string;
|
|
9482
9482
|
/** Merge source unit. Currently it must be a unit ID or 'Self'. */
|
|
9483
9483
|
mergeSource?: string;
|
|
9484
|
-
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('
|
|
9484
|
+
/** Merge base revision, which provides the base configuration data of the changes to merge. With merge_source, this is a revision of the merge source unit. With merge_external_source, this is a revision of the unit being updated and overrides the default selection of the latest MergeExternal revision. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
9485
9485
|
mergeBase?: string;
|
|
9486
|
-
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('
|
|
9486
|
+
/** Merge end revision of the merge source, which provides the final configuration of the changes to merge. Also accepted with upgrade and with resolve, where it names how far along the source to take the propagation; the default there is the source's head. Naming a ChangeSet or Tag that ends a change is what leaves a change still being made at the source behind. Supports: Named revisions ('HeadRevisionNum', 'LastReleasedRevisionNum'), direct revision number (e.g., '42'), or entity references ('Tag:uuid', 'ChangeSet:uuid', 'ChangeOrder:uuid', 'Revision:uuid'). Can be prefixed with 'Before:' to select the revision immediately before the specified one (e.g., 'Before:LastReleasedRevisionNum', 'Before:42'). When using Tag or ChangeSet references, the latest revision associated with that entity is selected. 'ChangeOrder:uuid' selects the revision the change order ended at on this Unit and 'Before:ChangeOrder:uuid' the one before it began, which is what undoes a promotion however many revisions it made. */
|
|
9487
9487
|
mergeEnd?: string;
|
|
9488
9488
|
/** Identifier of the external source for merge-on-update. When set, computes mutations between the last MergeExternal revision and the provided data, then patches the current unit data with those mutations. */
|
|
9489
9489
|
mergeExternalSource?: string;
|
|
@@ -9623,9 +9623,9 @@ type BulkCreateUnitsApiArg = {
|
|
|
9623
9623
|
An example conjunction is:
|
|
9624
9624
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9625
9625
|
|
|
9626
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9626
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9627
9627
|
|
|
9628
|
-
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 `
|
|
9628
|
+
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`.
|
|
9629
9629
|
|
|
9630
9630
|
The whole string must be query-encoded. */
|
|
9631
9631
|
where?: string;
|
|
@@ -9661,7 +9661,7 @@ type BulkCreateUnitsApiArg = {
|
|
|
9661
9661
|
The attribute names are case-sensitive, PascalCase, and
|
|
9662
9662
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9663
9663
|
|
|
9664
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9664
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9665
9665
|
|
|
9666
9666
|
The whole string must be query-encoded. */
|
|
9667
9667
|
include?: string;
|
|
@@ -9843,9 +9843,9 @@ type BulkApproveUnitsApiArg = {
|
|
|
9843
9843
|
An example conjunction is:
|
|
9844
9844
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9845
9845
|
|
|
9846
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9846
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9847
9847
|
|
|
9848
|
-
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 `
|
|
9848
|
+
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`.
|
|
9849
9849
|
|
|
9850
9850
|
The whole string must be query-encoded. */
|
|
9851
9851
|
where?: string;
|
|
@@ -9881,11 +9881,11 @@ type BulkApproveUnitsApiArg = {
|
|
|
9881
9881
|
The attribute names are case-sensitive, PascalCase, and
|
|
9882
9882
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9883
9883
|
|
|
9884
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9884
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9885
9885
|
|
|
9886
9886
|
The whole string must be query-encoded. */
|
|
9887
9887
|
include?: string;
|
|
9888
|
-
/** Revision to approve (defaults to HeadRevisionNum). Can be a revision number, '
|
|
9888
|
+
/** Revision to approve (defaults to HeadRevisionNum). Can be a revision number, 'LastReleasedRevisionNum', 'Tag:uuid', 'ChangeSet:uuid', etc. */
|
|
9889
9889
|
revision?: string;
|
|
9890
9890
|
};
|
|
9891
9891
|
type BulkCancelUnitsApiResponse = /** status 200 OK */ UnitActionResponse[] | /** status 207 Multi-Status: Mixed success and failure results */ UnitActionResponse[];
|
|
@@ -9924,9 +9924,9 @@ type BulkCancelUnitsApiArg = {
|
|
|
9924
9924
|
An example conjunction is:
|
|
9925
9925
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9926
9926
|
|
|
9927
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
9927
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
9928
9928
|
|
|
9929
|
-
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 `
|
|
9929
|
+
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`.
|
|
9930
9930
|
|
|
9931
9931
|
The whole string must be query-encoded. */
|
|
9932
9932
|
where?: string;
|
|
@@ -9962,7 +9962,7 @@ type BulkCancelUnitsApiArg = {
|
|
|
9962
9962
|
The attribute names are case-sensitive, PascalCase, and
|
|
9963
9963
|
expected in a comma-separated list format as in the JSON encoding.
|
|
9964
9964
|
|
|
9965
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
9965
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
9966
9966
|
|
|
9967
9967
|
The whole string must be query-encoded. */
|
|
9968
9968
|
include?: string;
|
|
@@ -10003,9 +10003,9 @@ type BulkTagUnitsApiArg = {
|
|
|
10003
10003
|
An example conjunction is:
|
|
10004
10004
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10005
10005
|
|
|
10006
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
10006
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
10007
10007
|
|
|
10008
|
-
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 `
|
|
10008
|
+
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`.
|
|
10009
10009
|
|
|
10010
10010
|
The whole string must be query-encoded. */
|
|
10011
10011
|
where?: string;
|
|
@@ -10041,7 +10041,7 @@ type BulkTagUnitsApiArg = {
|
|
|
10041
10041
|
The attribute names are case-sensitive, PascalCase, and
|
|
10042
10042
|
expected in a comma-separated list format as in the JSON encoding.
|
|
10043
10043
|
|
|
10044
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
10044
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
10045
10045
|
|
|
10046
10046
|
The whole string must be query-encoded. */
|
|
10047
10047
|
include?: string;
|
|
@@ -10152,9 +10152,9 @@ type SearchUnitDataApiArg = {
|
|
|
10152
10152
|
An example conjunction is:
|
|
10153
10153
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10154
10154
|
|
|
10155
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
10155
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
10156
10156
|
|
|
10157
|
-
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 `
|
|
10157
|
+
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`.
|
|
10158
10158
|
|
|
10159
10159
|
The whole string must be query-encoded. */
|
|
10160
10160
|
where?: string;
|
|
@@ -10190,7 +10190,7 @@ type SearchUnitDataApiArg = {
|
|
|
10190
10190
|
The attribute names are case-sensitive, PascalCase, and
|
|
10191
10191
|
expected in a comma-separated list format as in the JSON encoding.
|
|
10192
10192
|
|
|
10193
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
10193
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
10194
10194
|
|
|
10195
10195
|
The whole string must be query-encoded. */
|
|
10196
10196
|
include?: string;
|
|
@@ -10346,9 +10346,9 @@ type SearchUnitMutationSourcesApiArg = {
|
|
|
10346
10346
|
An example conjunction is:
|
|
10347
10347
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10348
10348
|
|
|
10349
|
-
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt,
|
|
10349
|
+
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, OrganizationID, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, Values.
|
|
10350
10350
|
|
|
10351
|
-
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 `
|
|
10351
|
+
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`.
|
|
10352
10352
|
|
|
10353
10353
|
The whole string must be query-encoded. */
|
|
10354
10354
|
where?: string;
|
|
@@ -10384,7 +10384,7 @@ type SearchUnitMutationSourcesApiArg = {
|
|
|
10384
10384
|
The attribute names are case-sensitive, PascalCase, and
|
|
10385
10385
|
expected in a comma-separated list format as in the JSON encoding.
|
|
10386
10386
|
|
|
10387
|
-
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum,
|
|
10387
|
+
Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
10388
10388
|
|
|
10389
10389
|
The whole string must be query-encoded. */
|
|
10390
10390
|
include?: string;
|
|
@@ -12659,19 +12659,15 @@ type UnitRead = {
|
|
|
12659
12659
|
Labels?: {
|
|
12660
12660
|
[key: string]: string;
|
|
12661
12661
|
};
|
|
12662
|
-
/** Sequence number the last Revision applied. 0 if no live revision. */
|
|
12663
|
-
LastAppliedRevisionNum?: number;
|
|
12664
12662
|
/** LastChangeDescription is a human-readable description of the last change. This description is copied to the new Revision when the Data is changed. */
|
|
12665
12663
|
LastChangeDescription?: string;
|
|
12666
|
-
/** Sequence number the last Revision
|
|
12667
|
-
|
|
12664
|
+
/** Sequence number of the last Revision published in a Release. 0 if no Revision has been released. */
|
|
12665
|
+
LastReleasedRevisionNum?: number;
|
|
12668
12666
|
/** Attribute paths that this Unit needs from upstream Units via NeedsProvides Links. Computed from get-needed and stored on data updates. */
|
|
12669
12667
|
NeededPaths?: AttributeValue[];
|
|
12670
12668
|
/** Unique identifier for an organization. */
|
|
12671
12669
|
OrganizationID?: string;
|
|
12672
12670
|
PathAnnotations?: PathAnnotationList;
|
|
12673
|
-
/** Sequence number the previous Revision applied. 0 if no live revision. */
|
|
12674
|
-
PreviousLiveRevisionNum?: number;
|
|
12675
12671
|
/** Attribute paths that this Unit provides to downstream Units via NeedsProvides Links. Computed from get-provided and stored on data updates. */
|
|
12676
12672
|
ProvidedPaths?: AttributeInfo[];
|
|
12677
12673
|
/** ProviderType identifies which bridge to use in the case that the Target supports multiple ProviderTypes. */
|
|
@@ -13464,8 +13460,6 @@ type Revision = {
|
|
|
13464
13460
|
DataHash?: string;
|
|
13465
13461
|
/** 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. */
|
|
13466
13462
|
Description?: string;
|
|
13467
|
-
/** Time at which the revision was applied, if it was applied. If not applied, the value is "0001-01-01T00:00:00Z". */
|
|
13468
|
-
LiveAt?: string;
|
|
13469
13463
|
/** Unique identifier for an Organization. */
|
|
13470
13464
|
OrganizationID?: string;
|
|
13471
13465
|
PathAnnotations?: PathAnnotationList;
|
|
@@ -13523,8 +13517,6 @@ type RevisionRead = {
|
|
|
13523
13517
|
Description?: string;
|
|
13524
13518
|
/** The type of entity. */
|
|
13525
13519
|
EntityType?: string;
|
|
13526
|
-
/** Time at which the revision was applied, if it was applied. If not applied, the value is "0001-01-01T00:00:00Z". */
|
|
13527
|
-
LiveAt?: string;
|
|
13528
13520
|
/** Unique identifier for an Organization. */
|
|
13529
13521
|
OrganizationID?: string;
|
|
13530
13522
|
PathAnnotations?: PathAnnotationList;
|
|
@@ -13683,7 +13675,7 @@ type Trigger = {
|
|
|
13683
13675
|
};
|
|
13684
13676
|
/** Unique identifier for an organization. */
|
|
13685
13677
|
OrganizationID?: string;
|
|
13686
|
-
/** Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs
|
|
13678
|
+
/** Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs a baseline revision to compare against). Uses revision specifier format such as LastReleasedRevisionNum or Before:HeadRevisionNum. */
|
|
13687
13679
|
OtherDataSource?: string;
|
|
13688
13680
|
/** Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
13689
13681
|
Params?: {
|
|
@@ -13754,7 +13746,7 @@ type TriggerRead = {
|
|
|
13754
13746
|
};
|
|
13755
13747
|
/** Unique identifier for an organization. */
|
|
13756
13748
|
OrganizationID?: string;
|
|
13757
|
-
/** Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs
|
|
13749
|
+
/** Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs a baseline revision to compare against). Uses revision specifier format such as LastReleasedRevisionNum or Before:HeadRevisionNum. */
|
|
13758
13750
|
OtherDataSource?: string;
|
|
13759
13751
|
/** Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
13760
13752
|
Params?: {
|
|
@@ -13796,7 +13788,6 @@ type ExtendedSpace = {
|
|
|
13796
13788
|
Attributes?: Attribute[];
|
|
13797
13789
|
Error?: ResponseError;
|
|
13798
13790
|
GatedUnitCount?: number;
|
|
13799
|
-
IncompleteApplyUnitCount?: number;
|
|
13800
13791
|
Organization?: Organization;
|
|
13801
13792
|
ReleaseTarget?: Target;
|
|
13802
13793
|
Space?: Space;
|
|
@@ -13819,9 +13810,9 @@ type ExtendedSpace = {
|
|
|
13819
13810
|
} | null;
|
|
13820
13811
|
TriggerFilter?: Filter;
|
|
13821
13812
|
Triggers?: Trigger[];
|
|
13822
|
-
UnappliedUnitCount?: number;
|
|
13823
13813
|
UnapprovedUnitCount?: number;
|
|
13824
13814
|
UnlinkedUnitCount?: number;
|
|
13815
|
+
UnreleasedUnitCount?: number;
|
|
13825
13816
|
UpgradableUnitCount?: number;
|
|
13826
13817
|
WarnedUnitCount?: number;
|
|
13827
13818
|
};
|
|
@@ -13830,7 +13821,6 @@ type ExtendedSpaceRead = {
|
|
|
13830
13821
|
Attributes?: AttributeRead[];
|
|
13831
13822
|
Error?: ResponseError;
|
|
13832
13823
|
GatedUnitCount?: number;
|
|
13833
|
-
IncompleteApplyUnitCount?: number;
|
|
13834
13824
|
Organization?: OrganizationRead;
|
|
13835
13825
|
ReleaseTarget?: TargetRead;
|
|
13836
13826
|
Space?: SpaceRead;
|
|
@@ -13853,9 +13843,9 @@ type ExtendedSpaceRead = {
|
|
|
13853
13843
|
} | null;
|
|
13854
13844
|
TriggerFilter?: FilterRead;
|
|
13855
13845
|
Triggers?: TriggerRead[];
|
|
13856
|
-
UnappliedUnitCount?: number;
|
|
13857
13846
|
UnapprovedUnitCount?: number;
|
|
13858
13847
|
UnlinkedUnitCount?: number;
|
|
13848
|
+
UnreleasedUnitCount?: number;
|
|
13859
13849
|
UpgradableUnitCount?: number;
|
|
13860
13850
|
WarnedUnitCount?: number;
|
|
13861
13851
|
};
|
|
@@ -14130,11 +14120,9 @@ type ExtendedUnit = {
|
|
|
14130
14120
|
FromLink?: Link[];
|
|
14131
14121
|
HeadMutation?: Mutation;
|
|
14132
14122
|
HeadRevision?: Revision;
|
|
14133
|
-
|
|
14123
|
+
LastReleasedRevision?: Revision;
|
|
14134
14124
|
LatestUnitEvent?: UnitEvent;
|
|
14135
|
-
LiveRevision?: Revision;
|
|
14136
14125
|
Organization?: Organization;
|
|
14137
|
-
PreviousLiveRevision?: Revision;
|
|
14138
14126
|
Space?: Space;
|
|
14139
14127
|
Target?: Target;
|
|
14140
14128
|
Unit?: Unit;
|
|
@@ -14152,11 +14140,9 @@ type ExtendedUnitRead = {
|
|
|
14152
14140
|
FromLink?: LinkRead[];
|
|
14153
14141
|
HeadMutation?: MutationRead;
|
|
14154
14142
|
HeadRevision?: RevisionRead;
|
|
14155
|
-
|
|
14143
|
+
LastReleasedRevision?: RevisionRead;
|
|
14156
14144
|
LatestUnitEvent?: UnitEventRead;
|
|
14157
|
-
LiveRevision?: RevisionRead;
|
|
14158
14145
|
Organization?: OrganizationRead;
|
|
14159
|
-
PreviousLiveRevision?: RevisionRead;
|
|
14160
14146
|
Space?: SpaceRead;
|
|
14161
14147
|
Target?: TargetRead;
|
|
14162
14148
|
Unit?: UnitRead;
|
|
@@ -14393,7 +14379,7 @@ type UnitTagResponse = {
|
|
|
14393
14379
|
Message?: string;
|
|
14394
14380
|
};
|
|
14395
14381
|
type UnitTagRequest = {
|
|
14396
|
-
/** Which Unit revision to tag: a named revision ('HeadRevisionNum', '
|
|
14382
|
+
/** Which Unit revision to tag: a named revision ('HeadRevisionNum', 'LastReleasedRevisionNum'), a revision number, an entity reference ('Tag:uuid', 'ChangeSet:uuid', 'Revision:uuid'), any of those prefixed with 'Before:', or 'Remove' to remove the tag from the unit */
|
|
14397
14383
|
Revision?: string;
|
|
14398
14384
|
TagID?: string;
|
|
14399
14385
|
};
|