@confighub/api 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +282 -12
- package/dist/index.d.ts +282 -12
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2223,6 +2223,26 @@ interface paths {
|
|
|
2223
2223
|
patch?: never;
|
|
2224
2224
|
trace?: never;
|
|
2225
2225
|
};
|
|
2226
|
+
"/unit/move": {
|
|
2227
|
+
parameters: {
|
|
2228
|
+
query?: never;
|
|
2229
|
+
header?: never;
|
|
2230
|
+
path?: never;
|
|
2231
|
+
cookie?: never;
|
|
2232
|
+
};
|
|
2233
|
+
get?: never;
|
|
2234
|
+
put?: never;
|
|
2235
|
+
/**
|
|
2236
|
+
* Move units to another space
|
|
2237
|
+
* @description Move the selected Units, and the Links from them, to another Space. Requires Manage permission on each Unit and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved.
|
|
2238
|
+
*/
|
|
2239
|
+
post: operations["BulkMoveUnits"];
|
|
2240
|
+
delete?: never;
|
|
2241
|
+
options?: never;
|
|
2242
|
+
head?: never;
|
|
2243
|
+
patch?: never;
|
|
2244
|
+
trace?: never;
|
|
2245
|
+
};
|
|
2226
2246
|
"/unit/tag": {
|
|
2227
2247
|
parameters: {
|
|
2228
2248
|
query?: never;
|
|
@@ -5319,6 +5339,12 @@ interface components {
|
|
|
5319
5339
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5320
5340
|
*/
|
|
5321
5341
|
OrganizationID?: string;
|
|
5342
|
+
/**
|
|
5343
|
+
* Format: uuid
|
|
5344
|
+
* @description ReleaseID is the optional ID of the Release that made this Tag.
|
|
5345
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5346
|
+
*/
|
|
5347
|
+
readonly ReleaseID?: string;
|
|
5322
5348
|
/** @description Unique URL-safe identifier for the entity. */
|
|
5323
5349
|
Slug: string;
|
|
5324
5350
|
/**
|
|
@@ -6103,6 +6129,30 @@ interface components {
|
|
|
6103
6129
|
UnitGuardResponse: {
|
|
6104
6130
|
PathAnnotations?: components["schemas"]["PathAnnotationList"];
|
|
6105
6131
|
};
|
|
6132
|
+
UnitMoveRequest: {
|
|
6133
|
+
/**
|
|
6134
|
+
* Format: uuid
|
|
6135
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6136
|
+
*/
|
|
6137
|
+
ToSpaceID?: string;
|
|
6138
|
+
};
|
|
6139
|
+
UnitMoveResponse: {
|
|
6140
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6141
|
+
Moved?: boolean;
|
|
6142
|
+
MovedLinkSlugs?: string[];
|
|
6143
|
+
Resolving?: boolean;
|
|
6144
|
+
Slug?: string;
|
|
6145
|
+
/**
|
|
6146
|
+
* Format: uuid
|
|
6147
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6148
|
+
*/
|
|
6149
|
+
TargetID?: string;
|
|
6150
|
+
/**
|
|
6151
|
+
* Format: uuid
|
|
6152
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6153
|
+
*/
|
|
6154
|
+
UnitID?: string;
|
|
6155
|
+
};
|
|
6106
6156
|
UnitMutationSources: {
|
|
6107
6157
|
/** @description SHA256 of the configuration data the MutationSources describe. */
|
|
6108
6158
|
DataHash?: string;
|
|
@@ -6849,6 +6899,8 @@ interface operations {
|
|
|
6849
6899
|
recursive?: string;
|
|
6850
6900
|
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
6851
6901
|
recursive_force?: string;
|
|
6902
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
6903
|
+
detach?: boolean;
|
|
6852
6904
|
};
|
|
6853
6905
|
header?: never;
|
|
6854
6906
|
path?: never;
|
|
@@ -8178,6 +8230,8 @@ interface operations {
|
|
|
8178
8230
|
* The whole string must be query-encoded.
|
|
8179
8231
|
*/
|
|
8180
8232
|
include?: string;
|
|
8233
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
8234
|
+
detach?: boolean;
|
|
8181
8235
|
};
|
|
8182
8236
|
header?: never;
|
|
8183
8237
|
path?: never;
|
|
@@ -9332,6 +9386,8 @@ interface operations {
|
|
|
9332
9386
|
* The whole string must be query-encoded.
|
|
9333
9387
|
*/
|
|
9334
9388
|
include?: string;
|
|
9389
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
9390
|
+
detach?: boolean;
|
|
9335
9391
|
};
|
|
9336
9392
|
header?: never;
|
|
9337
9393
|
path?: never;
|
|
@@ -10164,6 +10220,8 @@ interface operations {
|
|
|
10164
10220
|
* The whole string must be query-encoded.
|
|
10165
10221
|
*/
|
|
10166
10222
|
include?: string;
|
|
10223
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
10224
|
+
detach?: boolean;
|
|
10167
10225
|
};
|
|
10168
10226
|
header?: never;
|
|
10169
10227
|
path?: never;
|
|
@@ -17151,6 +17209,8 @@ interface operations {
|
|
|
17151
17209
|
recursive?: string;
|
|
17152
17210
|
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
17153
17211
|
recursive_force?: string;
|
|
17212
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
17213
|
+
detach?: boolean;
|
|
17154
17214
|
};
|
|
17155
17215
|
header?: never;
|
|
17156
17216
|
path: {
|
|
@@ -18529,7 +18589,10 @@ interface operations {
|
|
|
18529
18589
|
};
|
|
18530
18590
|
DeleteBridgeWorker: {
|
|
18531
18591
|
parameters: {
|
|
18532
|
-
query?:
|
|
18592
|
+
query?: {
|
|
18593
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
18594
|
+
detach?: boolean;
|
|
18595
|
+
};
|
|
18533
18596
|
header?: never;
|
|
18534
18597
|
path: {
|
|
18535
18598
|
/** @description Unique identifier for a space_id */
|
|
@@ -19401,7 +19464,10 @@ interface operations {
|
|
|
19401
19464
|
};
|
|
19402
19465
|
DeleteChangeOrder: {
|
|
19403
19466
|
parameters: {
|
|
19404
|
-
query?:
|
|
19467
|
+
query?: {
|
|
19468
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
19469
|
+
detach?: boolean;
|
|
19470
|
+
};
|
|
19405
19471
|
header?: never;
|
|
19406
19472
|
path: {
|
|
19407
19473
|
/** @description Unique identifier for a space_id */
|
|
@@ -20086,7 +20152,10 @@ interface operations {
|
|
|
20086
20152
|
};
|
|
20087
20153
|
DeleteChangeSet: {
|
|
20088
20154
|
parameters: {
|
|
20089
|
-
query?:
|
|
20155
|
+
query?: {
|
|
20156
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
20157
|
+
detach?: boolean;
|
|
20158
|
+
};
|
|
20090
20159
|
header?: never;
|
|
20091
20160
|
path: {
|
|
20092
20161
|
/** @description Unique identifier for a space_id */
|
|
@@ -23840,7 +23909,10 @@ interface operations {
|
|
|
23840
23909
|
};
|
|
23841
23910
|
DeleteRelease: {
|
|
23842
23911
|
parameters: {
|
|
23843
|
-
query?:
|
|
23912
|
+
query?: {
|
|
23913
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
23914
|
+
detach?: boolean;
|
|
23915
|
+
};
|
|
23844
23916
|
header?: never;
|
|
23845
23917
|
path: {
|
|
23846
23918
|
/** @description Unique identifier for a space_id */
|
|
@@ -24256,7 +24328,7 @@ interface operations {
|
|
|
24256
24328
|
* An example conjunction is:
|
|
24257
24329
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24258
24330
|
*
|
|
24259
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
24331
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
24260
24332
|
*
|
|
24261
24333
|
* The whole string must be query-encoded.
|
|
24262
24334
|
*/
|
|
@@ -24677,7 +24749,10 @@ interface operations {
|
|
|
24677
24749
|
};
|
|
24678
24750
|
DeleteTag: {
|
|
24679
24751
|
parameters: {
|
|
24680
|
-
query?:
|
|
24752
|
+
query?: {
|
|
24753
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
24754
|
+
detach?: boolean;
|
|
24755
|
+
};
|
|
24681
24756
|
header?: never;
|
|
24682
24757
|
path: {
|
|
24683
24758
|
/** @description Unique identifier for a space_id */
|
|
@@ -25345,7 +25420,10 @@ interface operations {
|
|
|
25345
25420
|
};
|
|
25346
25421
|
DeleteTarget: {
|
|
25347
25422
|
parameters: {
|
|
25348
|
-
query?:
|
|
25423
|
+
query?: {
|
|
25424
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
25425
|
+
detach?: boolean;
|
|
25426
|
+
};
|
|
25349
25427
|
header?: never;
|
|
25350
25428
|
path: {
|
|
25351
25429
|
/** @description Unique identifier for a space_id */
|
|
@@ -26899,7 +26977,10 @@ interface operations {
|
|
|
26899
26977
|
};
|
|
26900
26978
|
DeleteUnit: {
|
|
26901
26979
|
parameters: {
|
|
26902
|
-
query?:
|
|
26980
|
+
query?: {
|
|
26981
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
26982
|
+
detach?: boolean;
|
|
26983
|
+
};
|
|
26903
26984
|
header?: never;
|
|
26904
26985
|
path: {
|
|
26905
26986
|
/** @description Unique identifier for a space_id */
|
|
@@ -30180,7 +30261,7 @@ interface operations {
|
|
|
30180
30261
|
* An example conjunction is:
|
|
30181
30262
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30182
30263
|
*
|
|
30183
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30264
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30184
30265
|
*
|
|
30185
30266
|
* The whole string must be query-encoded.
|
|
30186
30267
|
*/
|
|
@@ -30348,7 +30429,7 @@ interface operations {
|
|
|
30348
30429
|
* An example conjunction is:
|
|
30349
30430
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30350
30431
|
*
|
|
30351
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30432
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30352
30433
|
*
|
|
30353
30434
|
* The whole string must be query-encoded.
|
|
30354
30435
|
*/
|
|
@@ -30610,7 +30691,7 @@ interface operations {
|
|
|
30610
30691
|
* An example conjunction is:
|
|
30611
30692
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30612
30693
|
*
|
|
30613
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30694
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30614
30695
|
*
|
|
30615
30696
|
* The whole string must be query-encoded.
|
|
30616
30697
|
*/
|
|
@@ -30657,6 +30738,8 @@ interface operations {
|
|
|
30657
30738
|
* The whole string must be query-encoded.
|
|
30658
30739
|
*/
|
|
30659
30740
|
include?: string;
|
|
30741
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
30742
|
+
detach?: boolean;
|
|
30660
30743
|
};
|
|
30661
30744
|
header?: never;
|
|
30662
30745
|
path?: never;
|
|
@@ -30794,7 +30877,7 @@ interface operations {
|
|
|
30794
30877
|
* An example conjunction is:
|
|
30795
30878
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30796
30879
|
*
|
|
30797
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30880
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30798
30881
|
*
|
|
30799
30882
|
* The whole string must be query-encoded.
|
|
30800
30883
|
*/
|
|
@@ -31207,6 +31290,8 @@ interface operations {
|
|
|
31207
31290
|
* The whole string must be query-encoded.
|
|
31208
31291
|
*/
|
|
31209
31292
|
include?: string;
|
|
31293
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
31294
|
+
detach?: boolean;
|
|
31210
31295
|
};
|
|
31211
31296
|
header?: never;
|
|
31212
31297
|
path?: never;
|
|
@@ -33011,6 +33096,8 @@ interface operations {
|
|
|
33011
33096
|
* The whole string must be query-encoded.
|
|
33012
33097
|
*/
|
|
33013
33098
|
include?: string;
|
|
33099
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
33100
|
+
detach?: boolean;
|
|
33014
33101
|
};
|
|
33015
33102
|
header?: never;
|
|
33016
33103
|
path?: never;
|
|
@@ -33806,6 +33893,189 @@ interface operations {
|
|
|
33806
33893
|
};
|
|
33807
33894
|
};
|
|
33808
33895
|
};
|
|
33896
|
+
BulkMoveUnits: {
|
|
33897
|
+
parameters: {
|
|
33898
|
+
query?: {
|
|
33899
|
+
/**
|
|
33900
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
33901
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
33902
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
33903
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
33904
|
+
* as in the JSON encoding.
|
|
33905
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
33906
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
33907
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
33908
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
33909
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
33910
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
33911
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
33912
|
+
* UUID and time literals must be quoted as string literals.
|
|
33913
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
33914
|
+
* Time literals use the same form as when serialized as JSON,
|
|
33915
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
33916
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
33917
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
33918
|
+
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
33919
|
+
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
33920
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
33921
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
33922
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
33923
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
33924
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
33925
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
33926
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
33927
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
33928
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
33929
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
33930
|
+
* Conjunctions are supported using the `AND` operator.
|
|
33931
|
+
* An example conjunction is:
|
|
33932
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
33933
|
+
*
|
|
33934
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
33935
|
+
*
|
|
33936
|
+
* 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`.
|
|
33937
|
+
*
|
|
33938
|
+
* The whole string must be query-encoded.
|
|
33939
|
+
*/
|
|
33940
|
+
where?: string;
|
|
33941
|
+
/**
|
|
33942
|
+
* @description UUID of a Filter entity to apply to the Unit list.
|
|
33943
|
+
*
|
|
33944
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
33945
|
+
*
|
|
33946
|
+
* The Filter's From field must match the entity type being filtered (Unit).
|
|
33947
|
+
*
|
|
33948
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
33949
|
+
*
|
|
33950
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
33951
|
+
*
|
|
33952
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
33953
|
+
*/
|
|
33954
|
+
filter?: string;
|
|
33955
|
+
/**
|
|
33956
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
33957
|
+
*
|
|
33958
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
33959
|
+
*
|
|
33960
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
33961
|
+
*
|
|
33962
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
33963
|
+
*
|
|
33964
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
33965
|
+
*
|
|
33966
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
33967
|
+
*
|
|
33968
|
+
* Searchable fields for Unit include string and map-type attributes from the queryable attributes list.
|
|
33969
|
+
*
|
|
33970
|
+
* The whole string must be query-encoded.
|
|
33971
|
+
*/
|
|
33972
|
+
contains?: string;
|
|
33973
|
+
/**
|
|
33974
|
+
* @description Include clause for expanding related entities in the response for Unit.
|
|
33975
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
33976
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
33977
|
+
*
|
|
33978
|
+
* Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
33979
|
+
*
|
|
33980
|
+
* The whole string must be query-encoded.
|
|
33981
|
+
*/
|
|
33982
|
+
include?: string;
|
|
33983
|
+
/** @description Report what the move would do, and what would stop it, without moving anything */
|
|
33984
|
+
dry_run?: boolean;
|
|
33985
|
+
};
|
|
33986
|
+
header?: never;
|
|
33987
|
+
path?: never;
|
|
33988
|
+
cookie?: never;
|
|
33989
|
+
};
|
|
33990
|
+
requestBody?: {
|
|
33991
|
+
content: {
|
|
33992
|
+
"application/json": components["schemas"]["UnitMoveRequest"];
|
|
33993
|
+
};
|
|
33994
|
+
};
|
|
33995
|
+
responses: {
|
|
33996
|
+
/** @description OK */
|
|
33997
|
+
200: {
|
|
33998
|
+
headers: {
|
|
33999
|
+
[name: string]: unknown;
|
|
34000
|
+
};
|
|
34001
|
+
content: {
|
|
34002
|
+
"application/json": components["schemas"]["UnitMoveResponse"][];
|
|
34003
|
+
};
|
|
34004
|
+
};
|
|
34005
|
+
/** @description Multi-Status: nothing was moved, or some Units moved and others did not */
|
|
34006
|
+
207: {
|
|
34007
|
+
headers: {
|
|
34008
|
+
[name: string]: unknown;
|
|
34009
|
+
};
|
|
34010
|
+
content: {
|
|
34011
|
+
"application/json": components["schemas"]["UnitMoveResponse"][];
|
|
34012
|
+
};
|
|
34013
|
+
};
|
|
34014
|
+
/** @description Unit request is invalid (Bad Request). */
|
|
34015
|
+
400: {
|
|
34016
|
+
headers: {
|
|
34017
|
+
[name: string]: unknown;
|
|
34018
|
+
};
|
|
34019
|
+
content: {
|
|
34020
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34021
|
+
};
|
|
34022
|
+
};
|
|
34023
|
+
/** @description Unauthorized access. */
|
|
34024
|
+
401: {
|
|
34025
|
+
headers: {
|
|
34026
|
+
[name: string]: unknown;
|
|
34027
|
+
};
|
|
34028
|
+
content: {
|
|
34029
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34030
|
+
};
|
|
34031
|
+
};
|
|
34032
|
+
/** @description Forbidden access. */
|
|
34033
|
+
403: {
|
|
34034
|
+
headers: {
|
|
34035
|
+
[name: string]: unknown;
|
|
34036
|
+
};
|
|
34037
|
+
content: {
|
|
34038
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34039
|
+
};
|
|
34040
|
+
};
|
|
34041
|
+
/** @description Unit not found. */
|
|
34042
|
+
404: {
|
|
34043
|
+
headers: {
|
|
34044
|
+
[name: string]: unknown;
|
|
34045
|
+
};
|
|
34046
|
+
content: {
|
|
34047
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34048
|
+
};
|
|
34049
|
+
};
|
|
34050
|
+
/** @description Unit data conflict. Data has changed since last read. */
|
|
34051
|
+
409: {
|
|
34052
|
+
headers: {
|
|
34053
|
+
[name: string]: unknown;
|
|
34054
|
+
};
|
|
34055
|
+
content: {
|
|
34056
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34057
|
+
};
|
|
34058
|
+
};
|
|
34059
|
+
/** @description Something went wrong while processing Unit. */
|
|
34060
|
+
500: {
|
|
34061
|
+
headers: {
|
|
34062
|
+
[name: string]: unknown;
|
|
34063
|
+
};
|
|
34064
|
+
content: {
|
|
34065
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34066
|
+
};
|
|
34067
|
+
};
|
|
34068
|
+
/** @description Unexpected error. */
|
|
34069
|
+
default: {
|
|
34070
|
+
headers: {
|
|
34071
|
+
[name: string]: unknown;
|
|
34072
|
+
};
|
|
34073
|
+
content: {
|
|
34074
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34075
|
+
};
|
|
34076
|
+
};
|
|
34077
|
+
};
|
|
34078
|
+
};
|
|
33809
34079
|
BulkTagUnits: {
|
|
33810
34080
|
parameters: {
|
|
33811
34081
|
query?: {
|
package/dist/index.d.ts
CHANGED
|
@@ -2223,6 +2223,26 @@ interface paths {
|
|
|
2223
2223
|
patch?: never;
|
|
2224
2224
|
trace?: never;
|
|
2225
2225
|
};
|
|
2226
|
+
"/unit/move": {
|
|
2227
|
+
parameters: {
|
|
2228
|
+
query?: never;
|
|
2229
|
+
header?: never;
|
|
2230
|
+
path?: never;
|
|
2231
|
+
cookie?: never;
|
|
2232
|
+
};
|
|
2233
|
+
get?: never;
|
|
2234
|
+
put?: never;
|
|
2235
|
+
/**
|
|
2236
|
+
* Move units to another space
|
|
2237
|
+
* @description Move the selected Units, and the Links from them, to another Space. Requires Manage permission on each Unit and CreateChildren permission on the destination Space. Every check runs over the whole selection before anything is moved.
|
|
2238
|
+
*/
|
|
2239
|
+
post: operations["BulkMoveUnits"];
|
|
2240
|
+
delete?: never;
|
|
2241
|
+
options?: never;
|
|
2242
|
+
head?: never;
|
|
2243
|
+
patch?: never;
|
|
2244
|
+
trace?: never;
|
|
2245
|
+
};
|
|
2226
2246
|
"/unit/tag": {
|
|
2227
2247
|
parameters: {
|
|
2228
2248
|
query?: never;
|
|
@@ -5319,6 +5339,12 @@ interface components {
|
|
|
5319
5339
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5320
5340
|
*/
|
|
5321
5341
|
OrganizationID?: string;
|
|
5342
|
+
/**
|
|
5343
|
+
* Format: uuid
|
|
5344
|
+
* @description ReleaseID is the optional ID of the Release that made this Tag.
|
|
5345
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5346
|
+
*/
|
|
5347
|
+
readonly ReleaseID?: string;
|
|
5322
5348
|
/** @description Unique URL-safe identifier for the entity. */
|
|
5323
5349
|
Slug: string;
|
|
5324
5350
|
/**
|
|
@@ -6103,6 +6129,30 @@ interface components {
|
|
|
6103
6129
|
UnitGuardResponse: {
|
|
6104
6130
|
PathAnnotations?: components["schemas"]["PathAnnotationList"];
|
|
6105
6131
|
};
|
|
6132
|
+
UnitMoveRequest: {
|
|
6133
|
+
/**
|
|
6134
|
+
* Format: uuid
|
|
6135
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6136
|
+
*/
|
|
6137
|
+
ToSpaceID?: string;
|
|
6138
|
+
};
|
|
6139
|
+
UnitMoveResponse: {
|
|
6140
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6141
|
+
Moved?: boolean;
|
|
6142
|
+
MovedLinkSlugs?: string[];
|
|
6143
|
+
Resolving?: boolean;
|
|
6144
|
+
Slug?: string;
|
|
6145
|
+
/**
|
|
6146
|
+
* Format: uuid
|
|
6147
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6148
|
+
*/
|
|
6149
|
+
TargetID?: string;
|
|
6150
|
+
/**
|
|
6151
|
+
* Format: uuid
|
|
6152
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6153
|
+
*/
|
|
6154
|
+
UnitID?: string;
|
|
6155
|
+
};
|
|
6106
6156
|
UnitMutationSources: {
|
|
6107
6157
|
/** @description SHA256 of the configuration data the MutationSources describe. */
|
|
6108
6158
|
DataHash?: string;
|
|
@@ -6849,6 +6899,8 @@ interface operations {
|
|
|
6849
6899
|
recursive?: string;
|
|
6850
6900
|
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
6851
6901
|
recursive_force?: string;
|
|
6902
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
6903
|
+
detach?: boolean;
|
|
6852
6904
|
};
|
|
6853
6905
|
header?: never;
|
|
6854
6906
|
path?: never;
|
|
@@ -8178,6 +8230,8 @@ interface operations {
|
|
|
8178
8230
|
* The whole string must be query-encoded.
|
|
8179
8231
|
*/
|
|
8180
8232
|
include?: string;
|
|
8233
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
8234
|
+
detach?: boolean;
|
|
8181
8235
|
};
|
|
8182
8236
|
header?: never;
|
|
8183
8237
|
path?: never;
|
|
@@ -9332,6 +9386,8 @@ interface operations {
|
|
|
9332
9386
|
* The whole string must be query-encoded.
|
|
9333
9387
|
*/
|
|
9334
9388
|
include?: string;
|
|
9389
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
9390
|
+
detach?: boolean;
|
|
9335
9391
|
};
|
|
9336
9392
|
header?: never;
|
|
9337
9393
|
path?: never;
|
|
@@ -10164,6 +10220,8 @@ interface operations {
|
|
|
10164
10220
|
* The whole string must be query-encoded.
|
|
10165
10221
|
*/
|
|
10166
10222
|
include?: string;
|
|
10223
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
10224
|
+
detach?: boolean;
|
|
10167
10225
|
};
|
|
10168
10226
|
header?: never;
|
|
10169
10227
|
path?: never;
|
|
@@ -17151,6 +17209,8 @@ interface operations {
|
|
|
17151
17209
|
recursive?: string;
|
|
17152
17210
|
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
17153
17211
|
recursive_force?: string;
|
|
17212
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
17213
|
+
detach?: boolean;
|
|
17154
17214
|
};
|
|
17155
17215
|
header?: never;
|
|
17156
17216
|
path: {
|
|
@@ -18529,7 +18589,10 @@ interface operations {
|
|
|
18529
18589
|
};
|
|
18530
18590
|
DeleteBridgeWorker: {
|
|
18531
18591
|
parameters: {
|
|
18532
|
-
query?:
|
|
18592
|
+
query?: {
|
|
18593
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
18594
|
+
detach?: boolean;
|
|
18595
|
+
};
|
|
18533
18596
|
header?: never;
|
|
18534
18597
|
path: {
|
|
18535
18598
|
/** @description Unique identifier for a space_id */
|
|
@@ -19401,7 +19464,10 @@ interface operations {
|
|
|
19401
19464
|
};
|
|
19402
19465
|
DeleteChangeOrder: {
|
|
19403
19466
|
parameters: {
|
|
19404
|
-
query?:
|
|
19467
|
+
query?: {
|
|
19468
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
19469
|
+
detach?: boolean;
|
|
19470
|
+
};
|
|
19405
19471
|
header?: never;
|
|
19406
19472
|
path: {
|
|
19407
19473
|
/** @description Unique identifier for a space_id */
|
|
@@ -20086,7 +20152,10 @@ interface operations {
|
|
|
20086
20152
|
};
|
|
20087
20153
|
DeleteChangeSet: {
|
|
20088
20154
|
parameters: {
|
|
20089
|
-
query?:
|
|
20155
|
+
query?: {
|
|
20156
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
20157
|
+
detach?: boolean;
|
|
20158
|
+
};
|
|
20090
20159
|
header?: never;
|
|
20091
20160
|
path: {
|
|
20092
20161
|
/** @description Unique identifier for a space_id */
|
|
@@ -23840,7 +23909,10 @@ interface operations {
|
|
|
23840
23909
|
};
|
|
23841
23910
|
DeleteRelease: {
|
|
23842
23911
|
parameters: {
|
|
23843
|
-
query?:
|
|
23912
|
+
query?: {
|
|
23913
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
23914
|
+
detach?: boolean;
|
|
23915
|
+
};
|
|
23844
23916
|
header?: never;
|
|
23845
23917
|
path: {
|
|
23846
23918
|
/** @description Unique identifier for a space_id */
|
|
@@ -24256,7 +24328,7 @@ interface operations {
|
|
|
24256
24328
|
* An example conjunction is:
|
|
24257
24329
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24258
24330
|
*
|
|
24259
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
24331
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
24260
24332
|
*
|
|
24261
24333
|
* The whole string must be query-encoded.
|
|
24262
24334
|
*/
|
|
@@ -24677,7 +24749,10 @@ interface operations {
|
|
|
24677
24749
|
};
|
|
24678
24750
|
DeleteTag: {
|
|
24679
24751
|
parameters: {
|
|
24680
|
-
query?:
|
|
24752
|
+
query?: {
|
|
24753
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
24754
|
+
detach?: boolean;
|
|
24755
|
+
};
|
|
24681
24756
|
header?: never;
|
|
24682
24757
|
path: {
|
|
24683
24758
|
/** @description Unique identifier for a space_id */
|
|
@@ -25345,7 +25420,10 @@ interface operations {
|
|
|
25345
25420
|
};
|
|
25346
25421
|
DeleteTarget: {
|
|
25347
25422
|
parameters: {
|
|
25348
|
-
query?:
|
|
25423
|
+
query?: {
|
|
25424
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
25425
|
+
detach?: boolean;
|
|
25426
|
+
};
|
|
25349
25427
|
header?: never;
|
|
25350
25428
|
path: {
|
|
25351
25429
|
/** @description Unique identifier for a space_id */
|
|
@@ -26899,7 +26977,10 @@ interface operations {
|
|
|
26899
26977
|
};
|
|
26900
26978
|
DeleteUnit: {
|
|
26901
26979
|
parameters: {
|
|
26902
|
-
query?:
|
|
26980
|
+
query?: {
|
|
26981
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
26982
|
+
detach?: boolean;
|
|
26983
|
+
};
|
|
26903
26984
|
header?: never;
|
|
26904
26985
|
path: {
|
|
26905
26986
|
/** @description Unique identifier for a space_id */
|
|
@@ -30180,7 +30261,7 @@ interface operations {
|
|
|
30180
30261
|
* An example conjunction is:
|
|
30181
30262
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30182
30263
|
*
|
|
30183
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30264
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30184
30265
|
*
|
|
30185
30266
|
* The whole string must be query-encoded.
|
|
30186
30267
|
*/
|
|
@@ -30348,7 +30429,7 @@ interface operations {
|
|
|
30348
30429
|
* An example conjunction is:
|
|
30349
30430
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30350
30431
|
*
|
|
30351
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30432
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30352
30433
|
*
|
|
30353
30434
|
* The whole string must be query-encoded.
|
|
30354
30435
|
*/
|
|
@@ -30610,7 +30691,7 @@ interface operations {
|
|
|
30610
30691
|
* An example conjunction is:
|
|
30611
30692
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30612
30693
|
*
|
|
30613
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30694
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30614
30695
|
*
|
|
30615
30696
|
* The whole string must be query-encoded.
|
|
30616
30697
|
*/
|
|
@@ -30657,6 +30738,8 @@ interface operations {
|
|
|
30657
30738
|
* The whole string must be query-encoded.
|
|
30658
30739
|
*/
|
|
30659
30740
|
include?: string;
|
|
30741
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
30742
|
+
detach?: boolean;
|
|
30660
30743
|
};
|
|
30661
30744
|
header?: never;
|
|
30662
30745
|
path?: never;
|
|
@@ -30794,7 +30877,7 @@ interface operations {
|
|
|
30794
30877
|
* An example conjunction is:
|
|
30795
30878
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30796
30879
|
*
|
|
30797
|
-
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30880
|
+
* Supported attributes for filtering on Tag: Annotations, ChangeOrderID, ChangeSetID, CreatedAt, DeleteGates, DisplayName, Labels, OrganizationID, ReleaseID, Slug, SpaceID, TagID, UpdatedAt.
|
|
30798
30881
|
*
|
|
30799
30882
|
* The whole string must be query-encoded.
|
|
30800
30883
|
*/
|
|
@@ -31207,6 +31290,8 @@ interface operations {
|
|
|
31207
31290
|
* The whole string must be query-encoded.
|
|
31208
31291
|
*/
|
|
31209
31292
|
include?: string;
|
|
31293
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
31294
|
+
detach?: boolean;
|
|
31210
31295
|
};
|
|
31211
31296
|
header?: never;
|
|
31212
31297
|
path?: never;
|
|
@@ -33011,6 +33096,8 @@ interface operations {
|
|
|
33011
33096
|
* The whole string must be query-encoded.
|
|
33012
33097
|
*/
|
|
33013
33098
|
include?: string;
|
|
33099
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
33100
|
+
detach?: boolean;
|
|
33014
33101
|
};
|
|
33015
33102
|
header?: never;
|
|
33016
33103
|
path?: never;
|
|
@@ -33806,6 +33893,189 @@ interface operations {
|
|
|
33806
33893
|
};
|
|
33807
33894
|
};
|
|
33808
33895
|
};
|
|
33896
|
+
BulkMoveUnits: {
|
|
33897
|
+
parameters: {
|
|
33898
|
+
query?: {
|
|
33899
|
+
/**
|
|
33900
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
33901
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
33902
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
33903
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
33904
|
+
* as in the JSON encoding.
|
|
33905
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
33906
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
33907
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
33908
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
33909
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
33910
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
33911
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
33912
|
+
* UUID and time literals must be quoted as string literals.
|
|
33913
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
33914
|
+
* Time literals use the same form as when serialized as JSON,
|
|
33915
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
33916
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
33917
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
33918
|
+
* as in `ApprovedBy ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
33919
|
+
* Arrays can perform LEN() to check for length, as in `LEN(ApprovedBy) > 0`.
|
|
33920
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
33921
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
33922
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
33923
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
33924
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
33925
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
33926
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
33927
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
33928
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
33929
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
33930
|
+
* Conjunctions are supported using the `AND` operator.
|
|
33931
|
+
* An example conjunction is:
|
|
33932
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
33933
|
+
*
|
|
33934
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ApprovedBy, BridgeWorkerID, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, TargetOptions, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationWarnings, Values.
|
|
33935
|
+
*
|
|
33936
|
+
* 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`.
|
|
33937
|
+
*
|
|
33938
|
+
* The whole string must be query-encoded.
|
|
33939
|
+
*/
|
|
33940
|
+
where?: string;
|
|
33941
|
+
/**
|
|
33942
|
+
* @description UUID of a Filter entity to apply to the Unit list.
|
|
33943
|
+
*
|
|
33944
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
33945
|
+
*
|
|
33946
|
+
* The Filter's From field must match the entity type being filtered (Unit).
|
|
33947
|
+
*
|
|
33948
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
33949
|
+
*
|
|
33950
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
33951
|
+
*
|
|
33952
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
33953
|
+
*/
|
|
33954
|
+
filter?: string;
|
|
33955
|
+
/**
|
|
33956
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
33957
|
+
*
|
|
33958
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
33959
|
+
*
|
|
33960
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
33961
|
+
*
|
|
33962
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
33963
|
+
*
|
|
33964
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
33965
|
+
*
|
|
33966
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
33967
|
+
*
|
|
33968
|
+
* Searchable fields for Unit include string and map-type attributes from the queryable attributes list.
|
|
33969
|
+
*
|
|
33970
|
+
* The whole string must be query-encoded.
|
|
33971
|
+
*/
|
|
33972
|
+
contains?: string;
|
|
33973
|
+
/**
|
|
33974
|
+
* @description Include clause for expanding related entities in the response for Unit.
|
|
33975
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
33976
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
33977
|
+
*
|
|
33978
|
+
* Supported attributes for Unit are ApprovedBy, BridgeWorkerID, ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
33979
|
+
*
|
|
33980
|
+
* The whole string must be query-encoded.
|
|
33981
|
+
*/
|
|
33982
|
+
include?: string;
|
|
33983
|
+
/** @description Report what the move would do, and what would stop it, without moving anything */
|
|
33984
|
+
dry_run?: boolean;
|
|
33985
|
+
};
|
|
33986
|
+
header?: never;
|
|
33987
|
+
path?: never;
|
|
33988
|
+
cookie?: never;
|
|
33989
|
+
};
|
|
33990
|
+
requestBody?: {
|
|
33991
|
+
content: {
|
|
33992
|
+
"application/json": components["schemas"]["UnitMoveRequest"];
|
|
33993
|
+
};
|
|
33994
|
+
};
|
|
33995
|
+
responses: {
|
|
33996
|
+
/** @description OK */
|
|
33997
|
+
200: {
|
|
33998
|
+
headers: {
|
|
33999
|
+
[name: string]: unknown;
|
|
34000
|
+
};
|
|
34001
|
+
content: {
|
|
34002
|
+
"application/json": components["schemas"]["UnitMoveResponse"][];
|
|
34003
|
+
};
|
|
34004
|
+
};
|
|
34005
|
+
/** @description Multi-Status: nothing was moved, or some Units moved and others did not */
|
|
34006
|
+
207: {
|
|
34007
|
+
headers: {
|
|
34008
|
+
[name: string]: unknown;
|
|
34009
|
+
};
|
|
34010
|
+
content: {
|
|
34011
|
+
"application/json": components["schemas"]["UnitMoveResponse"][];
|
|
34012
|
+
};
|
|
34013
|
+
};
|
|
34014
|
+
/** @description Unit request is invalid (Bad Request). */
|
|
34015
|
+
400: {
|
|
34016
|
+
headers: {
|
|
34017
|
+
[name: string]: unknown;
|
|
34018
|
+
};
|
|
34019
|
+
content: {
|
|
34020
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34021
|
+
};
|
|
34022
|
+
};
|
|
34023
|
+
/** @description Unauthorized access. */
|
|
34024
|
+
401: {
|
|
34025
|
+
headers: {
|
|
34026
|
+
[name: string]: unknown;
|
|
34027
|
+
};
|
|
34028
|
+
content: {
|
|
34029
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34030
|
+
};
|
|
34031
|
+
};
|
|
34032
|
+
/** @description Forbidden access. */
|
|
34033
|
+
403: {
|
|
34034
|
+
headers: {
|
|
34035
|
+
[name: string]: unknown;
|
|
34036
|
+
};
|
|
34037
|
+
content: {
|
|
34038
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34039
|
+
};
|
|
34040
|
+
};
|
|
34041
|
+
/** @description Unit not found. */
|
|
34042
|
+
404: {
|
|
34043
|
+
headers: {
|
|
34044
|
+
[name: string]: unknown;
|
|
34045
|
+
};
|
|
34046
|
+
content: {
|
|
34047
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34048
|
+
};
|
|
34049
|
+
};
|
|
34050
|
+
/** @description Unit data conflict. Data has changed since last read. */
|
|
34051
|
+
409: {
|
|
34052
|
+
headers: {
|
|
34053
|
+
[name: string]: unknown;
|
|
34054
|
+
};
|
|
34055
|
+
content: {
|
|
34056
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34057
|
+
};
|
|
34058
|
+
};
|
|
34059
|
+
/** @description Something went wrong while processing Unit. */
|
|
34060
|
+
500: {
|
|
34061
|
+
headers: {
|
|
34062
|
+
[name: string]: unknown;
|
|
34063
|
+
};
|
|
34064
|
+
content: {
|
|
34065
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34066
|
+
};
|
|
34067
|
+
};
|
|
34068
|
+
/** @description Unexpected error. */
|
|
34069
|
+
default: {
|
|
34070
|
+
headers: {
|
|
34071
|
+
[name: string]: unknown;
|
|
34072
|
+
};
|
|
34073
|
+
content: {
|
|
34074
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
34075
|
+
};
|
|
34076
|
+
};
|
|
34077
|
+
};
|
|
34078
|
+
};
|
|
33809
34079
|
BulkTagUnits: {
|
|
33810
34080
|
parameters: {
|
|
33811
34081
|
query?: {
|