@confighub/api 0.8.38 → 0.9.0
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 +830 -161
- package/dist/index.d.ts +830 -161
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1260,7 +1260,7 @@ interface paths {
|
|
|
1260
1260
|
patch: operations["PatchServiceAccount"];
|
|
1261
1261
|
trace?: never;
|
|
1262
1262
|
};
|
|
1263
|
-
"/service_account/{service_account_id}/
|
|
1263
|
+
"/service_account/{service_account_id}/user_key": {
|
|
1264
1264
|
parameters: {
|
|
1265
1265
|
query?: never;
|
|
1266
1266
|
header?: never;
|
|
@@ -1271,40 +1271,44 @@ interface paths {
|
|
|
1271
1271
|
* List a service account's public keys
|
|
1272
1272
|
* @description List the public keys registered for a service account. Keys are returned unredacted, deliberately: they are public material, and an operator noticing a key nobody registered is how an injected one is caught. Requires View permission on the service account.
|
|
1273
1273
|
*/
|
|
1274
|
-
get: operations["
|
|
1274
|
+
get: operations["ListServiceAccountUserKeys"];
|
|
1275
1275
|
put?: never;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* Register a public key for a service account
|
|
1278
1278
|
* @description Register a public key for a service account. The holder of the matching private key then authenticates as the service account by signing a short-lived assertion (RFC 7523 private_key_jwt), so no secret is exchanged and none is stored. Requires Impersonate permission on the service account, which Manage does not include; a service account cannot register a key for itself.
|
|
1279
1279
|
*/
|
|
1280
|
-
post: operations["
|
|
1280
|
+
post: operations["CreateServiceAccountUserKey"];
|
|
1281
1281
|
delete?: never;
|
|
1282
1282
|
options?: never;
|
|
1283
1283
|
head?: never;
|
|
1284
1284
|
patch?: never;
|
|
1285
1285
|
trace?: never;
|
|
1286
1286
|
};
|
|
1287
|
-
"/service_account/{service_account_id}/
|
|
1287
|
+
"/service_account/{service_account_id}/user_key/{user_key_id}": {
|
|
1288
1288
|
parameters: {
|
|
1289
1289
|
query?: never;
|
|
1290
1290
|
header?: never;
|
|
1291
1291
|
path?: never;
|
|
1292
1292
|
cookie?: never;
|
|
1293
1293
|
};
|
|
1294
|
-
|
|
1294
|
+
/**
|
|
1295
|
+
* Get a service account's public key
|
|
1296
|
+
* @description Get one of the public keys registered for a service account, unredacted. Requires View permission on the service account.
|
|
1297
|
+
*/
|
|
1298
|
+
get: operations["GetServiceAccountUserKey"];
|
|
1295
1299
|
put?: never;
|
|
1296
1300
|
post?: never;
|
|
1297
1301
|
/**
|
|
1298
1302
|
* Remove a public key from a service account
|
|
1299
|
-
* @description Remove one of a service account's public keys
|
|
1303
|
+
* @description Remove one of a service account's public keys. This is the second half of rotation, and the response to a compromised private key. Requires Impersonate permission on the service account.
|
|
1300
1304
|
*/
|
|
1301
|
-
delete: operations["
|
|
1305
|
+
delete: operations["DeleteServiceAccountUserKey"];
|
|
1302
1306
|
options?: never;
|
|
1303
1307
|
head?: never;
|
|
1304
1308
|
patch?: never;
|
|
1305
1309
|
trace?: never;
|
|
1306
1310
|
};
|
|
1307
|
-
"/service_account/{service_account_id}/
|
|
1311
|
+
"/service_account/{service_account_id}/user_token": {
|
|
1308
1312
|
parameters: {
|
|
1309
1313
|
query?: never;
|
|
1310
1314
|
header?: never;
|
|
@@ -1315,34 +1319,58 @@ interface paths {
|
|
|
1315
1319
|
* List a service account's long-lived tokens
|
|
1316
1320
|
* @description List the long-lived tokens issued to a service account, revoked ones included. The tokens themselves are not returned; each entry carries the jti, who issued it, when it was last used, and whether it has been revoked. Requires View permission on the service account.
|
|
1317
1321
|
*/
|
|
1318
|
-
get: operations["
|
|
1322
|
+
get: operations["ListServiceAccountUserTokens"];
|
|
1319
1323
|
put?: never;
|
|
1320
1324
|
/**
|
|
1321
1325
|
* Issue a long-lived token for a service account
|
|
1322
|
-
* @description Issue a token with no expiry (or the given ExpiresAt) that authenticates as the service account, for consumers that can hold only a static credential, such as a registry Secret. The token is returned once and never stored;
|
|
1326
|
+
* @description Issue a token with no expiry (or the given ExpiresAt) that authenticates as the service account, for consumers that can hold only a static credential, such as a registry Secret. The token is returned once and never stored; its record can be revoked or deleted. Requires Impersonate permission on the service account, which Manage does not include; a service account cannot issue a token for itself.
|
|
1323
1327
|
*/
|
|
1324
|
-
post: operations["
|
|
1328
|
+
post: operations["CreateServiceAccountUserToken"];
|
|
1325
1329
|
delete?: never;
|
|
1326
1330
|
options?: never;
|
|
1327
1331
|
head?: never;
|
|
1328
1332
|
patch?: never;
|
|
1329
1333
|
trace?: never;
|
|
1330
1334
|
};
|
|
1331
|
-
"/service_account/{service_account_id}/
|
|
1335
|
+
"/service_account/{service_account_id}/user_token/{user_token_id}": {
|
|
1332
1336
|
parameters: {
|
|
1333
1337
|
query?: never;
|
|
1334
1338
|
header?: never;
|
|
1335
1339
|
path?: never;
|
|
1336
1340
|
cookie?: never;
|
|
1337
1341
|
};
|
|
1338
|
-
|
|
1342
|
+
/**
|
|
1343
|
+
* Get a service account's long-lived token
|
|
1344
|
+
* @description Get the record of one long-lived token issued to a service account. The token itself is not returned. Requires View permission on the service account.
|
|
1345
|
+
*/
|
|
1346
|
+
get: operations["GetServiceAccountUserToken"];
|
|
1339
1347
|
put?: never;
|
|
1340
1348
|
post?: never;
|
|
1349
|
+
/**
|
|
1350
|
+
* Delete a service account's long-lived token
|
|
1351
|
+
* @description Delete one token's record. A token that is still live stops working within a minute on every server, as a revoked one does, and is refused afterwards as unknown. Revoke instead to keep the record. Requires Impersonate permission on the service account.
|
|
1352
|
+
*/
|
|
1353
|
+
delete: operations["DeleteServiceAccountUserToken"];
|
|
1354
|
+
options?: never;
|
|
1355
|
+
head?: never;
|
|
1356
|
+
patch?: never;
|
|
1357
|
+
trace?: never;
|
|
1358
|
+
};
|
|
1359
|
+
"/service_account/{service_account_id}/user_token/{user_token_id}/revoke": {
|
|
1360
|
+
parameters: {
|
|
1361
|
+
query?: never;
|
|
1362
|
+
header?: never;
|
|
1363
|
+
path?: never;
|
|
1364
|
+
cookie?: never;
|
|
1365
|
+
};
|
|
1366
|
+
get?: never;
|
|
1367
|
+
put?: never;
|
|
1341
1368
|
/**
|
|
1342
1369
|
* Revoke a service account's long-lived token
|
|
1343
|
-
* @description Revoke one token
|
|
1370
|
+
* @description Revoke one token. The token stops working within a minute on every server; the record stays, marked revoked, and is returned. Revoking a revoked token is not an error. Requires Impersonate permission on the service account.
|
|
1344
1371
|
*/
|
|
1345
|
-
|
|
1372
|
+
post: operations["RevokeServiceAccountUserToken"];
|
|
1373
|
+
delete?: never;
|
|
1346
1374
|
options?: never;
|
|
1347
1375
|
head?: never;
|
|
1348
1376
|
patch?: never;
|
|
@@ -2012,7 +2040,7 @@ interface paths {
|
|
|
2012
2040
|
put?: never;
|
|
2013
2041
|
/**
|
|
2014
2042
|
* Run a command on a Channel
|
|
2015
|
-
* @description Creates a run of the command on a Channel of the Space: the one named by ChannelID, or else the one Channel in the Space that declares the command. Running a command takes Use on the Channel. The run is returned Pending; read it back with GET, with ?wait=<seconds> to hold until it completes.
|
|
2043
|
+
* @description Creates a run of the command on a Channel of the Space: the one named by ChannelID, or else the one Channel in the Space that declares the command. Running a command takes Use on the Channel. The run is returned Pending; read it back with GET, with ?wait=<seconds> to hold until it completes. A command that does not resolve to one Channel is refused with a CommandRunRefusal, whose Reason says why.
|
|
2016
2044
|
*/
|
|
2017
2045
|
post: operations["CreateCommandRun"];
|
|
2018
2046
|
delete?: never;
|
|
@@ -2888,7 +2916,7 @@ interface paths {
|
|
|
2888
2916
|
put?: never;
|
|
2889
2917
|
/**
|
|
2890
2918
|
* Set path protection on a unit
|
|
2891
|
-
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. A merge's WhereMutation protects further paths on top of these. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2919
|
+
* @description Set Protected values on the unit's MutationSources, marking paths as local overrides a merge must not overwrite when subtraction is disabled. A merge's WhereMutation protects further paths on top of these. UnprotectAll clears every Protected value before ResourceProtection is applied. Creates a new revision only if the protection actually changes. Requires Edit permission.
|
|
2892
2920
|
*/
|
|
2893
2921
|
post: operations["SetUnitProtection"];
|
|
2894
2922
|
delete?: never;
|
|
@@ -5298,7 +5326,7 @@ interface components {
|
|
|
5298
5326
|
/**
|
|
5299
5327
|
* Format: date-time
|
|
5300
5328
|
* @description When the run was created, in "2023-01-01T12:00:00Z" format.
|
|
5301
|
-
* @example
|
|
5329
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5302
5330
|
*/
|
|
5303
5331
|
readonly CreatedAt?: string;
|
|
5304
5332
|
/**
|
|
@@ -5319,8 +5347,12 @@ interface components {
|
|
|
5319
5347
|
* @example 2006-01-02T15:04:05Z07:00
|
|
5320
5348
|
*/
|
|
5321
5349
|
readonly DeliveredAt?: string;
|
|
5350
|
+
/** @description The type of entity. */
|
|
5351
|
+
readonly EntityType?: string;
|
|
5322
5352
|
/** @description ErrorMessage explains a Failed or Rejected run. */
|
|
5323
5353
|
readonly ErrorMessage?: string;
|
|
5354
|
+
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
5355
|
+
HiddenReason?: string;
|
|
5324
5356
|
/**
|
|
5325
5357
|
* Format: uuid
|
|
5326
5358
|
* @description OrganizationID of the Space the run is in.
|
|
@@ -5341,12 +5373,6 @@ interface components {
|
|
|
5341
5373
|
readonly SpaceSlug?: string;
|
|
5342
5374
|
/** @description Status is where the run is: Pending, Delivered, Completed, Failed, Rejected, Canceled, Expired or TimedOut. */
|
|
5343
5375
|
readonly Status?: string;
|
|
5344
|
-
/**
|
|
5345
|
-
* Format: uuid
|
|
5346
|
-
* @description TargetID is the Target the run is about, if any. For the record; not a foreign key.
|
|
5347
|
-
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5348
|
-
*/
|
|
5349
|
-
TargetID?: string;
|
|
5350
5376
|
/**
|
|
5351
5377
|
* Format: date-time
|
|
5352
5378
|
* @description TimeoutAt is when a Delivered run times out if the client has reported nothing.
|
|
@@ -5354,16 +5380,26 @@ interface components {
|
|
|
5354
5380
|
*/
|
|
5355
5381
|
readonly TimeoutAt?: string;
|
|
5356
5382
|
/**
|
|
5357
|
-
* Format:
|
|
5358
|
-
* @description
|
|
5359
|
-
* @example
|
|
5383
|
+
* Format: date-time
|
|
5384
|
+
* @description When the run last changed: created, delivered, returned to Pending, or closed, in "2023-01-01T12:00:00Z" format.
|
|
5385
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5360
5386
|
*/
|
|
5361
|
-
|
|
5387
|
+
readonly UpdatedAt?: string;
|
|
5362
5388
|
/**
|
|
5363
5389
|
* Format: int64
|
|
5364
|
-
* @description An entity-specific sequence number used for optimistic concurrency control.
|
|
5390
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. A run is not updated by its callers, so they never send it.
|
|
5365
5391
|
*/
|
|
5366
|
-
|
|
5392
|
+
Version?: number;
|
|
5393
|
+
};
|
|
5394
|
+
CommandRunRefusal: {
|
|
5395
|
+
/** @description The Channels in the Space that declare the command, when several do: name one as ChannelID. */
|
|
5396
|
+
Channels?: components["schemas"]["DeclaredCommand"][];
|
|
5397
|
+
/** @description The refusal as an error, as every error response carries one. */
|
|
5398
|
+
Error?: components["schemas"]["ResponseError"];
|
|
5399
|
+
/** @description Why the run was refused, for a person. */
|
|
5400
|
+
Message?: string;
|
|
5401
|
+
/** @description Why the run was refused, as a code: CommandNotDeclared, CommandDeclaredByMany or ChannelDoesNotDeclare. */
|
|
5402
|
+
Reason?: string;
|
|
5367
5403
|
};
|
|
5368
5404
|
/** @description CommandRunResult is what a Channel's client reports for a run it executed: Completed with a Result, or Failed or Rejected with an ErrorMessage. */
|
|
5369
5405
|
CommandRunResult: {
|
|
@@ -5809,6 +5845,18 @@ interface components {
|
|
|
5809
5845
|
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5810
5846
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5811
5847
|
};
|
|
5848
|
+
/** @description CommandRun with additional related entities expanded based on the request's include parameter. */
|
|
5849
|
+
ExtendedCommandRun: {
|
|
5850
|
+
/** @description The Channel the run is delivered on. */
|
|
5851
|
+
Channel?: components["schemas"]["Channel"];
|
|
5852
|
+
/** @description The CommandRun. */
|
|
5853
|
+
CommandRun?: components["schemas"]["CommandRun"];
|
|
5854
|
+
Organization?: components["schemas"]["Organization"];
|
|
5855
|
+
/** @description The Space the run is in: its Channel's. */
|
|
5856
|
+
Space?: components["schemas"]["Space"];
|
|
5857
|
+
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
5858
|
+
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
5859
|
+
};
|
|
5812
5860
|
ExtendedComponent: {
|
|
5813
5861
|
Component?: components["schemas"]["Component"];
|
|
5814
5862
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -5835,6 +5883,7 @@ interface components {
|
|
|
5835
5883
|
};
|
|
5836
5884
|
ExtendedInvocation: {
|
|
5837
5885
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
5886
|
+
Channel?: components["schemas"]["Channel"];
|
|
5838
5887
|
Error?: components["schemas"]["ResponseError"];
|
|
5839
5888
|
Invocation?: components["schemas"]["Invocation"];
|
|
5840
5889
|
Organization?: components["schemas"]["Organization"];
|
|
@@ -6021,6 +6070,7 @@ interface components {
|
|
|
6021
6070
|
};
|
|
6022
6071
|
ExtendedTrigger: {
|
|
6023
6072
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
6073
|
+
Channel?: components["schemas"]["Channel"];
|
|
6024
6074
|
Error?: components["schemas"]["ResponseError"];
|
|
6025
6075
|
Invocation?: components["schemas"]["Invocation"];
|
|
6026
6076
|
Organization?: components["schemas"]["Organization"];
|
|
@@ -6064,6 +6114,14 @@ interface components {
|
|
|
6064
6114
|
/** @description The values of the columns of the View named by the view parameter, in the View's column order. A column that selects several values, such as one with a wildcard, has an entry for each, all with the column's Name. */
|
|
6065
6115
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
6066
6116
|
};
|
|
6117
|
+
ExtendedUserKey: {
|
|
6118
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6119
|
+
UserKey?: components["schemas"]["UserKey"];
|
|
6120
|
+
};
|
|
6121
|
+
ExtendedUserToken: {
|
|
6122
|
+
Error?: components["schemas"]["ResponseError"];
|
|
6123
|
+
UserToken?: components["schemas"]["UserToken"];
|
|
6124
|
+
};
|
|
6067
6125
|
ExtendedView: {
|
|
6068
6126
|
Error?: components["schemas"]["ResponseError"];
|
|
6069
6127
|
Filter?: components["schemas"]["Filter"];
|
|
@@ -6425,10 +6483,16 @@ interface components {
|
|
|
6425
6483
|
readonly BackingUnitID?: string;
|
|
6426
6484
|
/**
|
|
6427
6485
|
* Format: uuid
|
|
6428
|
-
* @description Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If
|
|
6486
|
+
* @description Unique identifier for a Bridge Worker to execute the functions specified by the Invocation. If neither it nor ChannelID is specified, use the builtin function executor.
|
|
6429
6487
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6430
6488
|
*/
|
|
6431
6489
|
BridgeWorkerID?: string;
|
|
6490
|
+
/**
|
|
6491
|
+
* Format: uuid
|
|
6492
|
+
* @description Unique identifier for a Channel whose client executes the functions specified by the Invocation. At most one of BridgeWorkerID and ChannelID is set.
|
|
6493
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6494
|
+
*/
|
|
6495
|
+
ChannelID?: string;
|
|
6432
6496
|
/**
|
|
6433
6497
|
* Format: date-time
|
|
6434
6498
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -6726,6 +6790,11 @@ interface components {
|
|
|
6726
6790
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6727
6791
|
*/
|
|
6728
6792
|
BridgeWorkerID?: string;
|
|
6793
|
+
/**
|
|
6794
|
+
* Format: uuid
|
|
6795
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6796
|
+
*/
|
|
6797
|
+
ChannelID?: string;
|
|
6729
6798
|
/**
|
|
6730
6799
|
* Format: date-time
|
|
6731
6800
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -8325,7 +8394,7 @@ interface components {
|
|
|
8325
8394
|
* An example conjunction is:
|
|
8326
8395
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8327
8396
|
*
|
|
8328
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
8397
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
8329
8398
|
*
|
|
8330
8399
|
* The whole string must be query-encoded.
|
|
8331
8400
|
*/
|
|
@@ -8553,7 +8622,7 @@ interface components {
|
|
|
8553
8622
|
* An example conjunction is:
|
|
8554
8623
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8555
8624
|
*
|
|
8556
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
8625
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
8557
8626
|
*
|
|
8558
8627
|
* The whole string must be query-encoded.
|
|
8559
8628
|
*/
|
|
@@ -8588,10 +8657,16 @@ interface components {
|
|
|
8588
8657
|
readonly BackingUnitID?: string;
|
|
8589
8658
|
/**
|
|
8590
8659
|
* Format: uuid
|
|
8591
|
-
* @description Unique identifier for a Bridge Worker to execute the function specified by the Trigger. If
|
|
8660
|
+
* @description Unique identifier for a Bridge Worker to execute the function specified by the Trigger. If neither it nor ChannelID is specified, use the builtin function executor.
|
|
8592
8661
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8593
8662
|
*/
|
|
8594
8663
|
BridgeWorkerID?: string;
|
|
8664
|
+
/**
|
|
8665
|
+
* Format: uuid
|
|
8666
|
+
* @description Unique identifier for a Channel whose client executes the function specified by the Trigger. At most one of BridgeWorkerID and ChannelID is set. A Trigger that references an Invocation takes the Invocation's.
|
|
8667
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8668
|
+
*/
|
|
8669
|
+
ChannelID?: string;
|
|
8595
8670
|
Clearance?: components["schemas"]["Clearance"];
|
|
8596
8671
|
/**
|
|
8597
8672
|
* Format: date-time
|
|
@@ -8617,7 +8692,7 @@ interface components {
|
|
|
8617
8692
|
readonly EntityType?: string;
|
|
8618
8693
|
/** @description Event specifies the type of event that will activate this trigger. Valid values are Mutation and PostClone */
|
|
8619
8694
|
Event: string;
|
|
8620
|
-
/** @description Duration after which a disconnected BridgeWorker's triggers are treated as fail-open. Can only be set when BridgeWorkerID is set. */
|
|
8695
|
+
/** @description Duration after which a disconnected BridgeWorker's triggers are treated as fail-open. Can only be set when BridgeWorkerID is set. A Trigger on a Channel fails closed instead: it waits for the Channel's client. */
|
|
8621
8696
|
FailOpenAfter?: number | null;
|
|
8622
8697
|
/** @description Function name */
|
|
8623
8698
|
FunctionName?: string;
|
|
@@ -9267,6 +9342,8 @@ interface components {
|
|
|
9267
9342
|
UnitProtectionRequest: {
|
|
9268
9343
|
/** @description Per-resource Protected edits to apply to the Unit's MutationSources */
|
|
9269
9344
|
ResourceProtection?: components["schemas"]["ResourceProtection"][] | null;
|
|
9345
|
+
/** @description Clear every Protected value on the Unit's MutationSources before applying ResourceProtection */
|
|
9346
|
+
UnprotectAll?: boolean;
|
|
9270
9347
|
};
|
|
9271
9348
|
UnitProtectionResponse: {
|
|
9272
9349
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -9588,15 +9665,22 @@ interface components {
|
|
|
9588
9665
|
UserKey: {
|
|
9589
9666
|
/**
|
|
9590
9667
|
* Format: date-time
|
|
9591
|
-
* @
|
|
9668
|
+
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
9669
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
9592
9670
|
*/
|
|
9593
|
-
CreatedAt?: string;
|
|
9671
|
+
readonly CreatedAt?: string;
|
|
9594
9672
|
Description?: string;
|
|
9673
|
+
/** @description Friendly name for the entity. */
|
|
9674
|
+
DisplayName?: string;
|
|
9675
|
+
/** @description The type of entity. */
|
|
9676
|
+
readonly EntityType?: string;
|
|
9595
9677
|
/**
|
|
9596
9678
|
* Format: date-time
|
|
9597
9679
|
* @example 2006-01-02T15:04:05Z07:00
|
|
9598
9680
|
*/
|
|
9599
9681
|
ExpiresAt?: string;
|
|
9682
|
+
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
9683
|
+
HiddenReason?: string;
|
|
9600
9684
|
Kid?: string;
|
|
9601
9685
|
/**
|
|
9602
9686
|
* Format: date-time
|
|
@@ -9604,6 +9688,14 @@ interface components {
|
|
|
9604
9688
|
*/
|
|
9605
9689
|
LastUsedAt?: string;
|
|
9606
9690
|
PublicJWK?: unknown;
|
|
9691
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
9692
|
+
Slug: string;
|
|
9693
|
+
/**
|
|
9694
|
+
* Format: date-time
|
|
9695
|
+
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
9696
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
9697
|
+
*/
|
|
9698
|
+
readonly UpdatedAt?: string;
|
|
9607
9699
|
/**
|
|
9608
9700
|
* Format: uuid
|
|
9609
9701
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
@@ -9614,15 +9706,20 @@ interface components {
|
|
|
9614
9706
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9615
9707
|
*/
|
|
9616
9708
|
UserKeyID?: string;
|
|
9709
|
+
/**
|
|
9710
|
+
* Format: int64
|
|
9711
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
9712
|
+
*/
|
|
9713
|
+
Version?: number;
|
|
9617
9714
|
};
|
|
9618
9715
|
/** @description The record of a long-lived token issued to a ServiceAccount. The token itself is shown once, when it is issued, and is not stored; this record is what lets it be listed, traced to whoever issued it, and revoked on its own. */
|
|
9619
9716
|
UserToken: {
|
|
9620
9717
|
/**
|
|
9621
9718
|
* Format: date-time
|
|
9622
9719
|
* @description When the token was issued. (readonly)
|
|
9623
|
-
* @example
|
|
9720
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
9624
9721
|
*/
|
|
9625
|
-
CreatedAt?: string;
|
|
9722
|
+
readonly CreatedAt?: string;
|
|
9626
9723
|
/**
|
|
9627
9724
|
* Format: uuid
|
|
9628
9725
|
* @description The User who issued the token. A token is never issued by the identity it authenticates as. (readonly)
|
|
@@ -9631,13 +9728,19 @@ interface components {
|
|
|
9631
9728
|
CreatedByUserID?: string;
|
|
9632
9729
|
/** @description Which system holds the token, so it can be retired without guessing what breaks. */
|
|
9633
9730
|
Description?: string;
|
|
9731
|
+
/** @description Friendly name for the entity. */
|
|
9732
|
+
DisplayName?: string;
|
|
9733
|
+
/** @description The type of entity. */
|
|
9734
|
+
readonly EntityType?: string;
|
|
9634
9735
|
/**
|
|
9635
9736
|
* Format: date-time
|
|
9636
9737
|
* @description When the token stops working. Zero when it does not expire.
|
|
9637
9738
|
* @example 2006-01-02T15:04:05Z07:00
|
|
9638
9739
|
*/
|
|
9639
9740
|
ExpiresAt?: string;
|
|
9640
|
-
/** @description The
|
|
9741
|
+
/** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
|
|
9742
|
+
HiddenReason?: string;
|
|
9743
|
+
/** @description The token's jti claim, which the token carries; a where clause names a token by it, as cub does. (readonly) */
|
|
9641
9744
|
Jti?: string;
|
|
9642
9745
|
/**
|
|
9643
9746
|
* Format: date-time
|
|
@@ -9651,6 +9754,14 @@ interface components {
|
|
|
9651
9754
|
* @example 2006-01-02T15:04:05Z07:00
|
|
9652
9755
|
*/
|
|
9653
9756
|
RevokedAt?: string;
|
|
9757
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
9758
|
+
Slug: string;
|
|
9759
|
+
/**
|
|
9760
|
+
* Format: date-time
|
|
9761
|
+
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
9762
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
9763
|
+
*/
|
|
9764
|
+
readonly UpdatedAt?: string;
|
|
9654
9765
|
/**
|
|
9655
9766
|
* Format: uuid
|
|
9656
9767
|
* @description The User the token authenticates as: the ServiceAccount's User. (readonly)
|
|
@@ -9659,10 +9770,15 @@ interface components {
|
|
|
9659
9770
|
UserID?: string;
|
|
9660
9771
|
/**
|
|
9661
9772
|
* Format: uuid
|
|
9662
|
-
* @description Unique identifier for the record. (readonly)
|
|
9773
|
+
* @description Unique identifier for the record, by which the API addresses the token. (readonly)
|
|
9663
9774
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
9664
9775
|
*/
|
|
9665
9776
|
UserTokenID?: string;
|
|
9777
|
+
/**
|
|
9778
|
+
* Format: int64
|
|
9779
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
9780
|
+
*/
|
|
9781
|
+
Version?: number;
|
|
9666
9782
|
};
|
|
9667
9783
|
ValidationResult: {
|
|
9668
9784
|
/** @description Deprecated. Use Issues or FailedAttributes instead. Optional list of failure details when not associated with specific attributes/paths. */
|
|
@@ -18567,7 +18683,7 @@ interface operations {
|
|
|
18567
18683
|
* An example conjunction is:
|
|
18568
18684
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18569
18685
|
*
|
|
18570
|
-
* Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, SpaceID, Status,
|
|
18686
|
+
* Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, SpaceID, Status, TimeoutAt, UpdatedAt.
|
|
18571
18687
|
*
|
|
18572
18688
|
* The whole string must be query-encoded.
|
|
18573
18689
|
*/
|
|
@@ -18609,7 +18725,7 @@ interface operations {
|
|
|
18609
18725
|
* The attribute names are case-sensitive, PascalCase, and
|
|
18610
18726
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
18611
18727
|
*
|
|
18612
|
-
* Supported attributes for CommandRun are .
|
|
18728
|
+
* Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID.
|
|
18613
18729
|
*
|
|
18614
18730
|
* The whole string must be query-encoded.
|
|
18615
18731
|
*/
|
|
@@ -18633,6 +18749,26 @@ interface operations {
|
|
|
18633
18749
|
* Supported values: Manage, Edit, Use, View.
|
|
18634
18750
|
*/
|
|
18635
18751
|
where_permission?: PathsCommand_runGetParametersQueryWhere_permission;
|
|
18752
|
+
/**
|
|
18753
|
+
* @description Hidden CommandRun entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
18754
|
+
*
|
|
18755
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
18756
|
+
*
|
|
18757
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
18758
|
+
*
|
|
18759
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
18760
|
+
*/
|
|
18761
|
+
include_hidden?: string;
|
|
18762
|
+
/**
|
|
18763
|
+
* @description UUID of a View whose columns to compute for each CommandRun, returned as ViewColumns.
|
|
18764
|
+
*
|
|
18765
|
+
* The View must be in the same Organization as the user credentials, and be a View of CommandRun: its Of, or the From of its Filter, must be CommandRun.
|
|
18766
|
+
*
|
|
18767
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
18768
|
+
*
|
|
18769
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
18770
|
+
*/
|
|
18771
|
+
view?: string;
|
|
18636
18772
|
/** @description Maximum number of CommandRun entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
18637
18773
|
limit?: number;
|
|
18638
18774
|
/**
|
|
@@ -18640,7 +18776,7 @@ interface operations {
|
|
|
18640
18776
|
*
|
|
18641
18777
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
18642
18778
|
*
|
|
18643
|
-
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status,
|
|
18779
|
+
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, Status, TimeoutAt, UpdatedAt.
|
|
18644
18780
|
*
|
|
18645
18781
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
18646
18782
|
*
|
|
@@ -18672,7 +18808,7 @@ interface operations {
|
|
|
18672
18808
|
[name: string]: unknown;
|
|
18673
18809
|
};
|
|
18674
18810
|
content: {
|
|
18675
|
-
"application/json": components["schemas"]["
|
|
18811
|
+
"application/json": components["schemas"]["ExtendedCommandRun"][];
|
|
18676
18812
|
};
|
|
18677
18813
|
};
|
|
18678
18814
|
/** @description CommandRun request is invalid (Bad Request). */
|
|
@@ -21948,7 +22084,7 @@ interface operations {
|
|
|
21948
22084
|
* An example conjunction is:
|
|
21949
22085
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
21950
22086
|
*
|
|
21951
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22087
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
21952
22088
|
*
|
|
21953
22089
|
* The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
21954
22090
|
*
|
|
@@ -21992,7 +22128,7 @@ interface operations {
|
|
|
21992
22128
|
* The attribute names are case-sensitive, PascalCase, and
|
|
21993
22129
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
21994
22130
|
*
|
|
21995
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
22131
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
21996
22132
|
*
|
|
21997
22133
|
* The whole string must be query-encoded.
|
|
21998
22134
|
*/
|
|
@@ -22043,7 +22179,7 @@ interface operations {
|
|
|
22043
22179
|
*
|
|
22044
22180
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
22045
22181
|
*
|
|
22046
|
-
* Supported attributes for ordering Invocation: BackingUnitID, BridgeWorkerID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22182
|
+
* Supported attributes for ordering Invocation: BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22047
22183
|
*
|
|
22048
22184
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
22049
22185
|
*
|
|
@@ -22172,7 +22308,7 @@ interface operations {
|
|
|
22172
22308
|
* An example conjunction is:
|
|
22173
22309
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22174
22310
|
*
|
|
22175
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22311
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22176
22312
|
*
|
|
22177
22313
|
* The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
22178
22314
|
*
|
|
@@ -22226,7 +22362,7 @@ interface operations {
|
|
|
22226
22362
|
* The attribute names are case-sensitive, PascalCase, and
|
|
22227
22363
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
22228
22364
|
*
|
|
22229
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
22365
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
22230
22366
|
*
|
|
22231
22367
|
* The whole string must be query-encoded.
|
|
22232
22368
|
*/
|
|
@@ -22365,6 +22501,8 @@ interface operations {
|
|
|
22365
22501
|
} | null;
|
|
22366
22502
|
/** Format: uuid */
|
|
22367
22503
|
BridgeWorkerID?: string | null;
|
|
22504
|
+
/** Format: uuid */
|
|
22505
|
+
ChannelID?: string | null;
|
|
22368
22506
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
22369
22507
|
DeleteGates?: {
|
|
22370
22508
|
[key: string]: boolean | null;
|
|
@@ -22523,7 +22661,7 @@ interface operations {
|
|
|
22523
22661
|
* An example conjunction is:
|
|
22524
22662
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22525
22663
|
*
|
|
22526
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22664
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22527
22665
|
*
|
|
22528
22666
|
* The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
22529
22667
|
*
|
|
@@ -22577,7 +22715,7 @@ interface operations {
|
|
|
22577
22715
|
* The attribute names are case-sensitive, PascalCase, and
|
|
22578
22716
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
22579
22717
|
*
|
|
22580
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
22718
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
22581
22719
|
*
|
|
22582
22720
|
* The whole string must be query-encoded.
|
|
22583
22721
|
*/
|
|
@@ -22727,7 +22865,7 @@ interface operations {
|
|
|
22727
22865
|
* An example conjunction is:
|
|
22728
22866
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22729
22867
|
*
|
|
22730
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22868
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22731
22869
|
*
|
|
22732
22870
|
* The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
22733
22871
|
*
|
|
@@ -22781,7 +22919,7 @@ interface operations {
|
|
|
22781
22919
|
* The attribute names are case-sensitive, PascalCase, and
|
|
22782
22920
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
22783
22921
|
*
|
|
22784
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
22922
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
22785
22923
|
*
|
|
22786
22924
|
* The whole string must be query-encoded.
|
|
22787
22925
|
*/
|
|
@@ -22810,6 +22948,8 @@ interface operations {
|
|
|
22810
22948
|
} | null;
|
|
22811
22949
|
/** Format: uuid */
|
|
22812
22950
|
BridgeWorkerID?: string | null;
|
|
22951
|
+
/** Format: uuid */
|
|
22952
|
+
ChannelID?: string | null;
|
|
22813
22953
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
22814
22954
|
DeleteGates?: {
|
|
22815
22955
|
[key: string]: boolean | null;
|
|
@@ -22968,7 +23108,7 @@ interface operations {
|
|
|
22968
23108
|
* An example conjunction is:
|
|
22969
23109
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22970
23110
|
*
|
|
22971
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
23111
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
22972
23112
|
*
|
|
22973
23113
|
* The whole string must be query-encoded.
|
|
22974
23114
|
*/
|
|
@@ -23020,7 +23160,7 @@ interface operations {
|
|
|
23020
23160
|
* The attribute names are case-sensitive, PascalCase, and
|
|
23021
23161
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
23022
23162
|
*
|
|
23023
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
23163
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
23024
23164
|
*
|
|
23025
23165
|
* The whole string must be query-encoded.
|
|
23026
23166
|
*/
|
|
@@ -28300,25 +28440,394 @@ interface operations {
|
|
|
28300
28440
|
};
|
|
28301
28441
|
};
|
|
28302
28442
|
};
|
|
28303
|
-
|
|
28443
|
+
ListServiceAccountUserKeys: {
|
|
28444
|
+
parameters: {
|
|
28445
|
+
query?: {
|
|
28446
|
+
/**
|
|
28447
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
28448
|
+
* the list of UserKeys returned. The expression syntax was inspired by SQL.
|
|
28449
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
28450
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
28451
|
+
* as in the JSON encoding.
|
|
28452
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
28453
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
28454
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
28455
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
28456
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
28457
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
28458
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
28459
|
+
* UUID and time literals must be quoted as string literals.
|
|
28460
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
28461
|
+
* Time literals use the same form as when serialized as JSON,
|
|
28462
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
28463
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
28464
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
28465
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
28466
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
28467
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
28468
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
28469
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
28470
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
28471
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
28472
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
28473
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
28474
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
28475
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
28476
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
28477
|
+
* Conjunctions are supported using the `AND` operator.
|
|
28478
|
+
* An example conjunction is:
|
|
28479
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
28480
|
+
*
|
|
28481
|
+
* Supported attributes for filtering on UserKey: CreatedAt, Description, DisplayName, ExpiresAt, HiddenReason, Kid, LastUsedAt, Slug, UpdatedAt, UserID, UserKeyID.
|
|
28482
|
+
*
|
|
28483
|
+
* The whole string must be query-encoded.
|
|
28484
|
+
*/
|
|
28485
|
+
where?: string;
|
|
28486
|
+
/**
|
|
28487
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
28488
|
+
*
|
|
28489
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
28490
|
+
*
|
|
28491
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
28492
|
+
*
|
|
28493
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
28494
|
+
*
|
|
28495
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
28496
|
+
*
|
|
28497
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
28498
|
+
*
|
|
28499
|
+
* Searchable fields for UserKey include string and map-type attributes from the queryable attributes list.
|
|
28500
|
+
*
|
|
28501
|
+
* The whole string must be query-encoded.
|
|
28502
|
+
*/
|
|
28503
|
+
contains?: string;
|
|
28504
|
+
/**
|
|
28505
|
+
* @description Select clause for specifying which fields to include in the response for UserKey.
|
|
28506
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
28507
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
28508
|
+
* If not specified, all fields are returned.
|
|
28509
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserKeyID) and Slug are always returned regardless of the select parameter.
|
|
28510
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28511
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28512
|
+
* The whole string must be query-encoded.
|
|
28513
|
+
*/
|
|
28514
|
+
select?: string;
|
|
28515
|
+
/**
|
|
28516
|
+
* @description Hidden UserKey entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
28517
|
+
*
|
|
28518
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
28519
|
+
*
|
|
28520
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
28521
|
+
*
|
|
28522
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
28523
|
+
*/
|
|
28524
|
+
include_hidden?: string;
|
|
28525
|
+
/** @description Maximum number of UserKey entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
28526
|
+
limit?: number;
|
|
28527
|
+
/**
|
|
28528
|
+
* @description Comma-separated list of fields to sort UserKey results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
28529
|
+
*
|
|
28530
|
+
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
28531
|
+
*
|
|
28532
|
+
* Supported attributes for ordering UserKey: CreatedAt, Description, DisplayName, ExpiresAt, HiddenReason, Kid, LastUsedAt, Slug, UpdatedAt, UserID, UserKeyID.
|
|
28533
|
+
*
|
|
28534
|
+
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
28535
|
+
*
|
|
28536
|
+
* Results are ordered by the UserKey's ID after the fields named, and by the ID alone if none are.
|
|
28537
|
+
*
|
|
28538
|
+
* The whole string must be query-encoded.
|
|
28539
|
+
*/
|
|
28540
|
+
order_by?: string;
|
|
28541
|
+
/**
|
|
28542
|
+
* @description The token from the ConfigHub-Continue header of the previous page, to return the UserKey entities after it.
|
|
28543
|
+
*
|
|
28544
|
+
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
28545
|
+
*
|
|
28546
|
+
* Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
|
|
28547
|
+
*/
|
|
28548
|
+
continue?: string;
|
|
28549
|
+
};
|
|
28550
|
+
header?: never;
|
|
28551
|
+
path: {
|
|
28552
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
28553
|
+
service_account_id: string;
|
|
28554
|
+
};
|
|
28555
|
+
cookie?: never;
|
|
28556
|
+
};
|
|
28557
|
+
requestBody?: never;
|
|
28558
|
+
responses: {
|
|
28559
|
+
/** @description OK */
|
|
28560
|
+
200: {
|
|
28561
|
+
headers: {
|
|
28562
|
+
/** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
|
|
28563
|
+
"ConfigHub-Continue"?: string;
|
|
28564
|
+
[name: string]: unknown;
|
|
28565
|
+
};
|
|
28566
|
+
content: {
|
|
28567
|
+
"application/json": components["schemas"]["ExtendedUserKey"][];
|
|
28568
|
+
};
|
|
28569
|
+
};
|
|
28570
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
28571
|
+
400: {
|
|
28572
|
+
headers: {
|
|
28573
|
+
[name: string]: unknown;
|
|
28574
|
+
};
|
|
28575
|
+
content: {
|
|
28576
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28577
|
+
};
|
|
28578
|
+
};
|
|
28579
|
+
/** @description Unauthorized access. */
|
|
28580
|
+
401: {
|
|
28581
|
+
headers: {
|
|
28582
|
+
[name: string]: unknown;
|
|
28583
|
+
};
|
|
28584
|
+
content: {
|
|
28585
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28586
|
+
};
|
|
28587
|
+
};
|
|
28588
|
+
/** @description Forbidden access. */
|
|
28589
|
+
403: {
|
|
28590
|
+
headers: {
|
|
28591
|
+
[name: string]: unknown;
|
|
28592
|
+
};
|
|
28593
|
+
content: {
|
|
28594
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28595
|
+
};
|
|
28596
|
+
};
|
|
28597
|
+
/** @description ServiceAccount not found. */
|
|
28598
|
+
404: {
|
|
28599
|
+
headers: {
|
|
28600
|
+
[name: string]: unknown;
|
|
28601
|
+
};
|
|
28602
|
+
content: {
|
|
28603
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28604
|
+
};
|
|
28605
|
+
};
|
|
28606
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
28607
|
+
500: {
|
|
28608
|
+
headers: {
|
|
28609
|
+
[name: string]: unknown;
|
|
28610
|
+
};
|
|
28611
|
+
content: {
|
|
28612
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28613
|
+
};
|
|
28614
|
+
};
|
|
28615
|
+
/** @description Unexpected error. */
|
|
28616
|
+
default: {
|
|
28617
|
+
headers: {
|
|
28618
|
+
[name: string]: unknown;
|
|
28619
|
+
};
|
|
28620
|
+
content: {
|
|
28621
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28622
|
+
};
|
|
28623
|
+
};
|
|
28624
|
+
};
|
|
28625
|
+
};
|
|
28626
|
+
CreateServiceAccountUserKey: {
|
|
28627
|
+
parameters: {
|
|
28628
|
+
query?: {
|
|
28629
|
+
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
28630
|
+
dry_run?: boolean;
|
|
28631
|
+
};
|
|
28632
|
+
header?: never;
|
|
28633
|
+
path: {
|
|
28634
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
28635
|
+
service_account_id: string;
|
|
28636
|
+
};
|
|
28637
|
+
cookie?: never;
|
|
28638
|
+
};
|
|
28639
|
+
requestBody?: {
|
|
28640
|
+
content: {
|
|
28641
|
+
"application/json": components["schemas"]["CreateUserKeyRequest"];
|
|
28642
|
+
};
|
|
28643
|
+
};
|
|
28644
|
+
responses: {
|
|
28645
|
+
/** @description OK */
|
|
28646
|
+
200: {
|
|
28647
|
+
headers: {
|
|
28648
|
+
[name: string]: unknown;
|
|
28649
|
+
};
|
|
28650
|
+
content: {
|
|
28651
|
+
"application/json": components["schemas"]["UserKey"];
|
|
28652
|
+
};
|
|
28653
|
+
};
|
|
28654
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
28655
|
+
400: {
|
|
28656
|
+
headers: {
|
|
28657
|
+
[name: string]: unknown;
|
|
28658
|
+
};
|
|
28659
|
+
content: {
|
|
28660
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28661
|
+
};
|
|
28662
|
+
};
|
|
28663
|
+
/** @description Unauthorized access. */
|
|
28664
|
+
401: {
|
|
28665
|
+
headers: {
|
|
28666
|
+
[name: string]: unknown;
|
|
28667
|
+
};
|
|
28668
|
+
content: {
|
|
28669
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28670
|
+
};
|
|
28671
|
+
};
|
|
28672
|
+
/** @description Forbidden access. */
|
|
28673
|
+
403: {
|
|
28674
|
+
headers: {
|
|
28675
|
+
[name: string]: unknown;
|
|
28676
|
+
};
|
|
28677
|
+
content: {
|
|
28678
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28679
|
+
};
|
|
28680
|
+
};
|
|
28681
|
+
/** @description ServiceAccount not found. */
|
|
28682
|
+
404: {
|
|
28683
|
+
headers: {
|
|
28684
|
+
[name: string]: unknown;
|
|
28685
|
+
};
|
|
28686
|
+
content: {
|
|
28687
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28688
|
+
};
|
|
28689
|
+
};
|
|
28690
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
28691
|
+
409: {
|
|
28692
|
+
headers: {
|
|
28693
|
+
[name: string]: unknown;
|
|
28694
|
+
};
|
|
28695
|
+
content: {
|
|
28696
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28697
|
+
};
|
|
28698
|
+
};
|
|
28699
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
28700
|
+
500: {
|
|
28701
|
+
headers: {
|
|
28702
|
+
[name: string]: unknown;
|
|
28703
|
+
};
|
|
28704
|
+
content: {
|
|
28705
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28706
|
+
};
|
|
28707
|
+
};
|
|
28708
|
+
/** @description Unexpected error. */
|
|
28709
|
+
default: {
|
|
28710
|
+
headers: {
|
|
28711
|
+
[name: string]: unknown;
|
|
28712
|
+
};
|
|
28713
|
+
content: {
|
|
28714
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28715
|
+
};
|
|
28716
|
+
};
|
|
28717
|
+
};
|
|
28718
|
+
};
|
|
28719
|
+
GetServiceAccountUserKey: {
|
|
28720
|
+
parameters: {
|
|
28721
|
+
query?: {
|
|
28722
|
+
/**
|
|
28723
|
+
* @description Select clause for specifying which fields to include in the response for UserKey.
|
|
28724
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
28725
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
28726
|
+
* If not specified, all fields are returned.
|
|
28727
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserKeyID) and Slug are always returned regardless of the select parameter.
|
|
28728
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28729
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28730
|
+
* The whole string must be query-encoded.
|
|
28731
|
+
*/
|
|
28732
|
+
select?: string;
|
|
28733
|
+
};
|
|
28734
|
+
header?: never;
|
|
28735
|
+
path: {
|
|
28736
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
28737
|
+
service_account_id: string;
|
|
28738
|
+
/** @description UUID of the key. To address a key by its thumbprint, list with where "Kid = '<kid>'". */
|
|
28739
|
+
user_key_id: string;
|
|
28740
|
+
};
|
|
28741
|
+
cookie?: never;
|
|
28742
|
+
};
|
|
28743
|
+
requestBody?: never;
|
|
28744
|
+
responses: {
|
|
28745
|
+
/** @description OK */
|
|
28746
|
+
200: {
|
|
28747
|
+
headers: {
|
|
28748
|
+
[name: string]: unknown;
|
|
28749
|
+
};
|
|
28750
|
+
content: {
|
|
28751
|
+
"application/json": components["schemas"]["ExtendedUserKey"];
|
|
28752
|
+
};
|
|
28753
|
+
};
|
|
28754
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
28755
|
+
400: {
|
|
28756
|
+
headers: {
|
|
28757
|
+
[name: string]: unknown;
|
|
28758
|
+
};
|
|
28759
|
+
content: {
|
|
28760
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28761
|
+
};
|
|
28762
|
+
};
|
|
28763
|
+
/** @description Unauthorized access. */
|
|
28764
|
+
401: {
|
|
28765
|
+
headers: {
|
|
28766
|
+
[name: string]: unknown;
|
|
28767
|
+
};
|
|
28768
|
+
content: {
|
|
28769
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28770
|
+
};
|
|
28771
|
+
};
|
|
28772
|
+
/** @description Forbidden access. */
|
|
28773
|
+
403: {
|
|
28774
|
+
headers: {
|
|
28775
|
+
[name: string]: unknown;
|
|
28776
|
+
};
|
|
28777
|
+
content: {
|
|
28778
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28779
|
+
};
|
|
28780
|
+
};
|
|
28781
|
+
/** @description ServiceAccount not found. */
|
|
28782
|
+
404: {
|
|
28783
|
+
headers: {
|
|
28784
|
+
[name: string]: unknown;
|
|
28785
|
+
};
|
|
28786
|
+
content: {
|
|
28787
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28788
|
+
};
|
|
28789
|
+
};
|
|
28790
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
28791
|
+
500: {
|
|
28792
|
+
headers: {
|
|
28793
|
+
[name: string]: unknown;
|
|
28794
|
+
};
|
|
28795
|
+
content: {
|
|
28796
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28797
|
+
};
|
|
28798
|
+
};
|
|
28799
|
+
/** @description Unexpected error. */
|
|
28800
|
+
default: {
|
|
28801
|
+
headers: {
|
|
28802
|
+
[name: string]: unknown;
|
|
28803
|
+
};
|
|
28804
|
+
content: {
|
|
28805
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28806
|
+
};
|
|
28807
|
+
};
|
|
28808
|
+
};
|
|
28809
|
+
};
|
|
28810
|
+
DeleteServiceAccountUserKey: {
|
|
28304
28811
|
parameters: {
|
|
28305
28812
|
query?: never;
|
|
28306
28813
|
header?: never;
|
|
28307
28814
|
path: {
|
|
28308
28815
|
/** @description UUID of the service account whose keys are being managed. */
|
|
28309
28816
|
service_account_id: string;
|
|
28817
|
+
/** @description UUID of the key. To address a key by its thumbprint, list with where "Kid = '<kid>'". */
|
|
28818
|
+
user_key_id: string;
|
|
28310
28819
|
};
|
|
28311
28820
|
cookie?: never;
|
|
28312
28821
|
};
|
|
28313
28822
|
requestBody?: never;
|
|
28314
28823
|
responses: {
|
|
28315
|
-
/** @description
|
|
28824
|
+
/** @description Response for successful delete operation */
|
|
28316
28825
|
200: {
|
|
28317
28826
|
headers: {
|
|
28318
28827
|
[name: string]: unknown;
|
|
28319
28828
|
};
|
|
28320
28829
|
content: {
|
|
28321
|
-
"application/json": components["schemas"]["
|
|
28830
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
28322
28831
|
};
|
|
28323
28832
|
};
|
|
28324
28833
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28357,6 +28866,24 @@ interface operations {
|
|
|
28357
28866
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28358
28867
|
};
|
|
28359
28868
|
};
|
|
28869
|
+
/** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
28870
|
+
409: {
|
|
28871
|
+
headers: {
|
|
28872
|
+
[name: string]: unknown;
|
|
28873
|
+
};
|
|
28874
|
+
content: {
|
|
28875
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28876
|
+
};
|
|
28877
|
+
};
|
|
28878
|
+
/** @description ServiceAccount could not be deleted. */
|
|
28879
|
+
422: {
|
|
28880
|
+
headers: {
|
|
28881
|
+
[name: string]: unknown;
|
|
28882
|
+
};
|
|
28883
|
+
content: {
|
|
28884
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28885
|
+
};
|
|
28886
|
+
};
|
|
28360
28887
|
/** @description Something went wrong while processing ServiceAccount. */
|
|
28361
28888
|
500: {
|
|
28362
28889
|
headers: {
|
|
@@ -28377,32 +28904,131 @@ interface operations {
|
|
|
28377
28904
|
};
|
|
28378
28905
|
};
|
|
28379
28906
|
};
|
|
28380
|
-
|
|
28907
|
+
ListServiceAccountUserTokens: {
|
|
28381
28908
|
parameters: {
|
|
28382
28909
|
query?: {
|
|
28383
|
-
/**
|
|
28384
|
-
|
|
28910
|
+
/**
|
|
28911
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
28912
|
+
* the list of UserTokens returned. The expression syntax was inspired by SQL.
|
|
28913
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
28914
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
28915
|
+
* as in the JSON encoding.
|
|
28916
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
28917
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
28918
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
28919
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
28920
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
28921
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
28922
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
28923
|
+
* UUID and time literals must be quoted as string literals.
|
|
28924
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
28925
|
+
* Time literals use the same form as when serialized as JSON,
|
|
28926
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
28927
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
28928
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
28929
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
28930
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
28931
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
28932
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
28933
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
28934
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
28935
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
28936
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
28937
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
28938
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
28939
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
28940
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
28941
|
+
* Conjunctions are supported using the `AND` operator.
|
|
28942
|
+
* An example conjunction is:
|
|
28943
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
28944
|
+
*
|
|
28945
|
+
* Supported attributes for filtering on UserToken: CreatedAt, CreatedByUserID, Description, DisplayName, ExpiresAt, HiddenReason, Jti, LastUsedAt, RevokedAt, Slug, UpdatedAt, UserID, UserTokenID.
|
|
28946
|
+
*
|
|
28947
|
+
* The whole string must be query-encoded.
|
|
28948
|
+
*/
|
|
28949
|
+
where?: string;
|
|
28950
|
+
/**
|
|
28951
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
28952
|
+
*
|
|
28953
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
28954
|
+
*
|
|
28955
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
28956
|
+
*
|
|
28957
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
28958
|
+
*
|
|
28959
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
28960
|
+
*
|
|
28961
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
28962
|
+
*
|
|
28963
|
+
* Searchable fields for UserToken include string and map-type attributes from the queryable attributes list.
|
|
28964
|
+
*
|
|
28965
|
+
* The whole string must be query-encoded.
|
|
28966
|
+
*/
|
|
28967
|
+
contains?: string;
|
|
28968
|
+
/**
|
|
28969
|
+
* @description Select clause for specifying which fields to include in the response for UserToken.
|
|
28970
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
28971
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
28972
|
+
* If not specified, all fields are returned.
|
|
28973
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserTokenID) and Slug are always returned regardless of the select parameter.
|
|
28974
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
28975
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
28976
|
+
* The whole string must be query-encoded.
|
|
28977
|
+
*/
|
|
28978
|
+
select?: string;
|
|
28979
|
+
/**
|
|
28980
|
+
* @description Hidden UserToken entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
28981
|
+
*
|
|
28982
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
28983
|
+
*
|
|
28984
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
28985
|
+
*
|
|
28986
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
28987
|
+
*/
|
|
28988
|
+
include_hidden?: string;
|
|
28989
|
+
/** @description Maximum number of UserToken entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
28990
|
+
limit?: number;
|
|
28991
|
+
/**
|
|
28992
|
+
* @description Comma-separated list of fields to sort UserToken results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
28993
|
+
*
|
|
28994
|
+
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
28995
|
+
*
|
|
28996
|
+
* Supported attributes for ordering UserToken: CreatedAt, CreatedByUserID, Description, DisplayName, ExpiresAt, HiddenReason, Jti, LastUsedAt, RevokedAt, Slug, UpdatedAt, UserID, UserTokenID.
|
|
28997
|
+
*
|
|
28998
|
+
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
28999
|
+
*
|
|
29000
|
+
* Results are ordered by the UserToken's ID after the fields named, and by the ID alone if none are.
|
|
29001
|
+
*
|
|
29002
|
+
* The whole string must be query-encoded.
|
|
29003
|
+
*/
|
|
29004
|
+
order_by?: string;
|
|
29005
|
+
/**
|
|
29006
|
+
* @description The token from the ConfigHub-Continue header of the previous page, to return the UserToken entities after it.
|
|
29007
|
+
*
|
|
29008
|
+
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
29009
|
+
*
|
|
29010
|
+
* Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
|
|
29011
|
+
*/
|
|
29012
|
+
continue?: string;
|
|
28385
29013
|
};
|
|
28386
29014
|
header?: never;
|
|
28387
29015
|
path: {
|
|
28388
|
-
/** @description UUID of the service account whose
|
|
29016
|
+
/** @description UUID of the service account whose tokens are being managed. */
|
|
28389
29017
|
service_account_id: string;
|
|
28390
29018
|
};
|
|
28391
29019
|
cookie?: never;
|
|
28392
29020
|
};
|
|
28393
|
-
requestBody?:
|
|
28394
|
-
content: {
|
|
28395
|
-
"application/json": components["schemas"]["CreateUserKeyRequest"];
|
|
28396
|
-
};
|
|
28397
|
-
};
|
|
29021
|
+
requestBody?: never;
|
|
28398
29022
|
responses: {
|
|
28399
29023
|
/** @description OK */
|
|
28400
29024
|
200: {
|
|
28401
29025
|
headers: {
|
|
29026
|
+
/** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
|
|
29027
|
+
"ConfigHub-Continue"?: string;
|
|
28402
29028
|
[name: string]: unknown;
|
|
28403
29029
|
};
|
|
28404
29030
|
content: {
|
|
28405
|
-
"application/json": components["schemas"]["
|
|
29031
|
+
"application/json": components["schemas"]["ExtendedUserToken"][];
|
|
28406
29032
|
};
|
|
28407
29033
|
};
|
|
28408
29034
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28441,15 +29067,6 @@ interface operations {
|
|
|
28441
29067
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28442
29068
|
};
|
|
28443
29069
|
};
|
|
28444
|
-
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
28445
|
-
409: {
|
|
28446
|
-
headers: {
|
|
28447
|
-
[name: string]: unknown;
|
|
28448
|
-
};
|
|
28449
|
-
content: {
|
|
28450
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28451
|
-
};
|
|
28452
|
-
};
|
|
28453
29070
|
/** @description Something went wrong while processing ServiceAccount. */
|
|
28454
29071
|
500: {
|
|
28455
29072
|
headers: {
|
|
@@ -28470,27 +29087,32 @@ interface operations {
|
|
|
28470
29087
|
};
|
|
28471
29088
|
};
|
|
28472
29089
|
};
|
|
28473
|
-
|
|
29090
|
+
CreateServiceAccountUserToken: {
|
|
28474
29091
|
parameters: {
|
|
28475
|
-
query?:
|
|
29092
|
+
query?: {
|
|
29093
|
+
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
29094
|
+
dry_run?: boolean;
|
|
29095
|
+
};
|
|
28476
29096
|
header?: never;
|
|
28477
29097
|
path: {
|
|
28478
|
-
/** @description UUID of the service account whose
|
|
29098
|
+
/** @description UUID of the service account whose tokens are being managed. */
|
|
28479
29099
|
service_account_id: string;
|
|
28480
|
-
/** @description RFC 7638 thumbprint of the key to remove. The key names itself, so a holder can address it without asking what it was called. */
|
|
28481
|
-
kid: string;
|
|
28482
29100
|
};
|
|
28483
29101
|
cookie?: never;
|
|
28484
29102
|
};
|
|
28485
|
-
requestBody?:
|
|
29103
|
+
requestBody?: {
|
|
29104
|
+
content: {
|
|
29105
|
+
"application/json": components["schemas"]["CreateUserTokenRequest"];
|
|
29106
|
+
};
|
|
29107
|
+
};
|
|
28486
29108
|
responses: {
|
|
28487
|
-
/** @description
|
|
29109
|
+
/** @description OK */
|
|
28488
29110
|
200: {
|
|
28489
29111
|
headers: {
|
|
28490
29112
|
[name: string]: unknown;
|
|
28491
29113
|
};
|
|
28492
29114
|
content: {
|
|
28493
|
-
"application/json": components["schemas"]["
|
|
29115
|
+
"application/json": components["schemas"]["IssuedUserToken"];
|
|
28494
29116
|
};
|
|
28495
29117
|
};
|
|
28496
29118
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28529,7 +29151,7 @@ interface operations {
|
|
|
28529
29151
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28530
29152
|
};
|
|
28531
29153
|
};
|
|
28532
|
-
/** @description ServiceAccount
|
|
29154
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
28533
29155
|
409: {
|
|
28534
29156
|
headers: {
|
|
28535
29157
|
[name: string]: unknown;
|
|
@@ -28538,15 +29160,6 @@ interface operations {
|
|
|
28538
29160
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28539
29161
|
};
|
|
28540
29162
|
};
|
|
28541
|
-
/** @description ServiceAccount could not be deleted. */
|
|
28542
|
-
422: {
|
|
28543
|
-
headers: {
|
|
28544
|
-
[name: string]: unknown;
|
|
28545
|
-
};
|
|
28546
|
-
content: {
|
|
28547
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28548
|
-
};
|
|
28549
|
-
};
|
|
28550
29163
|
/** @description Something went wrong while processing ServiceAccount. */
|
|
28551
29164
|
500: {
|
|
28552
29165
|
headers: {
|
|
@@ -28567,13 +29180,27 @@ interface operations {
|
|
|
28567
29180
|
};
|
|
28568
29181
|
};
|
|
28569
29182
|
};
|
|
28570
|
-
|
|
29183
|
+
GetServiceAccountUserToken: {
|
|
28571
29184
|
parameters: {
|
|
28572
|
-
query?:
|
|
29185
|
+
query?: {
|
|
29186
|
+
/**
|
|
29187
|
+
* @description Select clause for specifying which fields to include in the response for UserToken.
|
|
29188
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
29189
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
29190
|
+
* If not specified, all fields are returned.
|
|
29191
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserTokenID) and Slug are always returned regardless of the select parameter.
|
|
29192
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
29193
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
29194
|
+
* The whole string must be query-encoded.
|
|
29195
|
+
*/
|
|
29196
|
+
select?: string;
|
|
29197
|
+
};
|
|
28573
29198
|
header?: never;
|
|
28574
29199
|
path: {
|
|
28575
29200
|
/** @description UUID of the service account whose tokens are being managed. */
|
|
28576
29201
|
service_account_id: string;
|
|
29202
|
+
/** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = '<jti>'". */
|
|
29203
|
+
user_token_id: string;
|
|
28577
29204
|
};
|
|
28578
29205
|
cookie?: never;
|
|
28579
29206
|
};
|
|
@@ -28585,7 +29212,7 @@ interface operations {
|
|
|
28585
29212
|
[name: string]: unknown;
|
|
28586
29213
|
};
|
|
28587
29214
|
content: {
|
|
28588
|
-
"application/json": components["schemas"]["
|
|
29215
|
+
"application/json": components["schemas"]["ExtendedUserToken"];
|
|
28589
29216
|
};
|
|
28590
29217
|
};
|
|
28591
29218
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28644,32 +29271,27 @@ interface operations {
|
|
|
28644
29271
|
};
|
|
28645
29272
|
};
|
|
28646
29273
|
};
|
|
28647
|
-
|
|
29274
|
+
DeleteServiceAccountUserToken: {
|
|
28648
29275
|
parameters: {
|
|
28649
|
-
query?:
|
|
28650
|
-
/** @description If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
28651
|
-
dry_run?: boolean;
|
|
28652
|
-
};
|
|
29276
|
+
query?: never;
|
|
28653
29277
|
header?: never;
|
|
28654
29278
|
path: {
|
|
28655
29279
|
/** @description UUID of the service account whose tokens are being managed. */
|
|
28656
29280
|
service_account_id: string;
|
|
29281
|
+
/** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = '<jti>'". */
|
|
29282
|
+
user_token_id: string;
|
|
28657
29283
|
};
|
|
28658
29284
|
cookie?: never;
|
|
28659
29285
|
};
|
|
28660
|
-
requestBody?:
|
|
28661
|
-
content: {
|
|
28662
|
-
"application/json": components["schemas"]["CreateUserTokenRequest"];
|
|
28663
|
-
};
|
|
28664
|
-
};
|
|
29286
|
+
requestBody?: never;
|
|
28665
29287
|
responses: {
|
|
28666
|
-
/** @description
|
|
29288
|
+
/** @description Response for successful delete operation */
|
|
28667
29289
|
200: {
|
|
28668
29290
|
headers: {
|
|
28669
29291
|
[name: string]: unknown;
|
|
28670
29292
|
};
|
|
28671
29293
|
content: {
|
|
28672
|
-
"application/json": components["schemas"]["
|
|
29294
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
28673
29295
|
};
|
|
28674
29296
|
};
|
|
28675
29297
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28708,7 +29330,7 @@ interface operations {
|
|
|
28708
29330
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28709
29331
|
};
|
|
28710
29332
|
};
|
|
28711
|
-
/** @description ServiceAccount
|
|
29333
|
+
/** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
28712
29334
|
409: {
|
|
28713
29335
|
headers: {
|
|
28714
29336
|
[name: string]: unknown;
|
|
@@ -28717,6 +29339,15 @@ interface operations {
|
|
|
28717
29339
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28718
29340
|
};
|
|
28719
29341
|
};
|
|
29342
|
+
/** @description ServiceAccount could not be deleted. */
|
|
29343
|
+
422: {
|
|
29344
|
+
headers: {
|
|
29345
|
+
[name: string]: unknown;
|
|
29346
|
+
};
|
|
29347
|
+
content: {
|
|
29348
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
29349
|
+
};
|
|
29350
|
+
};
|
|
28720
29351
|
/** @description Something went wrong while processing ServiceAccount. */
|
|
28721
29352
|
500: {
|
|
28722
29353
|
headers: {
|
|
@@ -28737,27 +29368,27 @@ interface operations {
|
|
|
28737
29368
|
};
|
|
28738
29369
|
};
|
|
28739
29370
|
};
|
|
28740
|
-
|
|
29371
|
+
RevokeServiceAccountUserToken: {
|
|
28741
29372
|
parameters: {
|
|
28742
29373
|
query?: never;
|
|
28743
29374
|
header?: never;
|
|
28744
29375
|
path: {
|
|
28745
29376
|
/** @description UUID of the service account whose tokens are being managed. */
|
|
28746
29377
|
service_account_id: string;
|
|
28747
|
-
/** @description
|
|
28748
|
-
|
|
29378
|
+
/** @description UUID of the token's record. To address a token by the jti it carries, list with where "Jti = '<jti>'". */
|
|
29379
|
+
user_token_id: string;
|
|
28749
29380
|
};
|
|
28750
29381
|
cookie?: never;
|
|
28751
29382
|
};
|
|
28752
29383
|
requestBody?: never;
|
|
28753
29384
|
responses: {
|
|
28754
|
-
/** @description
|
|
29385
|
+
/** @description The record of a long-lived token issued to a ServiceAccount. The token itself is shown once, when it is issued, and is not stored; this record is what lets it be listed, traced to whoever issued it, and revoked on its own. */
|
|
28755
29386
|
200: {
|
|
28756
29387
|
headers: {
|
|
28757
29388
|
[name: string]: unknown;
|
|
28758
29389
|
};
|
|
28759
29390
|
content: {
|
|
28760
|
-
"application/json": components["schemas"]["
|
|
29391
|
+
"application/json": components["schemas"]["UserToken"];
|
|
28761
29392
|
};
|
|
28762
29393
|
};
|
|
28763
29394
|
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
@@ -28796,7 +29427,7 @@ interface operations {
|
|
|
28796
29427
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28797
29428
|
};
|
|
28798
29429
|
};
|
|
28799
|
-
/** @description ServiceAccount
|
|
29430
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
28800
29431
|
409: {
|
|
28801
29432
|
headers: {
|
|
28802
29433
|
[name: string]: unknown;
|
|
@@ -28805,15 +29436,6 @@ interface operations {
|
|
|
28805
29436
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28806
29437
|
};
|
|
28807
29438
|
};
|
|
28808
|
-
/** @description ServiceAccount could not be deleted. */
|
|
28809
|
-
422: {
|
|
28810
|
-
headers: {
|
|
28811
|
-
[name: string]: unknown;
|
|
28812
|
-
};
|
|
28813
|
-
content: {
|
|
28814
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
28815
|
-
};
|
|
28816
|
-
};
|
|
28817
29439
|
/** @description Something went wrong while processing ServiceAccount. */
|
|
28818
29440
|
500: {
|
|
28819
29441
|
headers: {
|
|
@@ -35705,7 +36327,7 @@ interface operations {
|
|
|
35705
36327
|
* An example conjunction is:
|
|
35706
36328
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
35707
36329
|
*
|
|
35708
|
-
* Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, SpaceID, Status,
|
|
36330
|
+
* Supported attributes for filtering on CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, SpaceID, Status, TimeoutAt, UpdatedAt.
|
|
35709
36331
|
*
|
|
35710
36332
|
* The whole string must be query-encoded.
|
|
35711
36333
|
*/
|
|
@@ -35747,7 +36369,7 @@ interface operations {
|
|
|
35747
36369
|
* The attribute names are case-sensitive, PascalCase, and
|
|
35748
36370
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
35749
36371
|
*
|
|
35750
|
-
* Supported attributes for CommandRun are .
|
|
36372
|
+
* Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID.
|
|
35751
36373
|
*
|
|
35752
36374
|
* The whole string must be query-encoded.
|
|
35753
36375
|
*/
|
|
@@ -35771,6 +36393,26 @@ interface operations {
|
|
|
35771
36393
|
* Supported values: Manage, Edit, Use, View.
|
|
35772
36394
|
*/
|
|
35773
36395
|
where_permission?: PathsSpaceSpace_idCommand_runGetParametersQueryWhere_permission;
|
|
36396
|
+
/**
|
|
36397
|
+
* @description Hidden CommandRun entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
36398
|
+
*
|
|
36399
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
36400
|
+
*
|
|
36401
|
+
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
36402
|
+
*
|
|
36403
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
36404
|
+
*/
|
|
36405
|
+
include_hidden?: string;
|
|
36406
|
+
/**
|
|
36407
|
+
* @description UUID of a View whose columns to compute for each CommandRun, returned as ViewColumns.
|
|
36408
|
+
*
|
|
36409
|
+
* The View must be in the same Organization as the user credentials, and be a View of CommandRun: its Of, or the From of its Filter, must be CommandRun.
|
|
36410
|
+
*
|
|
36411
|
+
* If the View has a Filter, the Filter selects the entities as the filter parameter does, so the two may not both be specified.
|
|
36412
|
+
*
|
|
36413
|
+
* The related entities and fields the View's columns read are included and selected automatically, so neither include nor select has to name them.
|
|
36414
|
+
*/
|
|
36415
|
+
view?: string;
|
|
35774
36416
|
/** @description Maximum number of CommandRun entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
35775
36417
|
limit?: number;
|
|
35776
36418
|
/**
|
|
@@ -35778,7 +36420,7 @@ interface operations {
|
|
|
35778
36420
|
*
|
|
35779
36421
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
35780
36422
|
*
|
|
35781
|
-
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, OrganizationID, Status,
|
|
36423
|
+
* Supported attributes for ordering CommandRun: ChannelID, Command, CommandRunID, CompletedAt, CreatedAt, CreatedBy, Deadline, DeliveredAt, HiddenReason, OrganizationID, Status, TimeoutAt, UpdatedAt.
|
|
35782
36424
|
*
|
|
35783
36425
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
35784
36426
|
*
|
|
@@ -35813,7 +36455,7 @@ interface operations {
|
|
|
35813
36455
|
[name: string]: unknown;
|
|
35814
36456
|
};
|
|
35815
36457
|
content: {
|
|
35816
|
-
"application/json": components["schemas"]["
|
|
36458
|
+
"application/json": components["schemas"]["ExtendedCommandRun"][];
|
|
35817
36459
|
};
|
|
35818
36460
|
};
|
|
35819
36461
|
/** @description CommandRun request is invalid (Bad Request). */
|
|
@@ -35927,22 +36569,31 @@ interface operations {
|
|
|
35927
36569
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
35928
36570
|
};
|
|
35929
36571
|
};
|
|
35930
|
-
/** @description
|
|
36572
|
+
/** @description CommandNotDeclared: no Channel in the Space declares the command. */
|
|
35931
36573
|
404: {
|
|
35932
36574
|
headers: {
|
|
35933
36575
|
[name: string]: unknown;
|
|
35934
36576
|
};
|
|
35935
36577
|
content: {
|
|
35936
|
-
"application/json": components["schemas"]["
|
|
36578
|
+
"application/json": components["schemas"]["CommandRunRefusal"];
|
|
35937
36579
|
};
|
|
35938
36580
|
};
|
|
35939
|
-
/** @description
|
|
36581
|
+
/** @description CommandDeclaredByMany: several Channels in the Space declare the command; name one of Channels with ChannelID. */
|
|
35940
36582
|
409: {
|
|
35941
36583
|
headers: {
|
|
35942
36584
|
[name: string]: unknown;
|
|
35943
36585
|
};
|
|
35944
36586
|
content: {
|
|
35945
|
-
"application/json": components["schemas"]["
|
|
36587
|
+
"application/json": components["schemas"]["CommandRunRefusal"];
|
|
36588
|
+
};
|
|
36589
|
+
};
|
|
36590
|
+
/** @description ChannelDoesNotDeclare: the Channel named by ChannelID does not declare the command. */
|
|
36591
|
+
422: {
|
|
36592
|
+
headers: {
|
|
36593
|
+
[name: string]: unknown;
|
|
36594
|
+
};
|
|
36595
|
+
content: {
|
|
36596
|
+
"application/json": components["schemas"]["CommandRunRefusal"];
|
|
35946
36597
|
};
|
|
35947
36598
|
};
|
|
35948
36599
|
/** @description Something went wrong while processing CommandRun. */
|
|
@@ -35970,6 +36621,16 @@ interface operations {
|
|
|
35970
36621
|
query?: {
|
|
35971
36622
|
/** @description Seconds to hold for a terminal status; at most 25. */
|
|
35972
36623
|
wait?: number;
|
|
36624
|
+
/**
|
|
36625
|
+
* @description Include clause for expanding related entities in the response for CommandRun.
|
|
36626
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
36627
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
36628
|
+
*
|
|
36629
|
+
* Supported attributes for CommandRun are ChannelID, OrganizationID, SpaceID.
|
|
36630
|
+
*
|
|
36631
|
+
* The whole string must be query-encoded.
|
|
36632
|
+
*/
|
|
36633
|
+
include?: string;
|
|
35973
36634
|
/**
|
|
35974
36635
|
* @description Select clause for specifying which fields to include in the response for CommandRun.
|
|
35975
36636
|
* The attribute names are case-sensitive, PascalCase, and
|
|
@@ -35993,13 +36654,13 @@ interface operations {
|
|
|
35993
36654
|
};
|
|
35994
36655
|
requestBody?: never;
|
|
35995
36656
|
responses: {
|
|
35996
|
-
/** @description CommandRun
|
|
36657
|
+
/** @description CommandRun with additional related entities expanded based on the request's include parameter. */
|
|
35997
36658
|
200: {
|
|
35998
36659
|
headers: {
|
|
35999
36660
|
[name: string]: unknown;
|
|
36000
36661
|
};
|
|
36001
36662
|
content: {
|
|
36002
|
-
"application/json": components["schemas"]["
|
|
36663
|
+
"application/json": components["schemas"]["ExtendedCommandRun"];
|
|
36003
36664
|
};
|
|
36004
36665
|
};
|
|
36005
36666
|
/** @description CommandRun request is invalid (Bad Request). */
|
|
@@ -37641,7 +38302,7 @@ interface operations {
|
|
|
37641
38302
|
* An example conjunction is:
|
|
37642
38303
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
37643
38304
|
*
|
|
37644
|
-
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
38305
|
+
* Supported attributes for filtering on Invocation: Annotations, BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
37645
38306
|
*
|
|
37646
38307
|
* The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
37647
38308
|
*
|
|
@@ -37685,7 +38346,7 @@ interface operations {
|
|
|
37685
38346
|
* The attribute names are case-sensitive, PascalCase, and
|
|
37686
38347
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
37687
38348
|
*
|
|
37688
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
38349
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
37689
38350
|
*
|
|
37690
38351
|
* The whole string must be query-encoded.
|
|
37691
38352
|
*/
|
|
@@ -37736,7 +38397,7 @@ interface operations {
|
|
|
37736
38397
|
*
|
|
37737
38398
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
37738
38399
|
*
|
|
37739
|
-
* Supported attributes for ordering Invocation: BackingUnitID, BridgeWorkerID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
38400
|
+
* Supported attributes for ordering Invocation: BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, DisplayName, Hash, HiddenReason, InvocationID, OrganizationID, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
37740
38401
|
*
|
|
37741
38402
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
37742
38403
|
*
|
|
@@ -37935,7 +38596,7 @@ interface operations {
|
|
|
37935
38596
|
* The attribute names are case-sensitive, PascalCase, and
|
|
37936
38597
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
37937
38598
|
*
|
|
37938
|
-
* Supported attributes for Invocation are BridgeWorkerID, OrganizationID, SpaceID.
|
|
38599
|
+
* Supported attributes for Invocation are BridgeWorkerID, ChannelID, OrganizationID, SpaceID.
|
|
37939
38600
|
*
|
|
37940
38601
|
* The whole string must be query-encoded.
|
|
37941
38602
|
*/
|
|
@@ -38244,6 +38905,8 @@ interface operations {
|
|
|
38244
38905
|
} | null;
|
|
38245
38906
|
/** Format: uuid */
|
|
38246
38907
|
BridgeWorkerID?: string | null;
|
|
38908
|
+
/** Format: uuid */
|
|
38909
|
+
ChannelID?: string | null;
|
|
38247
38910
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
38248
38911
|
DeleteGates?: {
|
|
38249
38912
|
[key: string]: boolean | null;
|
|
@@ -42081,7 +42744,7 @@ interface operations {
|
|
|
42081
42744
|
* An example conjunction is:
|
|
42082
42745
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
42083
42746
|
*
|
|
42084
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
42747
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
42085
42748
|
*
|
|
42086
42749
|
* A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
42087
42750
|
*
|
|
@@ -42125,7 +42788,7 @@ interface operations {
|
|
|
42125
42788
|
* The attribute names are case-sensitive, PascalCase, and
|
|
42126
42789
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
42127
42790
|
*
|
|
42128
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
42791
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
42129
42792
|
*
|
|
42130
42793
|
* The whole string must be query-encoded.
|
|
42131
42794
|
*/
|
|
@@ -42176,7 +42839,7 @@ interface operations {
|
|
|
42176
42839
|
*
|
|
42177
42840
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
42178
42841
|
*
|
|
42179
|
-
* Supported attributes for ordering Trigger: BackingUnitID, BridgeWorkerID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, OtherDataSource, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
42842
|
+
* Supported attributes for ordering Trigger: BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, OtherDataSource, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
42180
42843
|
*
|
|
42181
42844
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
42182
42845
|
*
|
|
@@ -42385,7 +43048,7 @@ interface operations {
|
|
|
42385
43048
|
* The attribute names are case-sensitive, PascalCase, and
|
|
42386
43049
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
42387
43050
|
*
|
|
42388
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
43051
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
42389
43052
|
*
|
|
42390
43053
|
* The whole string must be query-encoded.
|
|
42391
43054
|
*/
|
|
@@ -42706,6 +43369,8 @@ interface operations {
|
|
|
42706
43369
|
Arguments?: (Record<string, never> | null)[] | null;
|
|
42707
43370
|
/** Format: uuid */
|
|
42708
43371
|
BridgeWorkerID?: string | null;
|
|
43372
|
+
/** Format: uuid */
|
|
43373
|
+
ChannelID?: string | null;
|
|
42709
43374
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
42710
43375
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
42711
43376
|
DeleteGates?: {
|
|
@@ -43545,7 +44210,7 @@ interface operations {
|
|
|
43545
44210
|
* An example conjunction is:
|
|
43546
44211
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
43547
44212
|
*
|
|
43548
|
-
* Supported attributes for filtering on Mutation: BridgeWorkerID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
44213
|
+
* Supported attributes for filtering on Mutation: BridgeWorkerID, ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
43549
44214
|
*
|
|
43550
44215
|
* Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
|
|
43551
44216
|
*
|
|
@@ -43860,7 +44525,7 @@ interface operations {
|
|
|
43860
44525
|
* An example conjunction is:
|
|
43861
44526
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
43862
44527
|
*
|
|
43863
|
-
* Supported attributes for filtering on Mutation: BridgeWorkerID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
44528
|
+
* Supported attributes for filtering on Mutation: BridgeWorkerID, ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
43864
44529
|
*
|
|
43865
44530
|
* Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
|
|
43866
44531
|
*
|
|
@@ -44560,7 +45225,7 @@ interface operations {
|
|
|
44560
45225
|
* An example conjunction is:
|
|
44561
45226
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
44562
45227
|
*
|
|
44563
|
-
* Supported attributes for filtering on Mutation: BridgeWorkerID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
45228
|
+
* Supported attributes for filtering on Mutation: BridgeWorkerID, ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
44564
45229
|
*
|
|
44565
45230
|
* The function invoked is returned as a FunctionInvocation object, and `where` names its fields the same way: `FunctionInvocation.FunctionName`, `FunctionInvocation.Guards.<reason>`, and `FunctionInvocation.Arguments`, which is a list addressed with dot notation. `FunctionInvocation.Arguments.?ParameterName=container-image.Value LIKE 'nginx%'` reads the argument bound to a named parameter, `FunctionInvocation.Arguments.*.Value` matches any argument's value, and `FunctionInvocation.Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
44566
45231
|
*
|
|
@@ -44655,7 +45320,7 @@ interface operations {
|
|
|
44655
45320
|
*
|
|
44656
45321
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
44657
45322
|
*
|
|
44658
|
-
* Supported attributes for ordering Mutation: BridgeWorkerID, CreatedAt, FunctionName, HiddenReason, InvocationID, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
45323
|
+
* Supported attributes for ordering Mutation: BridgeWorkerID, ChannelID, CreatedAt, FunctionName, HiddenReason, InvocationID, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
44659
45324
|
*
|
|
44660
45325
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
44661
45326
|
*
|
|
@@ -50443,7 +51108,7 @@ interface operations {
|
|
|
50443
51108
|
* An example conjunction is:
|
|
50444
51109
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
50445
51110
|
*
|
|
50446
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51111
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
50447
51112
|
*
|
|
50448
51113
|
* A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
50449
51114
|
*
|
|
@@ -50487,7 +51152,7 @@ interface operations {
|
|
|
50487
51152
|
* The attribute names are case-sensitive, PascalCase, and
|
|
50488
51153
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
50489
51154
|
*
|
|
50490
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51155
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
50491
51156
|
*
|
|
50492
51157
|
* The whole string must be query-encoded.
|
|
50493
51158
|
*/
|
|
@@ -50538,7 +51203,7 @@ interface operations {
|
|
|
50538
51203
|
*
|
|
50539
51204
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
50540
51205
|
*
|
|
50541
|
-
* Supported attributes for ordering Trigger: BackingUnitID, BridgeWorkerID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, OtherDataSource, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51206
|
+
* Supported attributes for ordering Trigger: BackingUnitID, BridgeWorkerID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, OtherDataSource, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
50542
51207
|
*
|
|
50543
51208
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
50544
51209
|
*
|
|
@@ -50667,7 +51332,7 @@ interface operations {
|
|
|
50667
51332
|
* An example conjunction is:
|
|
50668
51333
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
50669
51334
|
*
|
|
50670
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51335
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
50671
51336
|
*
|
|
50672
51337
|
* A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
50673
51338
|
*
|
|
@@ -50721,7 +51386,7 @@ interface operations {
|
|
|
50721
51386
|
* The attribute names are case-sensitive, PascalCase, and
|
|
50722
51387
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
50723
51388
|
*
|
|
50724
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51389
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
50725
51390
|
*
|
|
50726
51391
|
* The whole string must be query-encoded.
|
|
50727
51392
|
*/
|
|
@@ -50862,6 +51527,8 @@ interface operations {
|
|
|
50862
51527
|
Arguments?: (Record<string, never> | null)[] | null;
|
|
50863
51528
|
/** Format: uuid */
|
|
50864
51529
|
BridgeWorkerID?: string | null;
|
|
51530
|
+
/** Format: uuid */
|
|
51531
|
+
ChannelID?: string | null;
|
|
50865
51532
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
50866
51533
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
50867
51534
|
DeleteGates?: {
|
|
@@ -51039,7 +51706,7 @@ interface operations {
|
|
|
51039
51706
|
* An example conjunction is:
|
|
51040
51707
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51041
51708
|
*
|
|
51042
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51709
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51043
51710
|
*
|
|
51044
51711
|
* A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
51045
51712
|
*
|
|
@@ -51093,7 +51760,7 @@ interface operations {
|
|
|
51093
51760
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51094
51761
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51095
51762
|
*
|
|
51096
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51763
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51097
51764
|
*
|
|
51098
51765
|
* The whole string must be query-encoded.
|
|
51099
51766
|
*/
|
|
@@ -51243,7 +51910,7 @@ interface operations {
|
|
|
51243
51910
|
* An example conjunction is:
|
|
51244
51911
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51245
51912
|
*
|
|
51246
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51913
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51247
51914
|
*
|
|
51248
51915
|
* A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
51249
51916
|
*
|
|
@@ -51297,7 +51964,7 @@ interface operations {
|
|
|
51297
51964
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51298
51965
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51299
51966
|
*
|
|
51300
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51967
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51301
51968
|
*
|
|
51302
51969
|
* The whole string must be query-encoded.
|
|
51303
51970
|
*/
|
|
@@ -51328,6 +51995,8 @@ interface operations {
|
|
|
51328
51995
|
Arguments?: (Record<string, never> | null)[] | null;
|
|
51329
51996
|
/** Format: uuid */
|
|
51330
51997
|
BridgeWorkerID?: string | null;
|
|
51998
|
+
/** Format: uuid */
|
|
51999
|
+
ChannelID?: string | null;
|
|
51331
52000
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
51332
52001
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
51333
52002
|
DeleteGates?: {
|
|
@@ -51505,7 +52174,7 @@ interface operations {
|
|
|
51505
52174
|
* An example conjunction is:
|
|
51506
52175
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51507
52176
|
*
|
|
51508
|
-
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
52177
|
+
* Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, BridgeWorkerID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherDataSource, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
51509
52178
|
*
|
|
51510
52179
|
* The whole string must be query-encoded.
|
|
51511
52180
|
*/
|
|
@@ -51557,7 +52226,7 @@ interface operations {
|
|
|
51557
52226
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51558
52227
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51559
52228
|
*
|
|
51560
|
-
* Supported attributes for Trigger are BridgeWorkerID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
52229
|
+
* Supported attributes for Trigger are BridgeWorkerID, ChannelID, InvocationID, OrganizationID, SpaceID, UnitFilterID.
|
|
51561
52230
|
*
|
|
51562
52231
|
* The whole string must be query-encoded.
|
|
51563
52232
|
*/
|
|
@@ -52638,7 +53307,7 @@ interface operations {
|
|
|
52638
53307
|
* An example conjunction is:
|
|
52639
53308
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
52640
53309
|
*
|
|
52641
|
-
* Supported attributes for filtering on Mutation: BridgeWorkerID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
53310
|
+
* Supported attributes for filtering on Mutation: BridgeWorkerID, ChannelID, CreatedAt, FunctionInvocation.Arguments, FunctionInvocation.Clearance, FunctionInvocation.FunctionName, FunctionInvocation.Guards, FunctionInvocation.WhereResource, FunctionName, HiddenReason, InvocationID, InvocationParams, LinkID, MergeBaseRevisionNum, MergeEndRevisionNum, MergeSourceID, MutationID, MutationNum, OrganizationID, ReplayOutcome, ReplayReason, RestoredRevisionNum, RevisionID, RevisionNum, SpaceID, Subgroup, TriggerID, UnitID, UpdatedAt.
|
|
52642
53311
|
*
|
|
52643
53312
|
* Selects Mutations of this Unit whose paths the merge must not overwrite, unioned with the Protected values stored on the Unit's MutationSources.
|
|
52644
53313
|
*
|