@confighub/api 0.8.8 → 0.8.10
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 +1933 -331
- package/dist/index.d.ts +1933 -331
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -34,6 +34,30 @@ interface paths {
|
|
|
34
34
|
patch: operations["BulkPatchComponents"];
|
|
35
35
|
trace?: never;
|
|
36
36
|
};
|
|
37
|
+
"/_service_account": {
|
|
38
|
+
parameters: {
|
|
39
|
+
query?: never;
|
|
40
|
+
header?: never;
|
|
41
|
+
path?: never;
|
|
42
|
+
cookie?: never;
|
|
43
|
+
};
|
|
44
|
+
get?: never;
|
|
45
|
+
put?: never;
|
|
46
|
+
post?: never;
|
|
47
|
+
/**
|
|
48
|
+
* Bulk delete multiple service accounts
|
|
49
|
+
* @description Delete multiple service accounts selected by query parameters
|
|
50
|
+
*/
|
|
51
|
+
delete: operations["BulkDeleteServiceAccounts"];
|
|
52
|
+
options?: never;
|
|
53
|
+
head?: never;
|
|
54
|
+
/**
|
|
55
|
+
* Bulk patch multiple service accounts
|
|
56
|
+
* @description Apply JSON merge patch to multiple service accounts selected by query parameters
|
|
57
|
+
*/
|
|
58
|
+
patch: operations["BulkPatchServiceAccounts"];
|
|
59
|
+
trace?: never;
|
|
60
|
+
};
|
|
37
61
|
"/_space": {
|
|
38
62
|
parameters: {
|
|
39
63
|
query?: never;
|
|
@@ -641,12 +665,12 @@ interface paths {
|
|
|
641
665
|
put?: never;
|
|
642
666
|
/**
|
|
643
667
|
* Add a bot User to a Group
|
|
644
|
-
* @description Add the bot User of a BridgeWorker in the caller's Organization to the Group. Other Users' Group memberships are managed in the identity provider. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's BridgeWorker. Adding a bot that is already a member does nothing. Returns the bot User with its GroupIDs.
|
|
668
|
+
* @description Add the User of a ServiceAccount, or the bot User of a BridgeWorker, in the caller's Organization to the Group. Other Users' Group memberships are managed in the identity provider. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's ServiceAccount or BridgeWorker. Adding a bot that is already a member does nothing. Returns the bot User with its GroupIDs.
|
|
645
669
|
*/
|
|
646
670
|
post: operations["AddGroupBotUser"];
|
|
647
671
|
/**
|
|
648
672
|
* Remove a bot User from a Group
|
|
649
|
-
* @description Remove the bot User of a BridgeWorker in the caller's Organization from the Group. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's BridgeWorker. Removing a bot that is not a member does nothing. Returns the bot User with its GroupIDs.
|
|
673
|
+
* @description Remove the User of a ServiceAccount, or the bot User of a BridgeWorker, in the caller's Organization from the Group. An organization admin or manager may. So may a member of the Group who has Manage permission on the bot User's ServiceAccount or BridgeWorker. Removing a bot that is not a member does nothing. Returns the bot User with its GroupIDs.
|
|
650
674
|
*/
|
|
651
675
|
delete: operations["RemoveGroupBotUser"];
|
|
652
676
|
options?: never;
|
|
@@ -1094,6 +1118,106 @@ interface paths {
|
|
|
1094
1118
|
patch?: never;
|
|
1095
1119
|
trace?: never;
|
|
1096
1120
|
};
|
|
1121
|
+
"/service_account": {
|
|
1122
|
+
parameters: {
|
|
1123
|
+
query?: never;
|
|
1124
|
+
header?: never;
|
|
1125
|
+
path?: never;
|
|
1126
|
+
cookie?: never;
|
|
1127
|
+
};
|
|
1128
|
+
/**
|
|
1129
|
+
* List ServiceAccounts
|
|
1130
|
+
* @description List ServiceAccounts
|
|
1131
|
+
*/
|
|
1132
|
+
get: operations["ListServiceAccounts"];
|
|
1133
|
+
put?: never;
|
|
1134
|
+
/**
|
|
1135
|
+
* Create ServiceAccount
|
|
1136
|
+
* @description Create ServiceAccount
|
|
1137
|
+
*/
|
|
1138
|
+
post: operations["CreateServiceAccount"];
|
|
1139
|
+
delete?: never;
|
|
1140
|
+
options?: never;
|
|
1141
|
+
head?: never;
|
|
1142
|
+
patch?: never;
|
|
1143
|
+
trace?: never;
|
|
1144
|
+
};
|
|
1145
|
+
"/service_account/{service_account_id}": {
|
|
1146
|
+
parameters: {
|
|
1147
|
+
query?: never;
|
|
1148
|
+
header?: never;
|
|
1149
|
+
path?: never;
|
|
1150
|
+
cookie?: never;
|
|
1151
|
+
};
|
|
1152
|
+
/**
|
|
1153
|
+
* Get ServiceAccount
|
|
1154
|
+
* @description Get ServiceAccount
|
|
1155
|
+
*/
|
|
1156
|
+
get: operations["GetServiceAccount"];
|
|
1157
|
+
/**
|
|
1158
|
+
* Update ServiceAccount
|
|
1159
|
+
* @description Update ServiceAccount
|
|
1160
|
+
*/
|
|
1161
|
+
put: operations["UpdateServiceAccount"];
|
|
1162
|
+
post?: never;
|
|
1163
|
+
/**
|
|
1164
|
+
* Delete ServiceAccount
|
|
1165
|
+
* @description Delete ServiceAccount
|
|
1166
|
+
*/
|
|
1167
|
+
delete: operations["DeleteServiceAccount"];
|
|
1168
|
+
options?: never;
|
|
1169
|
+
head?: never;
|
|
1170
|
+
/**
|
|
1171
|
+
* Patch ServiceAccount
|
|
1172
|
+
* @description Patch ServiceAccount
|
|
1173
|
+
*/
|
|
1174
|
+
patch: operations["PatchServiceAccount"];
|
|
1175
|
+
trace?: never;
|
|
1176
|
+
};
|
|
1177
|
+
"/service_account/{service_account_id}/key": {
|
|
1178
|
+
parameters: {
|
|
1179
|
+
query?: never;
|
|
1180
|
+
header?: never;
|
|
1181
|
+
path?: never;
|
|
1182
|
+
cookie?: never;
|
|
1183
|
+
};
|
|
1184
|
+
/**
|
|
1185
|
+
* List a service account's public keys
|
|
1186
|
+
* @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.
|
|
1187
|
+
*/
|
|
1188
|
+
get: operations["ListServiceAccountKeys"];
|
|
1189
|
+
put?: never;
|
|
1190
|
+
/**
|
|
1191
|
+
* Register a public key for a service account
|
|
1192
|
+
* @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.
|
|
1193
|
+
*/
|
|
1194
|
+
post: operations["CreateServiceAccountKey"];
|
|
1195
|
+
delete?: never;
|
|
1196
|
+
options?: never;
|
|
1197
|
+
head?: never;
|
|
1198
|
+
patch?: never;
|
|
1199
|
+
trace?: never;
|
|
1200
|
+
};
|
|
1201
|
+
"/service_account/{service_account_id}/key/{kid}": {
|
|
1202
|
+
parameters: {
|
|
1203
|
+
query?: never;
|
|
1204
|
+
header?: never;
|
|
1205
|
+
path?: never;
|
|
1206
|
+
cookie?: never;
|
|
1207
|
+
};
|
|
1208
|
+
get?: never;
|
|
1209
|
+
put?: never;
|
|
1210
|
+
post?: never;
|
|
1211
|
+
/**
|
|
1212
|
+
* Remove a public key from a service account
|
|
1213
|
+
* @description Remove one of a service account's public keys by its thumbprint. This is the second half of rotation, and the response to a compromised private key. Requires Impersonate permission on the service account.
|
|
1214
|
+
*/
|
|
1215
|
+
delete: operations["DeleteServiceAccountKey"];
|
|
1216
|
+
options?: never;
|
|
1217
|
+
head?: never;
|
|
1218
|
+
patch?: never;
|
|
1219
|
+
trace?: never;
|
|
1220
|
+
};
|
|
1097
1221
|
"/space": {
|
|
1098
1222
|
parameters: {
|
|
1099
1223
|
query?: never;
|
|
@@ -4911,6 +5035,11 @@ interface components {
|
|
|
4911
5035
|
Unit?: components["schemas"]["Unit"];
|
|
4912
5036
|
User?: components["schemas"]["User"];
|
|
4913
5037
|
};
|
|
5038
|
+
ExtendedServiceAccount: {
|
|
5039
|
+
Error?: components["schemas"]["ResponseError"];
|
|
5040
|
+
Organization?: components["schemas"]["Organization"];
|
|
5041
|
+
ServiceAccount?: components["schemas"]["ServiceAccount"];
|
|
5042
|
+
};
|
|
4914
5043
|
ExtendedSpace: {
|
|
4915
5044
|
AttributeFilter?: components["schemas"]["Filter"];
|
|
4916
5045
|
Attributes?: components["schemas"]["Attribute"][];
|
|
@@ -6152,6 +6281,8 @@ interface components {
|
|
|
6152
6281
|
PromoteUnitResult: {
|
|
6153
6282
|
/** @description Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip. */
|
|
6154
6283
|
Action?: string;
|
|
6284
|
+
/** @description The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes. */
|
|
6285
|
+
ConfigData?: string;
|
|
6155
6286
|
/** @description Paths withheld because they were overridden locally or guarded. */
|
|
6156
6287
|
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
6157
6288
|
/** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
|
|
@@ -6963,6 +7094,72 @@ interface components {
|
|
|
6963
7094
|
Slug?: string;
|
|
6964
7095
|
SpaceSlug?: string;
|
|
6965
7096
|
};
|
|
7097
|
+
/** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */
|
|
7098
|
+
ServiceAccount: {
|
|
7099
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
7100
|
+
Annotations?: {
|
|
7101
|
+
[key: string]: string;
|
|
7102
|
+
};
|
|
7103
|
+
/**
|
|
7104
|
+
* Format: date-time
|
|
7105
|
+
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
7106
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
7107
|
+
*/
|
|
7108
|
+
readonly CreatedAt?: string;
|
|
7109
|
+
/** @description An optional set of gates that, if any is present, will block deletion. */
|
|
7110
|
+
DeleteGates?: {
|
|
7111
|
+
[key: string]: boolean;
|
|
7112
|
+
};
|
|
7113
|
+
/** @description Friendly name for the entity. */
|
|
7114
|
+
DisplayName?: string;
|
|
7115
|
+
/** @description The type of entity. */
|
|
7116
|
+
readonly EntityType?: string;
|
|
7117
|
+
/** @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. */
|
|
7118
|
+
HiddenReason?: string;
|
|
7119
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
7120
|
+
Labels?: {
|
|
7121
|
+
[key: string]: string;
|
|
7122
|
+
};
|
|
7123
|
+
/** @description Organization-level role of the ServiceAccount's User. Defaults to none, which leaves the User with only the permissions granted to it. It cannot be set above the role of the caller setting it, and changing it requires Manage permission on the service account. */
|
|
7124
|
+
OrgRole?: string;
|
|
7125
|
+
/**
|
|
7126
|
+
* Format: uuid
|
|
7127
|
+
* @description Unique identifier for an organization.
|
|
7128
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
7129
|
+
*/
|
|
7130
|
+
OrganizationID?: string;
|
|
7131
|
+
/** @description Permissions to access this service account. */
|
|
7132
|
+
Permissions?: components["schemas"]["Permissions"];
|
|
7133
|
+
/**
|
|
7134
|
+
* Format: uuid
|
|
7135
|
+
* @description Unique identifier for a service account.
|
|
7136
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
7137
|
+
*/
|
|
7138
|
+
ServiceAccountID?: string;
|
|
7139
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
7140
|
+
Slug: string;
|
|
7141
|
+
/**
|
|
7142
|
+
* Format: date-time
|
|
7143
|
+
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
7144
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
7145
|
+
*/
|
|
7146
|
+
readonly UpdatedAt?: string;
|
|
7147
|
+
/**
|
|
7148
|
+
* Format: uuid
|
|
7149
|
+
* @description The User the service account acts as. Grant the service account access to other entities by naming this User in their Permissions, or by adding it to a Group.
|
|
7150
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
7151
|
+
*/
|
|
7152
|
+
readonly UserID?: string;
|
|
7153
|
+
/**
|
|
7154
|
+
* Format: int64
|
|
7155
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
7156
|
+
*/
|
|
7157
|
+
Version?: number;
|
|
7158
|
+
};
|
|
7159
|
+
ServiceAccountCreateOrUpdateResponse: {
|
|
7160
|
+
Error?: components["schemas"]["ResponseError"];
|
|
7161
|
+
ServiceAccount?: components["schemas"]["ServiceAccount"];
|
|
7162
|
+
};
|
|
6966
7163
|
/** @description The logical container for most entities in ConfigHub. Namespaces triggers, units, targets, workers, and other entities. */
|
|
6967
7164
|
Space: {
|
|
6968
7165
|
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -8203,8 +8400,12 @@ interface components {
|
|
|
8203
8400
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8204
8401
|
*/
|
|
8205
8402
|
ChangeSetID?: string;
|
|
8403
|
+
/** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
|
|
8404
|
+
Clearance?: components["schemas"]["Clearance"];
|
|
8206
8405
|
/** @description Placement of each component. Exactly one is supported. */
|
|
8207
8406
|
Components?: components["schemas"]["UploadComponentRequest"][];
|
|
8407
|
+
/** @description Plan the upload and return the same response without writing anything. */
|
|
8408
|
+
DryRun?: boolean;
|
|
8208
8409
|
/** @description The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given. */
|
|
8209
8410
|
Files?: components["schemas"]["UploadRequestFile"][];
|
|
8210
8411
|
/** @description The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied. */
|
|
@@ -8216,6 +8417,14 @@ interface components {
|
|
|
8216
8417
|
};
|
|
8217
8418
|
/** @description Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}. */
|
|
8218
8419
|
SpacePattern?: string;
|
|
8420
|
+
/** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */
|
|
8421
|
+
Subgroup?: string;
|
|
8422
|
+
/**
|
|
8423
|
+
* Format: uuid
|
|
8424
|
+
* @description A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written.
|
|
8425
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8426
|
+
*/
|
|
8427
|
+
TagID?: string;
|
|
8219
8428
|
};
|
|
8220
8429
|
UploadRequestFile: {
|
|
8221
8430
|
/** @description The file's contents. */
|
|
@@ -8957,12 +9166,12 @@ interface operations {
|
|
|
8957
9166
|
};
|
|
8958
9167
|
};
|
|
8959
9168
|
};
|
|
8960
|
-
|
|
9169
|
+
BulkDeleteServiceAccounts: {
|
|
8961
9170
|
parameters: {
|
|
8962
9171
|
query?: {
|
|
8963
9172
|
/**
|
|
8964
9173
|
* @description The specified string is an expression for the purpose of filtering
|
|
8965
|
-
* the list of
|
|
9174
|
+
* the list of ServiceAccounts returned. The expression syntax was inspired by SQL.
|
|
8966
9175
|
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
8967
9176
|
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
8968
9177
|
* as in the JSON encoding.
|
|
@@ -8995,17 +9204,17 @@ interface operations {
|
|
|
8995
9204
|
* An example conjunction is:
|
|
8996
9205
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
8997
9206
|
*
|
|
8998
|
-
* Supported attributes for filtering on
|
|
9207
|
+
* Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID.
|
|
8999
9208
|
*
|
|
9000
9209
|
* The whole string must be query-encoded.
|
|
9001
9210
|
*/
|
|
9002
9211
|
where?: string;
|
|
9003
9212
|
/**
|
|
9004
|
-
* @description UUID of a Filter entity to apply to the
|
|
9213
|
+
* @description UUID of a Filter entity to apply to the ServiceAccount list.
|
|
9005
9214
|
*
|
|
9006
9215
|
* The Filter must be in the same Organization as the user credentials.
|
|
9007
9216
|
*
|
|
9008
|
-
* The Filter's From field must match the entity type being filtered (
|
|
9217
|
+
* The Filter's From field must match the entity type being filtered (ServiceAccount).
|
|
9009
9218
|
*
|
|
9010
9219
|
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
9011
9220
|
*
|
|
@@ -9027,13 +9236,13 @@ interface operations {
|
|
|
9027
9236
|
*
|
|
9028
9237
|
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
9029
9238
|
*
|
|
9030
|
-
* Searchable fields for
|
|
9239
|
+
* Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list.
|
|
9031
9240
|
*
|
|
9032
9241
|
* The whole string must be query-encoded.
|
|
9033
9242
|
*/
|
|
9034
9243
|
contains?: string;
|
|
9035
9244
|
/**
|
|
9036
|
-
* @description Hidden
|
|
9245
|
+
* @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
9037
9246
|
*
|
|
9038
9247
|
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
9039
9248
|
*
|
|
@@ -9043,125 +9252,25 @@ interface operations {
|
|
|
9043
9252
|
*/
|
|
9044
9253
|
include_hidden?: string;
|
|
9045
9254
|
/**
|
|
9046
|
-
* @description Include clause for expanding related entities in the response for
|
|
9255
|
+
* @description Include clause for expanding related entities in the response for ServiceAccount.
|
|
9047
9256
|
* The attribute names are case-sensitive, PascalCase, and
|
|
9048
9257
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
9049
9258
|
*
|
|
9050
|
-
* Supported attributes for
|
|
9259
|
+
* Supported attributes for ServiceAccount are OrganizationID.
|
|
9051
9260
|
*
|
|
9052
9261
|
* The whole string must be query-encoded.
|
|
9053
9262
|
*/
|
|
9054
9263
|
include?: string;
|
|
9055
|
-
/** @description Maximum number of
|
|
9264
|
+
/** @description Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
9056
9265
|
limit?: number;
|
|
9057
|
-
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the
|
|
9266
|
+
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
9058
9267
|
continue?: string;
|
|
9059
|
-
/** @description Comma-separated list of prefixes to apply to cloned Space names */
|
|
9060
|
-
name_prefixes?: string;
|
|
9061
|
-
/** @description Comma-separated list of labels with multiple values for cloned Space labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
|
|
9062
|
-
variant_labels?: string;
|
|
9063
|
-
/** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
|
|
9064
|
-
name_pattern?: string;
|
|
9065
|
-
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
9066
|
-
allow_exists?: string;
|
|
9067
|
-
/** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */
|
|
9068
|
-
with_backing_units?: boolean;
|
|
9069
|
-
/** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */
|
|
9070
|
-
backing_unit_space?: string;
|
|
9071
|
-
/** @description Create Spaces from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
|
|
9072
|
-
from_backing_units?: boolean;
|
|
9073
|
-
/**
|
|
9074
|
-
* @description The specified string is an expression for the purpose of filtering
|
|
9075
|
-
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
9076
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
9077
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
9078
|
-
* as in the JSON encoding.
|
|
9079
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
9080
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
9081
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
9082
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
9083
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
9084
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
9085
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
9086
|
-
* UUID and time literals must be quoted as string literals.
|
|
9087
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
9088
|
-
* Time literals use the same form as when serialized as JSON,
|
|
9089
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
9090
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
9091
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
9092
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
9093
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
9094
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
9095
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
9096
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
9097
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
9098
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
9099
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
9100
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
9101
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
9102
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
9103
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
9104
|
-
* Conjunctions are supported using the `AND` operator.
|
|
9105
|
-
* An example conjunction is:
|
|
9106
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9107
|
-
*
|
|
9108
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
9109
|
-
*
|
|
9110
|
-
* The Units to create entities from, with from_backing_units.
|
|
9111
|
-
*
|
|
9112
|
-
* The whole string must be query-encoded.
|
|
9113
|
-
*/
|
|
9114
|
-
where_unit?: string;
|
|
9115
|
-
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
9116
|
-
filter_unit?: string;
|
|
9117
|
-
/** @description With from_backing_units, patch a Space a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Space is returned as it is. */
|
|
9118
|
-
patch_existing?: boolean;
|
|
9119
|
-
/** @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. */
|
|
9120
|
-
dry_run?: boolean;
|
|
9121
9268
|
};
|
|
9122
9269
|
header?: never;
|
|
9123
9270
|
path?: never;
|
|
9124
9271
|
cookie?: never;
|
|
9125
9272
|
};
|
|
9126
|
-
requestBody?:
|
|
9127
|
-
content: {
|
|
9128
|
-
"application/merge-patch+json": {
|
|
9129
|
-
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
9130
|
-
Annotations?: {
|
|
9131
|
-
[key: string]: string | null;
|
|
9132
|
-
} | null;
|
|
9133
|
-
/** Format: uuid */
|
|
9134
|
-
AttributeFilterID?: string | null;
|
|
9135
|
-
/** Format: uuid */
|
|
9136
|
-
ComponentID?: string | null;
|
|
9137
|
-
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
9138
|
-
DeleteGates?: {
|
|
9139
|
-
[key: string]: boolean | null;
|
|
9140
|
-
} | null;
|
|
9141
|
-
/** @description Friendly name for the entity. */
|
|
9142
|
-
DisplayName?: string | null;
|
|
9143
|
-
/** @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. */
|
|
9144
|
-
HiddenReason?: string | null;
|
|
9145
|
-
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
9146
|
-
Labels?: {
|
|
9147
|
-
[key: string]: string | null;
|
|
9148
|
-
} | null;
|
|
9149
|
-
Permissions?: {
|
|
9150
|
-
[key: string]: Record<string, never> | null;
|
|
9151
|
-
} | null;
|
|
9152
|
-
/** Format: uuid */
|
|
9153
|
-
ReleaseTargetID?: string | null;
|
|
9154
|
-
/** @description Unique URL-safe identifier for the entity. */
|
|
9155
|
-
Slug?: string | null;
|
|
9156
|
-
/** Format: uuid */
|
|
9157
|
-
TriggerFilterID?: string | null;
|
|
9158
|
-
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
9159
|
-
Version?: number | null;
|
|
9160
|
-
WhereAttribute?: string | null;
|
|
9161
|
-
WhereTrigger?: string | null;
|
|
9162
|
-
};
|
|
9163
|
-
};
|
|
9164
|
-
};
|
|
9273
|
+
requestBody?: never;
|
|
9165
9274
|
responses: {
|
|
9166
9275
|
/** @description OK */
|
|
9167
9276
|
200: {
|
|
@@ -9171,19 +9280,19 @@ interface operations {
|
|
|
9171
9280
|
[name: string]: unknown;
|
|
9172
9281
|
};
|
|
9173
9282
|
content: {
|
|
9174
|
-
"application/json": components["schemas"]["
|
|
9283
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9175
9284
|
};
|
|
9176
9285
|
};
|
|
9177
|
-
/** @description Multi-Status
|
|
9286
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
9178
9287
|
207: {
|
|
9179
9288
|
headers: {
|
|
9180
9289
|
[name: string]: unknown;
|
|
9181
9290
|
};
|
|
9182
9291
|
content: {
|
|
9183
|
-
"application/json": components["schemas"]["
|
|
9292
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9184
9293
|
};
|
|
9185
9294
|
};
|
|
9186
|
-
/** @description
|
|
9295
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
9187
9296
|
400: {
|
|
9188
9297
|
headers: {
|
|
9189
9298
|
[name: string]: unknown;
|
|
@@ -9210,7 +9319,7 @@ interface operations {
|
|
|
9210
9319
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9211
9320
|
};
|
|
9212
9321
|
};
|
|
9213
|
-
/** @description
|
|
9322
|
+
/** @description ServiceAccount not found. */
|
|
9214
9323
|
404: {
|
|
9215
9324
|
headers: {
|
|
9216
9325
|
[name: string]: unknown;
|
|
@@ -9219,7 +9328,7 @@ interface operations {
|
|
|
9219
9328
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9220
9329
|
};
|
|
9221
9330
|
};
|
|
9222
|
-
/** @description
|
|
9331
|
+
/** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
9223
9332
|
409: {
|
|
9224
9333
|
headers: {
|
|
9225
9334
|
[name: string]: unknown;
|
|
@@ -9228,7 +9337,7 @@ interface operations {
|
|
|
9228
9337
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9229
9338
|
};
|
|
9230
9339
|
};
|
|
9231
|
-
/** @description
|
|
9340
|
+
/** @description Unable to delete entity */
|
|
9232
9341
|
422: {
|
|
9233
9342
|
headers: {
|
|
9234
9343
|
[name: string]: unknown;
|
|
@@ -9237,7 +9346,7 @@ interface operations {
|
|
|
9237
9346
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9238
9347
|
};
|
|
9239
9348
|
};
|
|
9240
|
-
/** @description Something went wrong while processing
|
|
9349
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
9241
9350
|
500: {
|
|
9242
9351
|
headers: {
|
|
9243
9352
|
[name: string]: unknown;
|
|
@@ -9257,12 +9366,12 @@ interface operations {
|
|
|
9257
9366
|
};
|
|
9258
9367
|
};
|
|
9259
9368
|
};
|
|
9260
|
-
|
|
9369
|
+
BulkPatchServiceAccounts: {
|
|
9261
9370
|
parameters: {
|
|
9262
9371
|
query?: {
|
|
9263
9372
|
/**
|
|
9264
9373
|
* @description The specified string is an expression for the purpose of filtering
|
|
9265
|
-
* the list of
|
|
9374
|
+
* the list of ServiceAccounts returned. The expression syntax was inspired by SQL.
|
|
9266
9375
|
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
9267
9376
|
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
9268
9377
|
* as in the JSON encoding.
|
|
@@ -9295,17 +9404,17 @@ interface operations {
|
|
|
9295
9404
|
* An example conjunction is:
|
|
9296
9405
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9297
9406
|
*
|
|
9298
|
-
* Supported attributes for filtering on
|
|
9407
|
+
* Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID.
|
|
9299
9408
|
*
|
|
9300
9409
|
* The whole string must be query-encoded.
|
|
9301
9410
|
*/
|
|
9302
9411
|
where?: string;
|
|
9303
9412
|
/**
|
|
9304
|
-
* @description UUID of a Filter entity to apply to the
|
|
9413
|
+
* @description UUID of a Filter entity to apply to the ServiceAccount list.
|
|
9305
9414
|
*
|
|
9306
9415
|
* The Filter must be in the same Organization as the user credentials.
|
|
9307
9416
|
*
|
|
9308
|
-
* The Filter's From field must match the entity type being filtered (
|
|
9417
|
+
* The Filter's From field must match the entity type being filtered (ServiceAccount).
|
|
9309
9418
|
*
|
|
9310
9419
|
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
9311
9420
|
*
|
|
@@ -9327,13 +9436,13 @@ interface operations {
|
|
|
9327
9436
|
*
|
|
9328
9437
|
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
9329
9438
|
*
|
|
9330
|
-
* Searchable fields for
|
|
9439
|
+
* Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list.
|
|
9331
9440
|
*
|
|
9332
9441
|
* The whole string must be query-encoded.
|
|
9333
9442
|
*/
|
|
9334
9443
|
contains?: string;
|
|
9335
9444
|
/**
|
|
9336
|
-
* @description Hidden
|
|
9445
|
+
* @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
9337
9446
|
*
|
|
9338
9447
|
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
9339
9448
|
*
|
|
@@ -9343,33 +9452,56 @@ interface operations {
|
|
|
9343
9452
|
*/
|
|
9344
9453
|
include_hidden?: string;
|
|
9345
9454
|
/**
|
|
9346
|
-
* @description Include clause for expanding related entities in the response for
|
|
9455
|
+
* @description Include clause for expanding related entities in the response for ServiceAccount.
|
|
9347
9456
|
* The attribute names are case-sensitive, PascalCase, and
|
|
9348
9457
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
9349
9458
|
*
|
|
9350
|
-
* Supported attributes for
|
|
9459
|
+
* Supported attributes for ServiceAccount are OrganizationID.
|
|
9351
9460
|
*
|
|
9352
9461
|
* The whole string must be query-encoded.
|
|
9353
9462
|
*/
|
|
9354
9463
|
include?: string;
|
|
9355
|
-
/** @description Maximum number of
|
|
9464
|
+
/** @description Maximum number of ServiceAccount entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
9356
9465
|
limit?: number;
|
|
9357
|
-
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the
|
|
9466
|
+
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the ServiceAccount entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
9358
9467
|
continue?: string;
|
|
9359
|
-
/** @description
|
|
9360
|
-
|
|
9361
|
-
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
9362
|
-
recursive_force?: string;
|
|
9363
|
-
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
9364
|
-
detach?: boolean;
|
|
9365
|
-
/** @description Prune: of the Spaces selected, delete those whose backing Unit is empty, which says the Space should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Space's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */
|
|
9366
|
-
from_backing_units?: boolean;
|
|
9468
|
+
/** @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. */
|
|
9469
|
+
dry_run?: boolean;
|
|
9367
9470
|
};
|
|
9368
9471
|
header?: never;
|
|
9369
9472
|
path?: never;
|
|
9370
9473
|
cookie?: never;
|
|
9371
9474
|
};
|
|
9372
|
-
requestBody?:
|
|
9475
|
+
requestBody?: {
|
|
9476
|
+
content: {
|
|
9477
|
+
"application/merge-patch+json": {
|
|
9478
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
9479
|
+
Annotations?: {
|
|
9480
|
+
[key: string]: string | null;
|
|
9481
|
+
} | null;
|
|
9482
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
9483
|
+
DeleteGates?: {
|
|
9484
|
+
[key: string]: boolean | null;
|
|
9485
|
+
} | null;
|
|
9486
|
+
/** @description Friendly name for the entity. */
|
|
9487
|
+
DisplayName?: string | null;
|
|
9488
|
+
/** @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. */
|
|
9489
|
+
HiddenReason?: string | null;
|
|
9490
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
9491
|
+
Labels?: {
|
|
9492
|
+
[key: string]: string | null;
|
|
9493
|
+
} | null;
|
|
9494
|
+
OrgRole?: string | null;
|
|
9495
|
+
Permissions?: {
|
|
9496
|
+
[key: string]: Record<string, never> | null;
|
|
9497
|
+
} | null;
|
|
9498
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
9499
|
+
Slug?: string | null;
|
|
9500
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
9501
|
+
Version?: number | null;
|
|
9502
|
+
};
|
|
9503
|
+
};
|
|
9504
|
+
};
|
|
9373
9505
|
responses: {
|
|
9374
9506
|
/** @description OK */
|
|
9375
9507
|
200: {
|
|
@@ -9379,7 +9511,7 @@ interface operations {
|
|
|
9379
9511
|
[name: string]: unknown;
|
|
9380
9512
|
};
|
|
9381
9513
|
content: {
|
|
9382
|
-
"application/json": components["schemas"]["
|
|
9514
|
+
"application/json": components["schemas"]["ServiceAccountCreateOrUpdateResponse"][];
|
|
9383
9515
|
};
|
|
9384
9516
|
};
|
|
9385
9517
|
/** @description Multi-Status: Mixed success and failure results */
|
|
@@ -9388,10 +9520,10 @@ interface operations {
|
|
|
9388
9520
|
[name: string]: unknown;
|
|
9389
9521
|
};
|
|
9390
9522
|
content: {
|
|
9391
|
-
"application/json": components["schemas"]["
|
|
9523
|
+
"application/json": components["schemas"]["ServiceAccountCreateOrUpdateResponse"][];
|
|
9392
9524
|
};
|
|
9393
9525
|
};
|
|
9394
|
-
/** @description
|
|
9526
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
9395
9527
|
400: {
|
|
9396
9528
|
headers: {
|
|
9397
9529
|
[name: string]: unknown;
|
|
@@ -9418,7 +9550,7 @@ interface operations {
|
|
|
9418
9550
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9419
9551
|
};
|
|
9420
9552
|
};
|
|
9421
|
-
/** @description
|
|
9553
|
+
/** @description ServiceAccount not found. */
|
|
9422
9554
|
404: {
|
|
9423
9555
|
headers: {
|
|
9424
9556
|
[name: string]: unknown;
|
|
@@ -9427,7 +9559,7 @@ interface operations {
|
|
|
9427
9559
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9428
9560
|
};
|
|
9429
9561
|
};
|
|
9430
|
-
/** @description
|
|
9562
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
9431
9563
|
409: {
|
|
9432
9564
|
headers: {
|
|
9433
9565
|
[name: string]: unknown;
|
|
@@ -9436,16 +9568,7 @@ interface operations {
|
|
|
9436
9568
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9437
9569
|
};
|
|
9438
9570
|
};
|
|
9439
|
-
/** @description
|
|
9440
|
-
422: {
|
|
9441
|
-
headers: {
|
|
9442
|
-
[name: string]: unknown;
|
|
9443
|
-
};
|
|
9444
|
-
content: {
|
|
9445
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
9446
|
-
};
|
|
9447
|
-
};
|
|
9448
|
-
/** @description Something went wrong while processing Space. */
|
|
9571
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
9449
9572
|
500: {
|
|
9450
9573
|
headers: {
|
|
9451
9574
|
[name: string]: unknown;
|
|
@@ -9465,7 +9588,7 @@ interface operations {
|
|
|
9465
9588
|
};
|
|
9466
9589
|
};
|
|
9467
9590
|
};
|
|
9468
|
-
|
|
9591
|
+
BulkCreateSpaces: {
|
|
9469
9592
|
parameters: {
|
|
9470
9593
|
query?: {
|
|
9471
9594
|
/**
|
|
@@ -9564,14 +9687,66 @@ interface operations {
|
|
|
9564
9687
|
limit?: number;
|
|
9565
9688
|
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
9566
9689
|
continue?: string;
|
|
9567
|
-
/** @description
|
|
9568
|
-
|
|
9690
|
+
/** @description Comma-separated list of prefixes to apply to cloned Space names */
|
|
9691
|
+
name_prefixes?: string;
|
|
9692
|
+
/** @description Comma-separated list of labels with multiple values for cloned Space labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
|
|
9693
|
+
variant_labels?: string;
|
|
9694
|
+
/** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
|
|
9695
|
+
name_pattern?: string;
|
|
9696
|
+
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
9697
|
+
allow_exists?: string;
|
|
9569
9698
|
/** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */
|
|
9570
9699
|
with_backing_units?: boolean;
|
|
9571
9700
|
/** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */
|
|
9572
9701
|
backing_unit_space?: string;
|
|
9573
|
-
/** @description
|
|
9702
|
+
/** @description Create Spaces from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
|
|
9574
9703
|
from_backing_units?: boolean;
|
|
9704
|
+
/**
|
|
9705
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
9706
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
9707
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
9708
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
9709
|
+
* as in the JSON encoding.
|
|
9710
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
9711
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
9712
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
9713
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
9714
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
9715
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
9716
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
9717
|
+
* UUID and time literals must be quoted as string literals.
|
|
9718
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
9719
|
+
* Time literals use the same form as when serialized as JSON,
|
|
9720
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
9721
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
9722
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
9723
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
9724
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
9725
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
9726
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
9727
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
9728
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
9729
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
9730
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
9731
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
9732
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
9733
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
9734
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
9735
|
+
* Conjunctions are supported using the `AND` operator.
|
|
9736
|
+
* An example conjunction is:
|
|
9737
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9738
|
+
*
|
|
9739
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
9740
|
+
*
|
|
9741
|
+
* The Units to create entities from, with from_backing_units.
|
|
9742
|
+
*
|
|
9743
|
+
* The whole string must be query-encoded.
|
|
9744
|
+
*/
|
|
9745
|
+
where_unit?: string;
|
|
9746
|
+
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
9747
|
+
filter_unit?: string;
|
|
9748
|
+
/** @description With from_backing_units, patch a Space a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Space is returned as it is. */
|
|
9749
|
+
patch_existing?: boolean;
|
|
9575
9750
|
/** @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. */
|
|
9576
9751
|
dry_run?: boolean;
|
|
9577
9752
|
};
|
|
@@ -9630,7 +9805,7 @@ interface operations {
|
|
|
9630
9805
|
"application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][];
|
|
9631
9806
|
};
|
|
9632
9807
|
};
|
|
9633
|
-
/** @description Multi-Status
|
|
9808
|
+
/** @description Multi-Status (partial success) */
|
|
9634
9809
|
207: {
|
|
9635
9810
|
headers: {
|
|
9636
9811
|
[name: string]: unknown;
|
|
@@ -9713,41 +9888,497 @@ interface operations {
|
|
|
9713
9888
|
};
|
|
9714
9889
|
};
|
|
9715
9890
|
};
|
|
9716
|
-
|
|
9891
|
+
BulkDeleteSpaces: {
|
|
9717
9892
|
parameters: {
|
|
9718
9893
|
query?: {
|
|
9719
|
-
/**
|
|
9720
|
-
|
|
9894
|
+
/**
|
|
9895
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
9896
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
9897
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
9898
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
9899
|
+
* as in the JSON encoding.
|
|
9900
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
9901
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
9902
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
9903
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
9904
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
9905
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
9906
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
9907
|
+
* UUID and time literals must be quoted as string literals.
|
|
9908
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
9909
|
+
* Time literals use the same form as when serialized as JSON,
|
|
9910
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
9911
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
9912
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
9913
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
9914
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
9915
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
9916
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
9917
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
9918
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
9919
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
9920
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
9921
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
9922
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
9923
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
9924
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
9925
|
+
* Conjunctions are supported using the `AND` operator.
|
|
9926
|
+
* An example conjunction is:
|
|
9927
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
9928
|
+
*
|
|
9929
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
|
|
9930
|
+
*
|
|
9931
|
+
* The whole string must be query-encoded.
|
|
9932
|
+
*/
|
|
9933
|
+
where?: string;
|
|
9934
|
+
/**
|
|
9935
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
9936
|
+
*
|
|
9937
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
9938
|
+
*
|
|
9939
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
9940
|
+
*
|
|
9941
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
9942
|
+
*
|
|
9943
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
9944
|
+
*
|
|
9945
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
9946
|
+
*/
|
|
9947
|
+
filter?: string;
|
|
9948
|
+
/**
|
|
9949
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
9950
|
+
*
|
|
9951
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
9952
|
+
*
|
|
9953
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
9954
|
+
*
|
|
9955
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
9956
|
+
*
|
|
9957
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
9958
|
+
*
|
|
9959
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
9960
|
+
*
|
|
9961
|
+
* Searchable fields for Space include string and map-type attributes from the queryable attributes list.
|
|
9962
|
+
*
|
|
9963
|
+
* The whole string must be query-encoded.
|
|
9964
|
+
*/
|
|
9965
|
+
contains?: string;
|
|
9966
|
+
/**
|
|
9967
|
+
* @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
9968
|
+
*
|
|
9969
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
9970
|
+
*
|
|
9971
|
+
* 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.
|
|
9972
|
+
*
|
|
9973
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
9974
|
+
*/
|
|
9975
|
+
include_hidden?: string;
|
|
9976
|
+
/**
|
|
9977
|
+
* @description Include clause for expanding related entities in the response for Space.
|
|
9978
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
9979
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
9980
|
+
*
|
|
9981
|
+
* Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, ReleaseTargetID, TriggerFilterID, TriggerIDs.
|
|
9982
|
+
*
|
|
9983
|
+
* The whole string must be query-encoded.
|
|
9984
|
+
*/
|
|
9985
|
+
include?: string;
|
|
9986
|
+
/** @description Maximum number of Space entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
9987
|
+
limit?: number;
|
|
9988
|
+
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
9989
|
+
continue?: string;
|
|
9990
|
+
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) so long as none have delete gates. */
|
|
9991
|
+
recursive?: string;
|
|
9992
|
+
/** @description Valid values are true and false. False is the default if unspecified. If true, recursively delete all entities within the deleted space(s) regardless whether any have delete gates. */
|
|
9993
|
+
recursive_force?: string;
|
|
9994
|
+
/** @description If true, remove the references to the deleted entities from entities the request does not delete, instead of refusing the delete while any remain. References that cannot be removed still refuse it. For a Space, applies to everything the recursive delete removes. */
|
|
9995
|
+
detach?: boolean;
|
|
9996
|
+
/** @description Prune: of the Spaces selected, delete those whose backing Unit is empty, which says the Space should not exist, and keep the Unit, empty and backing nothing, so that it keeps the Space's history and a document that comes back revives it. The others are left alone and are not in the response, so a broad selection deletes only what was emptied. */
|
|
9997
|
+
from_backing_units?: boolean;
|
|
9721
9998
|
};
|
|
9722
9999
|
header?: never;
|
|
9723
10000
|
path?: never;
|
|
9724
10001
|
cookie?: never;
|
|
9725
10002
|
};
|
|
9726
|
-
requestBody?:
|
|
9727
|
-
content: {
|
|
9728
|
-
"application/json": components["schemas"]["AttestRequest"];
|
|
9729
|
-
};
|
|
9730
|
-
};
|
|
10003
|
+
requestBody?: never;
|
|
9731
10004
|
responses: {
|
|
9732
10005
|
/** @description OK */
|
|
9733
10006
|
200: {
|
|
9734
10007
|
headers: {
|
|
10008
|
+
/** @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. */
|
|
10009
|
+
"ConfigHub-Continue"?: string;
|
|
9735
10010
|
[name: string]: unknown;
|
|
9736
10011
|
};
|
|
9737
10012
|
content: {
|
|
9738
|
-
"application/json": components["schemas"]["
|
|
10013
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9739
10014
|
};
|
|
9740
10015
|
};
|
|
9741
|
-
/** @description
|
|
10016
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
9742
10017
|
207: {
|
|
9743
10018
|
headers: {
|
|
9744
10019
|
[name: string]: unknown;
|
|
9745
10020
|
};
|
|
9746
10021
|
content: {
|
|
9747
|
-
"application/json": components["schemas"]["
|
|
10022
|
+
"application/json": components["schemas"]["DeleteResponse"][];
|
|
9748
10023
|
};
|
|
9749
10024
|
};
|
|
9750
|
-
/** @description
|
|
10025
|
+
/** @description Space request is invalid (Bad Request). */
|
|
10026
|
+
400: {
|
|
10027
|
+
headers: {
|
|
10028
|
+
[name: string]: unknown;
|
|
10029
|
+
};
|
|
10030
|
+
content: {
|
|
10031
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10032
|
+
};
|
|
10033
|
+
};
|
|
10034
|
+
/** @description Unauthorized access. */
|
|
10035
|
+
401: {
|
|
10036
|
+
headers: {
|
|
10037
|
+
[name: string]: unknown;
|
|
10038
|
+
};
|
|
10039
|
+
content: {
|
|
10040
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10041
|
+
};
|
|
10042
|
+
};
|
|
10043
|
+
/** @description Forbidden access. */
|
|
10044
|
+
403: {
|
|
10045
|
+
headers: {
|
|
10046
|
+
[name: string]: unknown;
|
|
10047
|
+
};
|
|
10048
|
+
content: {
|
|
10049
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10050
|
+
};
|
|
10051
|
+
};
|
|
10052
|
+
/** @description Space not found. */
|
|
10053
|
+
404: {
|
|
10054
|
+
headers: {
|
|
10055
|
+
[name: string]: unknown;
|
|
10056
|
+
};
|
|
10057
|
+
content: {
|
|
10058
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10059
|
+
};
|
|
10060
|
+
};
|
|
10061
|
+
/** @description Space is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
10062
|
+
409: {
|
|
10063
|
+
headers: {
|
|
10064
|
+
[name: string]: unknown;
|
|
10065
|
+
};
|
|
10066
|
+
content: {
|
|
10067
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10068
|
+
};
|
|
10069
|
+
};
|
|
10070
|
+
/** @description Unable to delete entity */
|
|
10071
|
+
422: {
|
|
10072
|
+
headers: {
|
|
10073
|
+
[name: string]: unknown;
|
|
10074
|
+
};
|
|
10075
|
+
content: {
|
|
10076
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10077
|
+
};
|
|
10078
|
+
};
|
|
10079
|
+
/** @description Something went wrong while processing Space. */
|
|
10080
|
+
500: {
|
|
10081
|
+
headers: {
|
|
10082
|
+
[name: string]: unknown;
|
|
10083
|
+
};
|
|
10084
|
+
content: {
|
|
10085
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10086
|
+
};
|
|
10087
|
+
};
|
|
10088
|
+
/** @description Unexpected error. */
|
|
10089
|
+
default: {
|
|
10090
|
+
headers: {
|
|
10091
|
+
[name: string]: unknown;
|
|
10092
|
+
};
|
|
10093
|
+
content: {
|
|
10094
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10095
|
+
};
|
|
10096
|
+
};
|
|
10097
|
+
};
|
|
10098
|
+
};
|
|
10099
|
+
BulkPatchSpaces: {
|
|
10100
|
+
parameters: {
|
|
10101
|
+
query?: {
|
|
10102
|
+
/**
|
|
10103
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
10104
|
+
* the list of Spaces returned. The expression syntax was inspired by SQL.
|
|
10105
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
10106
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
10107
|
+
* as in the JSON encoding.
|
|
10108
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
10109
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
10110
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
10111
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
10112
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
10113
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
10114
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
10115
|
+
* UUID and time literals must be quoted as string literals.
|
|
10116
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
10117
|
+
* Time literals use the same form as when serialized as JSON,
|
|
10118
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
10119
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
10120
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
10121
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
10122
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
10123
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
10124
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
10125
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
10126
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
10127
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
10128
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
10129
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
10130
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
10131
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
10132
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
10133
|
+
* Conjunctions are supported using the `AND` operator.
|
|
10134
|
+
* An example conjunction is:
|
|
10135
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10136
|
+
*
|
|
10137
|
+
* Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
|
|
10138
|
+
*
|
|
10139
|
+
* The whole string must be query-encoded.
|
|
10140
|
+
*/
|
|
10141
|
+
where?: string;
|
|
10142
|
+
/**
|
|
10143
|
+
* @description UUID of a Filter entity to apply to the Space list.
|
|
10144
|
+
*
|
|
10145
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
10146
|
+
*
|
|
10147
|
+
* The Filter's From field must match the entity type being filtered (Space).
|
|
10148
|
+
*
|
|
10149
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
10150
|
+
*
|
|
10151
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
10152
|
+
*
|
|
10153
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
10154
|
+
*/
|
|
10155
|
+
filter?: string;
|
|
10156
|
+
/**
|
|
10157
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
10158
|
+
*
|
|
10159
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
10160
|
+
*
|
|
10161
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
10162
|
+
*
|
|
10163
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
10164
|
+
*
|
|
10165
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
10166
|
+
*
|
|
10167
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
10168
|
+
*
|
|
10169
|
+
* Searchable fields for Space include string and map-type attributes from the queryable attributes list.
|
|
10170
|
+
*
|
|
10171
|
+
* The whole string must be query-encoded.
|
|
10172
|
+
*/
|
|
10173
|
+
contains?: string;
|
|
10174
|
+
/**
|
|
10175
|
+
* @description Hidden Space entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
10176
|
+
*
|
|
10177
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
10178
|
+
*
|
|
10179
|
+
* 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.
|
|
10180
|
+
*
|
|
10181
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
10182
|
+
*/
|
|
10183
|
+
include_hidden?: string;
|
|
10184
|
+
/**
|
|
10185
|
+
* @description Include clause for expanding related entities in the response for Space.
|
|
10186
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
10187
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
10188
|
+
*
|
|
10189
|
+
* Supported attributes for Space are AttributeFilterID, AttributeIDs, ComponentID, OrganizationID, ReleaseTargetID, TriggerFilterID, TriggerIDs.
|
|
10190
|
+
*
|
|
10191
|
+
* The whole string must be query-encoded.
|
|
10192
|
+
*/
|
|
10193
|
+
include?: string;
|
|
10194
|
+
/** @description Maximum number of Space entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
10195
|
+
limit?: number;
|
|
10196
|
+
/** @description The token from the ConfigHub-Continue header of the previous request, to act on the Space entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
|
|
10197
|
+
continue?: string;
|
|
10198
|
+
/** @description If true, re-list the Triggers the Space selects (with WhereTrigger and/or TriggerFilterID, or the ones in it with neither) even if these fields have not changed */
|
|
10199
|
+
refresh_triggers?: boolean;
|
|
10200
|
+
/** @description Give each Space written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Space's configuration, which is then kept in step with it. */
|
|
10201
|
+
with_backing_units?: boolean;
|
|
10202
|
+
/** @description The Space, by slug or ID, for the backing Units with_backing_units creates. Required with it: a Space is in no Space of its own to hold one. */
|
|
10203
|
+
backing_unit_space?: string;
|
|
10204
|
+
/** @description Patch each selected Space with what its backing Unit holds that it has not taken yet: the change to the Unit since its LastReleasedRevisionNum. The request body is applied after it. Selecting one with no backing Unit is an error, and so are outstanding ValidationErrors on a backing Unit. */
|
|
10205
|
+
from_backing_units?: boolean;
|
|
10206
|
+
/** @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. */
|
|
10207
|
+
dry_run?: boolean;
|
|
10208
|
+
};
|
|
10209
|
+
header?: never;
|
|
10210
|
+
path?: never;
|
|
10211
|
+
cookie?: never;
|
|
10212
|
+
};
|
|
10213
|
+
requestBody?: {
|
|
10214
|
+
content: {
|
|
10215
|
+
"application/merge-patch+json": {
|
|
10216
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
10217
|
+
Annotations?: {
|
|
10218
|
+
[key: string]: string | null;
|
|
10219
|
+
} | null;
|
|
10220
|
+
/** Format: uuid */
|
|
10221
|
+
AttributeFilterID?: string | null;
|
|
10222
|
+
/** Format: uuid */
|
|
10223
|
+
ComponentID?: string | null;
|
|
10224
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
10225
|
+
DeleteGates?: {
|
|
10226
|
+
[key: string]: boolean | null;
|
|
10227
|
+
} | null;
|
|
10228
|
+
/** @description Friendly name for the entity. */
|
|
10229
|
+
DisplayName?: string | null;
|
|
10230
|
+
/** @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. */
|
|
10231
|
+
HiddenReason?: string | null;
|
|
10232
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
10233
|
+
Labels?: {
|
|
10234
|
+
[key: string]: string | null;
|
|
10235
|
+
} | null;
|
|
10236
|
+
Permissions?: {
|
|
10237
|
+
[key: string]: Record<string, never> | null;
|
|
10238
|
+
} | null;
|
|
10239
|
+
/** Format: uuid */
|
|
10240
|
+
ReleaseTargetID?: string | null;
|
|
10241
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
10242
|
+
Slug?: string | null;
|
|
10243
|
+
/** Format: uuid */
|
|
10244
|
+
TriggerFilterID?: string | null;
|
|
10245
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
10246
|
+
Version?: number | null;
|
|
10247
|
+
WhereAttribute?: string | null;
|
|
10248
|
+
WhereTrigger?: string | null;
|
|
10249
|
+
};
|
|
10250
|
+
};
|
|
10251
|
+
};
|
|
10252
|
+
responses: {
|
|
10253
|
+
/** @description OK */
|
|
10254
|
+
200: {
|
|
10255
|
+
headers: {
|
|
10256
|
+
/** @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. */
|
|
10257
|
+
"ConfigHub-Continue"?: string;
|
|
10258
|
+
[name: string]: unknown;
|
|
10259
|
+
};
|
|
10260
|
+
content: {
|
|
10261
|
+
"application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][];
|
|
10262
|
+
};
|
|
10263
|
+
};
|
|
10264
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
10265
|
+
207: {
|
|
10266
|
+
headers: {
|
|
10267
|
+
[name: string]: unknown;
|
|
10268
|
+
};
|
|
10269
|
+
content: {
|
|
10270
|
+
"application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][];
|
|
10271
|
+
};
|
|
10272
|
+
};
|
|
10273
|
+
/** @description Space request is invalid (Bad Request). */
|
|
10274
|
+
400: {
|
|
10275
|
+
headers: {
|
|
10276
|
+
[name: string]: unknown;
|
|
10277
|
+
};
|
|
10278
|
+
content: {
|
|
10279
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10280
|
+
};
|
|
10281
|
+
};
|
|
10282
|
+
/** @description Unauthorized access. */
|
|
10283
|
+
401: {
|
|
10284
|
+
headers: {
|
|
10285
|
+
[name: string]: unknown;
|
|
10286
|
+
};
|
|
10287
|
+
content: {
|
|
10288
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10289
|
+
};
|
|
10290
|
+
};
|
|
10291
|
+
/** @description Forbidden access. */
|
|
10292
|
+
403: {
|
|
10293
|
+
headers: {
|
|
10294
|
+
[name: string]: unknown;
|
|
10295
|
+
};
|
|
10296
|
+
content: {
|
|
10297
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10298
|
+
};
|
|
10299
|
+
};
|
|
10300
|
+
/** @description Space not found. */
|
|
10301
|
+
404: {
|
|
10302
|
+
headers: {
|
|
10303
|
+
[name: string]: unknown;
|
|
10304
|
+
};
|
|
10305
|
+
content: {
|
|
10306
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10307
|
+
};
|
|
10308
|
+
};
|
|
10309
|
+
/** @description Space data conflict. Data has changed since last read. */
|
|
10310
|
+
409: {
|
|
10311
|
+
headers: {
|
|
10312
|
+
[name: string]: unknown;
|
|
10313
|
+
};
|
|
10314
|
+
content: {
|
|
10315
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10316
|
+
};
|
|
10317
|
+
};
|
|
10318
|
+
/** @description A backing Unit has outstanding ValidationErrors */
|
|
10319
|
+
422: {
|
|
10320
|
+
headers: {
|
|
10321
|
+
[name: string]: unknown;
|
|
10322
|
+
};
|
|
10323
|
+
content: {
|
|
10324
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10325
|
+
};
|
|
10326
|
+
};
|
|
10327
|
+
/** @description Something went wrong while processing Space. */
|
|
10328
|
+
500: {
|
|
10329
|
+
headers: {
|
|
10330
|
+
[name: string]: unknown;
|
|
10331
|
+
};
|
|
10332
|
+
content: {
|
|
10333
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10334
|
+
};
|
|
10335
|
+
};
|
|
10336
|
+
/** @description Unexpected error. */
|
|
10337
|
+
default: {
|
|
10338
|
+
headers: {
|
|
10339
|
+
[name: string]: unknown;
|
|
10340
|
+
};
|
|
10341
|
+
content: {
|
|
10342
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
10343
|
+
};
|
|
10344
|
+
};
|
|
10345
|
+
};
|
|
10346
|
+
};
|
|
10347
|
+
Attest: {
|
|
10348
|
+
parameters: {
|
|
10349
|
+
query?: {
|
|
10350
|
+
/** @description Resolve the Revisions that would be covered and return the same response without writing anything. */
|
|
10351
|
+
dry_run?: boolean;
|
|
10352
|
+
};
|
|
10353
|
+
header?: never;
|
|
10354
|
+
path?: never;
|
|
10355
|
+
cookie?: never;
|
|
10356
|
+
};
|
|
10357
|
+
requestBody?: {
|
|
10358
|
+
content: {
|
|
10359
|
+
"application/json": components["schemas"]["AttestRequest"];
|
|
10360
|
+
};
|
|
10361
|
+
};
|
|
10362
|
+
responses: {
|
|
10363
|
+
/** @description OK */
|
|
10364
|
+
200: {
|
|
10365
|
+
headers: {
|
|
10366
|
+
[name: string]: unknown;
|
|
10367
|
+
};
|
|
10368
|
+
content: {
|
|
10369
|
+
"application/json": components["schemas"]["AttestResult"];
|
|
10370
|
+
};
|
|
10371
|
+
};
|
|
10372
|
+
/** @description Recording failed in some Spaces; each Space's result carries its own error */
|
|
10373
|
+
207: {
|
|
10374
|
+
headers: {
|
|
10375
|
+
[name: string]: unknown;
|
|
10376
|
+
};
|
|
10377
|
+
content: {
|
|
10378
|
+
"application/json": components["schemas"]["AttestResult"];
|
|
10379
|
+
};
|
|
10380
|
+
};
|
|
10381
|
+
/** @description Attest request is invalid (Bad Request). */
|
|
9751
10382
|
400: {
|
|
9752
10383
|
headers: {
|
|
9753
10384
|
[name: string]: unknown;
|
|
@@ -22222,7 +22853,7 @@ interface operations {
|
|
|
22222
22853
|
* @description Deprecated: use DryRun in the request body. Plan the promotion, evaluate its gates, and return the same response without writing anything. Either one asks for a dry run.
|
|
22223
22854
|
*/
|
|
22224
22855
|
dry_run?: boolean;
|
|
22225
|
-
/** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. On a dry run
|
|
22856
|
+
/** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named. */
|
|
22226
22857
|
include?: string;
|
|
22227
22858
|
};
|
|
22228
22859
|
header?: never;
|
|
@@ -23775,7 +24406,1006 @@ interface operations {
|
|
|
23775
24406
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
23776
24407
|
};
|
|
23777
24408
|
};
|
|
23778
|
-
/** @description Revision not found. */
|
|
24409
|
+
/** @description Revision not found. */
|
|
24410
|
+
404: {
|
|
24411
|
+
headers: {
|
|
24412
|
+
[name: string]: unknown;
|
|
24413
|
+
};
|
|
24414
|
+
content: {
|
|
24415
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24416
|
+
};
|
|
24417
|
+
};
|
|
24418
|
+
/** @description Something went wrong while processing Revision. */
|
|
24419
|
+
500: {
|
|
24420
|
+
headers: {
|
|
24421
|
+
[name: string]: unknown;
|
|
24422
|
+
};
|
|
24423
|
+
content: {
|
|
24424
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24425
|
+
};
|
|
24426
|
+
};
|
|
24427
|
+
/** @description Unexpected error. */
|
|
24428
|
+
default: {
|
|
24429
|
+
headers: {
|
|
24430
|
+
[name: string]: unknown;
|
|
24431
|
+
};
|
|
24432
|
+
content: {
|
|
24433
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24434
|
+
};
|
|
24435
|
+
};
|
|
24436
|
+
};
|
|
24437
|
+
};
|
|
24438
|
+
SearchRevisionMutationSources: {
|
|
24439
|
+
parameters: {
|
|
24440
|
+
query?: {
|
|
24441
|
+
/**
|
|
24442
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
24443
|
+
* the list of Revisions returned. The expression syntax was inspired by SQL.
|
|
24444
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
24445
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
24446
|
+
* as in the JSON encoding.
|
|
24447
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
24448
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
24449
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
24450
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
24451
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
24452
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
24453
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
24454
|
+
* UUID and time literals must be quoted as string literals.
|
|
24455
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
24456
|
+
* Time literals use the same form as when serialized as JSON,
|
|
24457
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
24458
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
24459
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
24460
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
24461
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
24462
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
24463
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
24464
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
24465
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
24466
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
24467
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
24468
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
24469
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
24470
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
24471
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
24472
|
+
* Conjunctions are supported using the `AND` operator.
|
|
24473
|
+
* An example conjunction is:
|
|
24474
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24475
|
+
*
|
|
24476
|
+
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
24477
|
+
*
|
|
24478
|
+
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
24479
|
+
*
|
|
24480
|
+
* The whole string must be query-encoded.
|
|
24481
|
+
*/
|
|
24482
|
+
where?: string;
|
|
24483
|
+
/**
|
|
24484
|
+
* @description UUID of a Filter entity to apply to the Revision list.
|
|
24485
|
+
*
|
|
24486
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
24487
|
+
*
|
|
24488
|
+
* The Filter's From field must match the entity type being filtered (Revision).
|
|
24489
|
+
*
|
|
24490
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
24491
|
+
*
|
|
24492
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
24493
|
+
*
|
|
24494
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
24495
|
+
*/
|
|
24496
|
+
filter?: string;
|
|
24497
|
+
/**
|
|
24498
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
24499
|
+
*
|
|
24500
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
24501
|
+
*
|
|
24502
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
24503
|
+
*
|
|
24504
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
24505
|
+
*
|
|
24506
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
24507
|
+
*
|
|
24508
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
24509
|
+
*
|
|
24510
|
+
* Searchable fields for Revision include string and map-type attributes from the queryable attributes list.
|
|
24511
|
+
*
|
|
24512
|
+
* The whole string must be query-encoded.
|
|
24513
|
+
*/
|
|
24514
|
+
contains?: string;
|
|
24515
|
+
/**
|
|
24516
|
+
* @description Include clause for expanding related entities in the response for Revision.
|
|
24517
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24518
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24519
|
+
*
|
|
24520
|
+
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
24521
|
+
*
|
|
24522
|
+
* The whole string must be query-encoded.
|
|
24523
|
+
*/
|
|
24524
|
+
include?: string;
|
|
24525
|
+
/**
|
|
24526
|
+
* @description Select clause for specifying which fields to include in the response for Revision.
|
|
24527
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24528
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24529
|
+
* If not specified, all fields are returned.
|
|
24530
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
24531
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
24532
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
24533
|
+
* The whole string must be query-encoded.
|
|
24534
|
+
*/
|
|
24535
|
+
select?: string;
|
|
24536
|
+
/**
|
|
24537
|
+
* @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
24538
|
+
*
|
|
24539
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
24540
|
+
*
|
|
24541
|
+
* 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.
|
|
24542
|
+
*
|
|
24543
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
24544
|
+
*/
|
|
24545
|
+
include_hidden?: string;
|
|
24546
|
+
/** @description Maximum number of Revision 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. */
|
|
24547
|
+
limit?: number;
|
|
24548
|
+
/**
|
|
24549
|
+
* @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
24550
|
+
*
|
|
24551
|
+
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
24552
|
+
*
|
|
24553
|
+
* Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID.
|
|
24554
|
+
*
|
|
24555
|
+
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
24556
|
+
*
|
|
24557
|
+
* Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are.
|
|
24558
|
+
*
|
|
24559
|
+
* The whole string must be query-encoded.
|
|
24560
|
+
*/
|
|
24561
|
+
order_by?: string;
|
|
24562
|
+
/**
|
|
24563
|
+
* @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it.
|
|
24564
|
+
*
|
|
24565
|
+
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
24566
|
+
*
|
|
24567
|
+
* 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.
|
|
24568
|
+
*/
|
|
24569
|
+
continue?: string;
|
|
24570
|
+
/**
|
|
24571
|
+
* @deprecated
|
|
24572
|
+
* @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue.
|
|
24573
|
+
*/
|
|
24574
|
+
offset?: number;
|
|
24575
|
+
/**
|
|
24576
|
+
* @description Entity to return at most one Revision per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
|
|
24577
|
+
*
|
|
24578
|
+
* Supported values: Unit, Off.
|
|
24579
|
+
*
|
|
24580
|
+
* If not specified, results are restricted to at most one row per Unit.
|
|
24581
|
+
*
|
|
24582
|
+
* Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
|
|
24583
|
+
*/
|
|
24584
|
+
distinct_on?: PathsRevision_mutation_sourcesGetParametersQueryDistinct_on;
|
|
24585
|
+
};
|
|
24586
|
+
header?: never;
|
|
24587
|
+
path?: never;
|
|
24588
|
+
cookie?: never;
|
|
24589
|
+
};
|
|
24590
|
+
requestBody?: never;
|
|
24591
|
+
responses: {
|
|
24592
|
+
/** @description OK */
|
|
24593
|
+
200: {
|
|
24594
|
+
headers: {
|
|
24595
|
+
/** @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. */
|
|
24596
|
+
"ConfigHub-Continue"?: string;
|
|
24597
|
+
[name: string]: unknown;
|
|
24598
|
+
};
|
|
24599
|
+
content: {
|
|
24600
|
+
"application/json": components["schemas"]["RevisionMutationSources"][];
|
|
24601
|
+
};
|
|
24602
|
+
};
|
|
24603
|
+
/** @description Revision request is invalid (Bad Request). */
|
|
24604
|
+
400: {
|
|
24605
|
+
headers: {
|
|
24606
|
+
[name: string]: unknown;
|
|
24607
|
+
};
|
|
24608
|
+
content: {
|
|
24609
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24610
|
+
};
|
|
24611
|
+
};
|
|
24612
|
+
/** @description Unauthorized access. */
|
|
24613
|
+
401: {
|
|
24614
|
+
headers: {
|
|
24615
|
+
[name: string]: unknown;
|
|
24616
|
+
};
|
|
24617
|
+
content: {
|
|
24618
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24619
|
+
};
|
|
24620
|
+
};
|
|
24621
|
+
/** @description Forbidden access. */
|
|
24622
|
+
403: {
|
|
24623
|
+
headers: {
|
|
24624
|
+
[name: string]: unknown;
|
|
24625
|
+
};
|
|
24626
|
+
content: {
|
|
24627
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24628
|
+
};
|
|
24629
|
+
};
|
|
24630
|
+
/** @description Revision not found. */
|
|
24631
|
+
404: {
|
|
24632
|
+
headers: {
|
|
24633
|
+
[name: string]: unknown;
|
|
24634
|
+
};
|
|
24635
|
+
content: {
|
|
24636
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24637
|
+
};
|
|
24638
|
+
};
|
|
24639
|
+
/** @description Something went wrong while processing Revision. */
|
|
24640
|
+
500: {
|
|
24641
|
+
headers: {
|
|
24642
|
+
[name: string]: unknown;
|
|
24643
|
+
};
|
|
24644
|
+
content: {
|
|
24645
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24646
|
+
};
|
|
24647
|
+
};
|
|
24648
|
+
/** @description Unexpected error. */
|
|
24649
|
+
default: {
|
|
24650
|
+
headers: {
|
|
24651
|
+
[name: string]: unknown;
|
|
24652
|
+
};
|
|
24653
|
+
content: {
|
|
24654
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24655
|
+
};
|
|
24656
|
+
};
|
|
24657
|
+
};
|
|
24658
|
+
};
|
|
24659
|
+
ListServiceAccounts: {
|
|
24660
|
+
parameters: {
|
|
24661
|
+
query?: {
|
|
24662
|
+
/**
|
|
24663
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
24664
|
+
* the list of ServiceAccounts returned. The expression syntax was inspired by SQL.
|
|
24665
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
24666
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
24667
|
+
* as in the JSON encoding.
|
|
24668
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
24669
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
24670
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
24671
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
24672
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
24673
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
24674
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
24675
|
+
* UUID and time literals must be quoted as string literals.
|
|
24676
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
24677
|
+
* Time literals use the same form as when serialized as JSON,
|
|
24678
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
24679
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
24680
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
24681
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
24682
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
24683
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
24684
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
24685
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
24686
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
24687
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
24688
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
24689
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
24690
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
24691
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
24692
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
24693
|
+
* Conjunctions are supported using the `AND` operator.
|
|
24694
|
+
* An example conjunction is:
|
|
24695
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24696
|
+
*
|
|
24697
|
+
* Supported attributes for filtering on ServiceAccount: Annotations, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrgRole, OrganizationID, Permissions, ServiceAccountID, Slug, UpdatedAt, UserID.
|
|
24698
|
+
*
|
|
24699
|
+
* The whole string must be query-encoded.
|
|
24700
|
+
*/
|
|
24701
|
+
where?: string;
|
|
24702
|
+
/**
|
|
24703
|
+
* @description UUID of a Filter entity to apply to the ServiceAccount list.
|
|
24704
|
+
*
|
|
24705
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
24706
|
+
*
|
|
24707
|
+
* The Filter's From field must match the entity type being filtered (ServiceAccount).
|
|
24708
|
+
*
|
|
24709
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
24710
|
+
*
|
|
24711
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
24712
|
+
*
|
|
24713
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
24714
|
+
*/
|
|
24715
|
+
filter?: string;
|
|
24716
|
+
/**
|
|
24717
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
24718
|
+
*
|
|
24719
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
24720
|
+
*
|
|
24721
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
24722
|
+
*
|
|
24723
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
24724
|
+
*
|
|
24725
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
24726
|
+
*
|
|
24727
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
24728
|
+
*
|
|
24729
|
+
* Searchable fields for ServiceAccount include string and map-type attributes from the queryable attributes list.
|
|
24730
|
+
*
|
|
24731
|
+
* The whole string must be query-encoded.
|
|
24732
|
+
*/
|
|
24733
|
+
contains?: string;
|
|
24734
|
+
/**
|
|
24735
|
+
* @description Include clause for expanding related entities in the response for ServiceAccount.
|
|
24736
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24737
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24738
|
+
*
|
|
24739
|
+
* Supported attributes for ServiceAccount are OrganizationID.
|
|
24740
|
+
*
|
|
24741
|
+
* The whole string must be query-encoded.
|
|
24742
|
+
*/
|
|
24743
|
+
include?: string;
|
|
24744
|
+
/**
|
|
24745
|
+
* @description Select clause for specifying which fields to include in the response for ServiceAccount.
|
|
24746
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24747
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24748
|
+
* If not specified, all fields are returned.
|
|
24749
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
|
|
24750
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
24751
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
24752
|
+
* The whole string must be query-encoded.
|
|
24753
|
+
*/
|
|
24754
|
+
select?: string;
|
|
24755
|
+
/**
|
|
24756
|
+
* @description Hidden ServiceAccount entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
24757
|
+
*
|
|
24758
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
24759
|
+
*
|
|
24760
|
+
* 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.
|
|
24761
|
+
*
|
|
24762
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
24763
|
+
*/
|
|
24764
|
+
include_hidden?: string;
|
|
24765
|
+
/** @description Maximum number of ServiceAccount 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. */
|
|
24766
|
+
limit?: number;
|
|
24767
|
+
/**
|
|
24768
|
+
* @description Comma-separated list of fields to sort ServiceAccount results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
24769
|
+
*
|
|
24770
|
+
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
24771
|
+
*
|
|
24772
|
+
* Supported attributes for ordering ServiceAccount: CreatedAt, DisplayName, HiddenReason, OrgRole, OrganizationID, ServiceAccountID, Slug, UpdatedAt, UserID.
|
|
24773
|
+
*
|
|
24774
|
+
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
24775
|
+
*
|
|
24776
|
+
* Results are ordered by the ServiceAccount's ID after the fields named, and by the ID alone if none are.
|
|
24777
|
+
*
|
|
24778
|
+
* The whole string must be query-encoded.
|
|
24779
|
+
*/
|
|
24780
|
+
order_by?: string;
|
|
24781
|
+
/**
|
|
24782
|
+
* @description The token from the ConfigHub-Continue header of the previous page, to return the ServiceAccount entities after it.
|
|
24783
|
+
*
|
|
24784
|
+
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
24785
|
+
*
|
|
24786
|
+
* 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.
|
|
24787
|
+
*/
|
|
24788
|
+
continue?: string;
|
|
24789
|
+
};
|
|
24790
|
+
header?: never;
|
|
24791
|
+
path?: never;
|
|
24792
|
+
cookie?: never;
|
|
24793
|
+
};
|
|
24794
|
+
requestBody?: never;
|
|
24795
|
+
responses: {
|
|
24796
|
+
/** @description OK */
|
|
24797
|
+
200: {
|
|
24798
|
+
headers: {
|
|
24799
|
+
/** @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. */
|
|
24800
|
+
"ConfigHub-Continue"?: string;
|
|
24801
|
+
[name: string]: unknown;
|
|
24802
|
+
};
|
|
24803
|
+
content: {
|
|
24804
|
+
"application/json": components["schemas"]["ExtendedServiceAccount"][];
|
|
24805
|
+
};
|
|
24806
|
+
};
|
|
24807
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
24808
|
+
400: {
|
|
24809
|
+
headers: {
|
|
24810
|
+
[name: string]: unknown;
|
|
24811
|
+
};
|
|
24812
|
+
content: {
|
|
24813
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24814
|
+
};
|
|
24815
|
+
};
|
|
24816
|
+
/** @description Unauthorized access. */
|
|
24817
|
+
401: {
|
|
24818
|
+
headers: {
|
|
24819
|
+
[name: string]: unknown;
|
|
24820
|
+
};
|
|
24821
|
+
content: {
|
|
24822
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24823
|
+
};
|
|
24824
|
+
};
|
|
24825
|
+
/** @description Forbidden access. */
|
|
24826
|
+
403: {
|
|
24827
|
+
headers: {
|
|
24828
|
+
[name: string]: unknown;
|
|
24829
|
+
};
|
|
24830
|
+
content: {
|
|
24831
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24832
|
+
};
|
|
24833
|
+
};
|
|
24834
|
+
/** @description ServiceAccount not found. */
|
|
24835
|
+
404: {
|
|
24836
|
+
headers: {
|
|
24837
|
+
[name: string]: unknown;
|
|
24838
|
+
};
|
|
24839
|
+
content: {
|
|
24840
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24841
|
+
};
|
|
24842
|
+
};
|
|
24843
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
24844
|
+
500: {
|
|
24845
|
+
headers: {
|
|
24846
|
+
[name: string]: unknown;
|
|
24847
|
+
};
|
|
24848
|
+
content: {
|
|
24849
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24850
|
+
};
|
|
24851
|
+
};
|
|
24852
|
+
/** @description Unexpected error. */
|
|
24853
|
+
default: {
|
|
24854
|
+
headers: {
|
|
24855
|
+
[name: string]: unknown;
|
|
24856
|
+
};
|
|
24857
|
+
content: {
|
|
24858
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24859
|
+
};
|
|
24860
|
+
};
|
|
24861
|
+
};
|
|
24862
|
+
};
|
|
24863
|
+
CreateServiceAccount: {
|
|
24864
|
+
parameters: {
|
|
24865
|
+
query?: {
|
|
24866
|
+
/** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
24867
|
+
allow_exists?: string;
|
|
24868
|
+
/** @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. */
|
|
24869
|
+
dry_run?: boolean;
|
|
24870
|
+
};
|
|
24871
|
+
header?: never;
|
|
24872
|
+
path?: never;
|
|
24873
|
+
cookie?: never;
|
|
24874
|
+
};
|
|
24875
|
+
requestBody?: {
|
|
24876
|
+
content: {
|
|
24877
|
+
"application/json": components["schemas"]["ServiceAccount"];
|
|
24878
|
+
};
|
|
24879
|
+
};
|
|
24880
|
+
responses: {
|
|
24881
|
+
/** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */
|
|
24882
|
+
200: {
|
|
24883
|
+
headers: {
|
|
24884
|
+
[name: string]: unknown;
|
|
24885
|
+
};
|
|
24886
|
+
content: {
|
|
24887
|
+
"application/json": components["schemas"]["ServiceAccount"];
|
|
24888
|
+
};
|
|
24889
|
+
};
|
|
24890
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
24891
|
+
400: {
|
|
24892
|
+
headers: {
|
|
24893
|
+
[name: string]: unknown;
|
|
24894
|
+
};
|
|
24895
|
+
content: {
|
|
24896
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24897
|
+
};
|
|
24898
|
+
};
|
|
24899
|
+
/** @description Unauthorized access. */
|
|
24900
|
+
401: {
|
|
24901
|
+
headers: {
|
|
24902
|
+
[name: string]: unknown;
|
|
24903
|
+
};
|
|
24904
|
+
content: {
|
|
24905
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24906
|
+
};
|
|
24907
|
+
};
|
|
24908
|
+
/** @description Forbidden access. */
|
|
24909
|
+
403: {
|
|
24910
|
+
headers: {
|
|
24911
|
+
[name: string]: unknown;
|
|
24912
|
+
};
|
|
24913
|
+
content: {
|
|
24914
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24915
|
+
};
|
|
24916
|
+
};
|
|
24917
|
+
/** @description ServiceAccount not found. */
|
|
24918
|
+
404: {
|
|
24919
|
+
headers: {
|
|
24920
|
+
[name: string]: unknown;
|
|
24921
|
+
};
|
|
24922
|
+
content: {
|
|
24923
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24924
|
+
};
|
|
24925
|
+
};
|
|
24926
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
24927
|
+
409: {
|
|
24928
|
+
headers: {
|
|
24929
|
+
[name: string]: unknown;
|
|
24930
|
+
};
|
|
24931
|
+
content: {
|
|
24932
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24933
|
+
};
|
|
24934
|
+
};
|
|
24935
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
24936
|
+
500: {
|
|
24937
|
+
headers: {
|
|
24938
|
+
[name: string]: unknown;
|
|
24939
|
+
};
|
|
24940
|
+
content: {
|
|
24941
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24942
|
+
};
|
|
24943
|
+
};
|
|
24944
|
+
/** @description Unexpected error. */
|
|
24945
|
+
default: {
|
|
24946
|
+
headers: {
|
|
24947
|
+
[name: string]: unknown;
|
|
24948
|
+
};
|
|
24949
|
+
content: {
|
|
24950
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24951
|
+
};
|
|
24952
|
+
};
|
|
24953
|
+
};
|
|
24954
|
+
};
|
|
24955
|
+
GetServiceAccount: {
|
|
24956
|
+
parameters: {
|
|
24957
|
+
query?: {
|
|
24958
|
+
/**
|
|
24959
|
+
* @description Include clause for expanding related entities in the response for ServiceAccount.
|
|
24960
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24961
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24962
|
+
*
|
|
24963
|
+
* Supported attributes for ServiceAccount are OrganizationID.
|
|
24964
|
+
*
|
|
24965
|
+
* The whole string must be query-encoded.
|
|
24966
|
+
*/
|
|
24967
|
+
include?: string;
|
|
24968
|
+
/**
|
|
24969
|
+
* @description Select clause for specifying which fields to include in the response for ServiceAccount.
|
|
24970
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
24971
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
24972
|
+
* If not specified, all fields are returned.
|
|
24973
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, ServiceAccountID) and Slug are always returned regardless of the select parameter.
|
|
24974
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
24975
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
24976
|
+
* The whole string must be query-encoded.
|
|
24977
|
+
*/
|
|
24978
|
+
select?: string;
|
|
24979
|
+
};
|
|
24980
|
+
header?: never;
|
|
24981
|
+
path: {
|
|
24982
|
+
/** @description Unique identifier for a service_account_id */
|
|
24983
|
+
service_account_id: string;
|
|
24984
|
+
};
|
|
24985
|
+
cookie?: never;
|
|
24986
|
+
};
|
|
24987
|
+
requestBody?: never;
|
|
24988
|
+
responses: {
|
|
24989
|
+
/** @description OK */
|
|
24990
|
+
200: {
|
|
24991
|
+
headers: {
|
|
24992
|
+
[name: string]: unknown;
|
|
24993
|
+
};
|
|
24994
|
+
content: {
|
|
24995
|
+
"application/json": components["schemas"]["ExtendedServiceAccount"];
|
|
24996
|
+
};
|
|
24997
|
+
};
|
|
24998
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
24999
|
+
400: {
|
|
25000
|
+
headers: {
|
|
25001
|
+
[name: string]: unknown;
|
|
25002
|
+
};
|
|
25003
|
+
content: {
|
|
25004
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25005
|
+
};
|
|
25006
|
+
};
|
|
25007
|
+
/** @description Unauthorized access. */
|
|
25008
|
+
401: {
|
|
25009
|
+
headers: {
|
|
25010
|
+
[name: string]: unknown;
|
|
25011
|
+
};
|
|
25012
|
+
content: {
|
|
25013
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25014
|
+
};
|
|
25015
|
+
};
|
|
25016
|
+
/** @description Forbidden access. */
|
|
25017
|
+
403: {
|
|
25018
|
+
headers: {
|
|
25019
|
+
[name: string]: unknown;
|
|
25020
|
+
};
|
|
25021
|
+
content: {
|
|
25022
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25023
|
+
};
|
|
25024
|
+
};
|
|
25025
|
+
/** @description ServiceAccount not found. */
|
|
25026
|
+
404: {
|
|
25027
|
+
headers: {
|
|
25028
|
+
[name: string]: unknown;
|
|
25029
|
+
};
|
|
25030
|
+
content: {
|
|
25031
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25032
|
+
};
|
|
25033
|
+
};
|
|
25034
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
25035
|
+
500: {
|
|
25036
|
+
headers: {
|
|
25037
|
+
[name: string]: unknown;
|
|
25038
|
+
};
|
|
25039
|
+
content: {
|
|
25040
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25041
|
+
};
|
|
25042
|
+
};
|
|
25043
|
+
/** @description Unexpected error. */
|
|
25044
|
+
default: {
|
|
25045
|
+
headers: {
|
|
25046
|
+
[name: string]: unknown;
|
|
25047
|
+
};
|
|
25048
|
+
content: {
|
|
25049
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25050
|
+
};
|
|
25051
|
+
};
|
|
25052
|
+
};
|
|
25053
|
+
};
|
|
25054
|
+
UpdateServiceAccount: {
|
|
25055
|
+
parameters: {
|
|
25056
|
+
query?: {
|
|
25057
|
+
/** @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. */
|
|
25058
|
+
dry_run?: boolean;
|
|
25059
|
+
};
|
|
25060
|
+
header?: never;
|
|
25061
|
+
path: {
|
|
25062
|
+
/** @description Unique identifier for a service_account_id */
|
|
25063
|
+
service_account_id: string;
|
|
25064
|
+
};
|
|
25065
|
+
cookie?: never;
|
|
25066
|
+
};
|
|
25067
|
+
requestBody?: {
|
|
25068
|
+
content: {
|
|
25069
|
+
"application/json": components["schemas"]["ServiceAccount"];
|
|
25070
|
+
};
|
|
25071
|
+
};
|
|
25072
|
+
responses: {
|
|
25073
|
+
/** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */
|
|
25074
|
+
200: {
|
|
25075
|
+
headers: {
|
|
25076
|
+
[name: string]: unknown;
|
|
25077
|
+
};
|
|
25078
|
+
content: {
|
|
25079
|
+
"application/json": components["schemas"]["ServiceAccount"];
|
|
25080
|
+
};
|
|
25081
|
+
};
|
|
25082
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
25083
|
+
400: {
|
|
25084
|
+
headers: {
|
|
25085
|
+
[name: string]: unknown;
|
|
25086
|
+
};
|
|
25087
|
+
content: {
|
|
25088
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25089
|
+
};
|
|
25090
|
+
};
|
|
25091
|
+
/** @description Unauthorized access. */
|
|
25092
|
+
401: {
|
|
25093
|
+
headers: {
|
|
25094
|
+
[name: string]: unknown;
|
|
25095
|
+
};
|
|
25096
|
+
content: {
|
|
25097
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25098
|
+
};
|
|
25099
|
+
};
|
|
25100
|
+
/** @description Forbidden access. */
|
|
25101
|
+
403: {
|
|
25102
|
+
headers: {
|
|
25103
|
+
[name: string]: unknown;
|
|
25104
|
+
};
|
|
25105
|
+
content: {
|
|
25106
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25107
|
+
};
|
|
25108
|
+
};
|
|
25109
|
+
/** @description ServiceAccount not found. */
|
|
25110
|
+
404: {
|
|
25111
|
+
headers: {
|
|
25112
|
+
[name: string]: unknown;
|
|
25113
|
+
};
|
|
25114
|
+
content: {
|
|
25115
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25116
|
+
};
|
|
25117
|
+
};
|
|
25118
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
25119
|
+
409: {
|
|
25120
|
+
headers: {
|
|
25121
|
+
[name: string]: unknown;
|
|
25122
|
+
};
|
|
25123
|
+
content: {
|
|
25124
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25125
|
+
};
|
|
25126
|
+
};
|
|
25127
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
25128
|
+
500: {
|
|
25129
|
+
headers: {
|
|
25130
|
+
[name: string]: unknown;
|
|
25131
|
+
};
|
|
25132
|
+
content: {
|
|
25133
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25134
|
+
};
|
|
25135
|
+
};
|
|
25136
|
+
/** @description Unexpected error. */
|
|
25137
|
+
default: {
|
|
25138
|
+
headers: {
|
|
25139
|
+
[name: string]: unknown;
|
|
25140
|
+
};
|
|
25141
|
+
content: {
|
|
25142
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25143
|
+
};
|
|
25144
|
+
};
|
|
25145
|
+
};
|
|
25146
|
+
};
|
|
25147
|
+
DeleteServiceAccount: {
|
|
25148
|
+
parameters: {
|
|
25149
|
+
query?: never;
|
|
25150
|
+
header?: never;
|
|
25151
|
+
path: {
|
|
25152
|
+
/** @description Unique identifier for a service_account_id */
|
|
25153
|
+
service_account_id: string;
|
|
25154
|
+
};
|
|
25155
|
+
cookie?: never;
|
|
25156
|
+
};
|
|
25157
|
+
requestBody?: never;
|
|
25158
|
+
responses: {
|
|
25159
|
+
/** @description Response for successful delete operation */
|
|
25160
|
+
200: {
|
|
25161
|
+
headers: {
|
|
25162
|
+
[name: string]: unknown;
|
|
25163
|
+
};
|
|
25164
|
+
content: {
|
|
25165
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
25166
|
+
};
|
|
25167
|
+
};
|
|
25168
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
25169
|
+
400: {
|
|
25170
|
+
headers: {
|
|
25171
|
+
[name: string]: unknown;
|
|
25172
|
+
};
|
|
25173
|
+
content: {
|
|
25174
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25175
|
+
};
|
|
25176
|
+
};
|
|
25177
|
+
/** @description Unauthorized access. */
|
|
25178
|
+
401: {
|
|
25179
|
+
headers: {
|
|
25180
|
+
[name: string]: unknown;
|
|
25181
|
+
};
|
|
25182
|
+
content: {
|
|
25183
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25184
|
+
};
|
|
25185
|
+
};
|
|
25186
|
+
/** @description Forbidden access. */
|
|
25187
|
+
403: {
|
|
25188
|
+
headers: {
|
|
25189
|
+
[name: string]: unknown;
|
|
25190
|
+
};
|
|
25191
|
+
content: {
|
|
25192
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25193
|
+
};
|
|
25194
|
+
};
|
|
25195
|
+
/** @description ServiceAccount not found. */
|
|
25196
|
+
404: {
|
|
25197
|
+
headers: {
|
|
25198
|
+
[name: string]: unknown;
|
|
25199
|
+
};
|
|
25200
|
+
content: {
|
|
25201
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25202
|
+
};
|
|
25203
|
+
};
|
|
25204
|
+
/** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
25205
|
+
409: {
|
|
25206
|
+
headers: {
|
|
25207
|
+
[name: string]: unknown;
|
|
25208
|
+
};
|
|
25209
|
+
content: {
|
|
25210
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25211
|
+
};
|
|
25212
|
+
};
|
|
25213
|
+
/** @description ServiceAccount could not be deleted. */
|
|
25214
|
+
422: {
|
|
25215
|
+
headers: {
|
|
25216
|
+
[name: string]: unknown;
|
|
25217
|
+
};
|
|
25218
|
+
content: {
|
|
25219
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25220
|
+
};
|
|
25221
|
+
};
|
|
25222
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
25223
|
+
500: {
|
|
25224
|
+
headers: {
|
|
25225
|
+
[name: string]: unknown;
|
|
25226
|
+
};
|
|
25227
|
+
content: {
|
|
25228
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25229
|
+
};
|
|
25230
|
+
};
|
|
25231
|
+
/** @description Unexpected error. */
|
|
25232
|
+
default: {
|
|
25233
|
+
headers: {
|
|
25234
|
+
[name: string]: unknown;
|
|
25235
|
+
};
|
|
25236
|
+
content: {
|
|
25237
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25238
|
+
};
|
|
25239
|
+
};
|
|
25240
|
+
};
|
|
25241
|
+
};
|
|
25242
|
+
PatchServiceAccount: {
|
|
25243
|
+
parameters: {
|
|
25244
|
+
query?: {
|
|
25245
|
+
/** @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. */
|
|
25246
|
+
dry_run?: boolean;
|
|
25247
|
+
};
|
|
25248
|
+
header?: never;
|
|
25249
|
+
path: {
|
|
25250
|
+
/** @description Unique identifier for a service_account_id */
|
|
25251
|
+
service_account_id: string;
|
|
25252
|
+
};
|
|
25253
|
+
cookie?: never;
|
|
25254
|
+
};
|
|
25255
|
+
requestBody?: {
|
|
25256
|
+
content: {
|
|
25257
|
+
"application/merge-patch+json": {
|
|
25258
|
+
/** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
25259
|
+
Annotations?: {
|
|
25260
|
+
[key: string]: string | null;
|
|
25261
|
+
} | null;
|
|
25262
|
+
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
25263
|
+
DeleteGates?: {
|
|
25264
|
+
[key: string]: boolean | null;
|
|
25265
|
+
} | null;
|
|
25266
|
+
/** @description Friendly name for the entity. */
|
|
25267
|
+
DisplayName?: string | null;
|
|
25268
|
+
/** @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. */
|
|
25269
|
+
HiddenReason?: string | null;
|
|
25270
|
+
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
25271
|
+
Labels?: {
|
|
25272
|
+
[key: string]: string | null;
|
|
25273
|
+
} | null;
|
|
25274
|
+
OrgRole?: string | null;
|
|
25275
|
+
Permissions?: {
|
|
25276
|
+
[key: string]: Record<string, never> | null;
|
|
25277
|
+
} | null;
|
|
25278
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
25279
|
+
Slug?: string | null;
|
|
25280
|
+
/** @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
25281
|
+
Version?: number | null;
|
|
25282
|
+
};
|
|
25283
|
+
};
|
|
25284
|
+
};
|
|
25285
|
+
responses: {
|
|
25286
|
+
/** @description An identity of the organization that is not a person and does not log in through the identity provider, such as an automation or an agent. Each ServiceAccount is backed by a User, which is what other entities' Permissions and Groups name to grant it access. The ServiceAccount's own Permissions say who may manage it. */
|
|
25287
|
+
200: {
|
|
25288
|
+
headers: {
|
|
25289
|
+
[name: string]: unknown;
|
|
25290
|
+
};
|
|
25291
|
+
content: {
|
|
25292
|
+
"application/json": components["schemas"]["ServiceAccount"];
|
|
25293
|
+
};
|
|
25294
|
+
};
|
|
25295
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
25296
|
+
400: {
|
|
25297
|
+
headers: {
|
|
25298
|
+
[name: string]: unknown;
|
|
25299
|
+
};
|
|
25300
|
+
content: {
|
|
25301
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25302
|
+
};
|
|
25303
|
+
};
|
|
25304
|
+
/** @description Unauthorized access. */
|
|
25305
|
+
401: {
|
|
25306
|
+
headers: {
|
|
25307
|
+
[name: string]: unknown;
|
|
25308
|
+
};
|
|
25309
|
+
content: {
|
|
25310
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25311
|
+
};
|
|
25312
|
+
};
|
|
25313
|
+
/** @description Forbidden access. */
|
|
25314
|
+
403: {
|
|
25315
|
+
headers: {
|
|
25316
|
+
[name: string]: unknown;
|
|
25317
|
+
};
|
|
25318
|
+
content: {
|
|
25319
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25320
|
+
};
|
|
25321
|
+
};
|
|
25322
|
+
/** @description ServiceAccount not found. */
|
|
25323
|
+
404: {
|
|
25324
|
+
headers: {
|
|
25325
|
+
[name: string]: unknown;
|
|
25326
|
+
};
|
|
25327
|
+
content: {
|
|
25328
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25329
|
+
};
|
|
25330
|
+
};
|
|
25331
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
25332
|
+
409: {
|
|
25333
|
+
headers: {
|
|
25334
|
+
[name: string]: unknown;
|
|
25335
|
+
};
|
|
25336
|
+
content: {
|
|
25337
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25338
|
+
};
|
|
25339
|
+
};
|
|
25340
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
25341
|
+
500: {
|
|
25342
|
+
headers: {
|
|
25343
|
+
[name: string]: unknown;
|
|
25344
|
+
};
|
|
25345
|
+
content: {
|
|
25346
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25347
|
+
};
|
|
25348
|
+
};
|
|
25349
|
+
/** @description Unexpected error. */
|
|
25350
|
+
default: {
|
|
25351
|
+
headers: {
|
|
25352
|
+
[name: string]: unknown;
|
|
25353
|
+
};
|
|
25354
|
+
content: {
|
|
25355
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25356
|
+
};
|
|
25357
|
+
};
|
|
25358
|
+
};
|
|
25359
|
+
};
|
|
25360
|
+
ListServiceAccountKeys: {
|
|
25361
|
+
parameters: {
|
|
25362
|
+
query?: never;
|
|
25363
|
+
header?: never;
|
|
25364
|
+
path: {
|
|
25365
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
25366
|
+
service_account_id: string;
|
|
25367
|
+
};
|
|
25368
|
+
cookie?: never;
|
|
25369
|
+
};
|
|
25370
|
+
requestBody?: never;
|
|
25371
|
+
responses: {
|
|
25372
|
+
/** @description OK */
|
|
25373
|
+
200: {
|
|
25374
|
+
headers: {
|
|
25375
|
+
[name: string]: unknown;
|
|
25376
|
+
};
|
|
25377
|
+
content: {
|
|
25378
|
+
"application/json": components["schemas"]["UserKey"][];
|
|
25379
|
+
};
|
|
25380
|
+
};
|
|
25381
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
25382
|
+
400: {
|
|
25383
|
+
headers: {
|
|
25384
|
+
[name: string]: unknown;
|
|
25385
|
+
};
|
|
25386
|
+
content: {
|
|
25387
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25388
|
+
};
|
|
25389
|
+
};
|
|
25390
|
+
/** @description Unauthorized access. */
|
|
25391
|
+
401: {
|
|
25392
|
+
headers: {
|
|
25393
|
+
[name: string]: unknown;
|
|
25394
|
+
};
|
|
25395
|
+
content: {
|
|
25396
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25397
|
+
};
|
|
25398
|
+
};
|
|
25399
|
+
/** @description Forbidden access. */
|
|
25400
|
+
403: {
|
|
25401
|
+
headers: {
|
|
25402
|
+
[name: string]: unknown;
|
|
25403
|
+
};
|
|
25404
|
+
content: {
|
|
25405
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25406
|
+
};
|
|
25407
|
+
};
|
|
25408
|
+
/** @description ServiceAccount not found. */
|
|
23779
25409
|
404: {
|
|
23780
25410
|
headers: {
|
|
23781
25411
|
[name: string]: unknown;
|
|
@@ -23784,7 +25414,7 @@ interface operations {
|
|
|
23784
25414
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
23785
25415
|
};
|
|
23786
25416
|
};
|
|
23787
|
-
/** @description Something went wrong while processing
|
|
25417
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
23788
25418
|
500: {
|
|
23789
25419
|
headers: {
|
|
23790
25420
|
[name: string]: unknown;
|
|
@@ -23804,172 +25434,35 @@ interface operations {
|
|
|
23804
25434
|
};
|
|
23805
25435
|
};
|
|
23806
25436
|
};
|
|
23807
|
-
|
|
25437
|
+
CreateServiceAccountKey: {
|
|
23808
25438
|
parameters: {
|
|
23809
25439
|
query?: {
|
|
23810
|
-
/**
|
|
23811
|
-
|
|
23812
|
-
* the list of Revisions returned. The expression syntax was inspired by SQL.
|
|
23813
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
23814
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
23815
|
-
* as in the JSON encoding.
|
|
23816
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
23817
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
23818
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
23819
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
23820
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
23821
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
23822
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
23823
|
-
* UUID and time literals must be quoted as string literals.
|
|
23824
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
23825
|
-
* Time literals use the same form as when serialized as JSON,
|
|
23826
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
23827
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
23828
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
23829
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
23830
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
23831
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
23832
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
23833
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
23834
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
23835
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
23836
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
23837
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
23838
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
23839
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
23840
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
23841
|
-
* Conjunctions are supported using the `AND` operator.
|
|
23842
|
-
* An example conjunction is:
|
|
23843
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
23844
|
-
*
|
|
23845
|
-
* Supported attributes for filtering on Revision: ApplyGates, ApplyWarnings, Attestations, ChangeOrders, ChangeSetID, Conflicts, CreatedAt, DataHash, Description, HiddenReason, NeededPaths, OrganizationID, ProvidedPaths, Releases, RevisionID, RevisionNum, Source, SpaceID, Tags, UnitID, UpdatedAt, UserAgent, UserID, ValidationErrors, ValidationPassed, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
23846
|
-
*
|
|
23847
|
-
* To list tagged Revisions use `Tags ? '<tag-id>'`.
|
|
23848
|
-
*
|
|
23849
|
-
* The whole string must be query-encoded.
|
|
23850
|
-
*/
|
|
23851
|
-
where?: string;
|
|
23852
|
-
/**
|
|
23853
|
-
* @description UUID of a Filter entity to apply to the Revision list.
|
|
23854
|
-
*
|
|
23855
|
-
* The Filter must be in the same Organization as the user credentials.
|
|
23856
|
-
*
|
|
23857
|
-
* The Filter's From field must match the entity type being filtered (Revision).
|
|
23858
|
-
*
|
|
23859
|
-
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
23860
|
-
*
|
|
23861
|
-
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
23862
|
-
*
|
|
23863
|
-
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
23864
|
-
*/
|
|
23865
|
-
filter?: string;
|
|
23866
|
-
/**
|
|
23867
|
-
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
23868
|
-
*
|
|
23869
|
-
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
23870
|
-
*
|
|
23871
|
-
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
23872
|
-
*
|
|
23873
|
-
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
23874
|
-
*
|
|
23875
|
-
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
23876
|
-
*
|
|
23877
|
-
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
23878
|
-
*
|
|
23879
|
-
* Searchable fields for Revision include string and map-type attributes from the queryable attributes list.
|
|
23880
|
-
*
|
|
23881
|
-
* The whole string must be query-encoded.
|
|
23882
|
-
*/
|
|
23883
|
-
contains?: string;
|
|
23884
|
-
/**
|
|
23885
|
-
* @description Include clause for expanding related entities in the response for Revision.
|
|
23886
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
23887
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
23888
|
-
*
|
|
23889
|
-
* Supported attributes for Revision are Attestations, ChangeOrders, ChangeSetID, OrganizationID, Releases, SpaceID, Tags, UnitID, UserID.
|
|
23890
|
-
*
|
|
23891
|
-
* The whole string must be query-encoded.
|
|
23892
|
-
*/
|
|
23893
|
-
include?: string;
|
|
23894
|
-
/**
|
|
23895
|
-
* @description Select clause for specifying which fields to include in the response for Revision.
|
|
23896
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
23897
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
23898
|
-
* If not specified, all fields are returned.
|
|
23899
|
-
* Entity and parent IDs (like OrganizationID, SpaceID, RevisionID) and Slug are always returned regardless of the select parameter.
|
|
23900
|
-
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
23901
|
-
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
23902
|
-
* The whole string must be query-encoded.
|
|
23903
|
-
*/
|
|
23904
|
-
select?: string;
|
|
23905
|
-
/**
|
|
23906
|
-
* @description Hidden Revision entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
23907
|
-
*
|
|
23908
|
-
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
23909
|
-
*
|
|
23910
|
-
* 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.
|
|
23911
|
-
*
|
|
23912
|
-
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
23913
|
-
*/
|
|
23914
|
-
include_hidden?: string;
|
|
23915
|
-
/** @description Maximum number of Revision 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. */
|
|
23916
|
-
limit?: number;
|
|
23917
|
-
/**
|
|
23918
|
-
* @description Comma-separated list of fields to sort Revision results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
23919
|
-
*
|
|
23920
|
-
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
23921
|
-
*
|
|
23922
|
-
* Supported attributes for ordering Revision: ChangeSetID, CreatedAt, DataHash, Description, HiddenReason, OrganizationID, RevisionID, RevisionNum, Source, UnitID, UpdatedAt, UserAgent, UserID.
|
|
23923
|
-
*
|
|
23924
|
-
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
23925
|
-
*
|
|
23926
|
-
* Results are ordered by the Revision's ID after the fields named, and by the ID alone if none are.
|
|
23927
|
-
*
|
|
23928
|
-
* The whole string must be query-encoded.
|
|
23929
|
-
*/
|
|
23930
|
-
order_by?: string;
|
|
23931
|
-
/**
|
|
23932
|
-
* @description The token from the ConfigHub-Continue header of the previous page, to return the Revision entities after it.
|
|
23933
|
-
*
|
|
23934
|
-
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
23935
|
-
*
|
|
23936
|
-
* 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.
|
|
23937
|
-
*/
|
|
23938
|
-
continue?: string;
|
|
23939
|
-
/**
|
|
23940
|
-
* @deprecated
|
|
23941
|
-
* @description Deprecated: use continue. Number of Revision entities to skip before returning results. Cannot be combined with continue.
|
|
23942
|
-
*/
|
|
23943
|
-
offset?: number;
|
|
23944
|
-
/**
|
|
23945
|
-
* @description Entity to return at most one Revision per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
|
|
23946
|
-
*
|
|
23947
|
-
* Supported values: Unit, Off.
|
|
23948
|
-
*
|
|
23949
|
-
* If not specified, results are restricted to at most one row per Unit.
|
|
23950
|
-
*
|
|
23951
|
-
* Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
|
|
23952
|
-
*/
|
|
23953
|
-
distinct_on?: PathsRevision_mutation_sourcesGetParametersQueryDistinct_on;
|
|
25440
|
+
/** @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. */
|
|
25441
|
+
dry_run?: boolean;
|
|
23954
25442
|
};
|
|
23955
25443
|
header?: never;
|
|
23956
|
-
path
|
|
25444
|
+
path: {
|
|
25445
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
25446
|
+
service_account_id: string;
|
|
25447
|
+
};
|
|
23957
25448
|
cookie?: never;
|
|
23958
25449
|
};
|
|
23959
|
-
requestBody?:
|
|
25450
|
+
requestBody?: {
|
|
25451
|
+
content: {
|
|
25452
|
+
"application/json": components["schemas"]["CreateUserKeyRequest"];
|
|
25453
|
+
};
|
|
25454
|
+
};
|
|
23960
25455
|
responses: {
|
|
23961
25456
|
/** @description OK */
|
|
23962
25457
|
200: {
|
|
23963
25458
|
headers: {
|
|
23964
|
-
/** @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. */
|
|
23965
|
-
"ConfigHub-Continue"?: string;
|
|
23966
25459
|
[name: string]: unknown;
|
|
23967
25460
|
};
|
|
23968
25461
|
content: {
|
|
23969
|
-
"application/json": components["schemas"]["
|
|
25462
|
+
"application/json": components["schemas"]["UserKey"];
|
|
23970
25463
|
};
|
|
23971
25464
|
};
|
|
23972
|
-
/** @description
|
|
25465
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
23973
25466
|
400: {
|
|
23974
25467
|
headers: {
|
|
23975
25468
|
[name: string]: unknown;
|
|
@@ -23996,7 +25489,7 @@ interface operations {
|
|
|
23996
25489
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
23997
25490
|
};
|
|
23998
25491
|
};
|
|
23999
|
-
/** @description
|
|
25492
|
+
/** @description ServiceAccount not found. */
|
|
24000
25493
|
404: {
|
|
24001
25494
|
headers: {
|
|
24002
25495
|
[name: string]: unknown;
|
|
@@ -24005,7 +25498,113 @@ interface operations {
|
|
|
24005
25498
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
24006
25499
|
};
|
|
24007
25500
|
};
|
|
24008
|
-
/** @description
|
|
25501
|
+
/** @description ServiceAccount data conflict. Data has changed since last read. */
|
|
25502
|
+
409: {
|
|
25503
|
+
headers: {
|
|
25504
|
+
[name: string]: unknown;
|
|
25505
|
+
};
|
|
25506
|
+
content: {
|
|
25507
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25508
|
+
};
|
|
25509
|
+
};
|
|
25510
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
25511
|
+
500: {
|
|
25512
|
+
headers: {
|
|
25513
|
+
[name: string]: unknown;
|
|
25514
|
+
};
|
|
25515
|
+
content: {
|
|
25516
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25517
|
+
};
|
|
25518
|
+
};
|
|
25519
|
+
/** @description Unexpected error. */
|
|
25520
|
+
default: {
|
|
25521
|
+
headers: {
|
|
25522
|
+
[name: string]: unknown;
|
|
25523
|
+
};
|
|
25524
|
+
content: {
|
|
25525
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25526
|
+
};
|
|
25527
|
+
};
|
|
25528
|
+
};
|
|
25529
|
+
};
|
|
25530
|
+
DeleteServiceAccountKey: {
|
|
25531
|
+
parameters: {
|
|
25532
|
+
query?: never;
|
|
25533
|
+
header?: never;
|
|
25534
|
+
path: {
|
|
25535
|
+
/** @description UUID of the service account whose keys are being managed. */
|
|
25536
|
+
service_account_id: string;
|
|
25537
|
+
/** @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. */
|
|
25538
|
+
kid: string;
|
|
25539
|
+
};
|
|
25540
|
+
cookie?: never;
|
|
25541
|
+
};
|
|
25542
|
+
requestBody?: never;
|
|
25543
|
+
responses: {
|
|
25544
|
+
/** @description Response for successful delete operation */
|
|
25545
|
+
200: {
|
|
25546
|
+
headers: {
|
|
25547
|
+
[name: string]: unknown;
|
|
25548
|
+
};
|
|
25549
|
+
content: {
|
|
25550
|
+
"application/json": components["schemas"]["DeleteResponse"];
|
|
25551
|
+
};
|
|
25552
|
+
};
|
|
25553
|
+
/** @description ServiceAccount request is invalid (Bad Request). */
|
|
25554
|
+
400: {
|
|
25555
|
+
headers: {
|
|
25556
|
+
[name: string]: unknown;
|
|
25557
|
+
};
|
|
25558
|
+
content: {
|
|
25559
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25560
|
+
};
|
|
25561
|
+
};
|
|
25562
|
+
/** @description Unauthorized access. */
|
|
25563
|
+
401: {
|
|
25564
|
+
headers: {
|
|
25565
|
+
[name: string]: unknown;
|
|
25566
|
+
};
|
|
25567
|
+
content: {
|
|
25568
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25569
|
+
};
|
|
25570
|
+
};
|
|
25571
|
+
/** @description Forbidden access. */
|
|
25572
|
+
403: {
|
|
25573
|
+
headers: {
|
|
25574
|
+
[name: string]: unknown;
|
|
25575
|
+
};
|
|
25576
|
+
content: {
|
|
25577
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25578
|
+
};
|
|
25579
|
+
};
|
|
25580
|
+
/** @description ServiceAccount not found. */
|
|
25581
|
+
404: {
|
|
25582
|
+
headers: {
|
|
25583
|
+
[name: string]: unknown;
|
|
25584
|
+
};
|
|
25585
|
+
content: {
|
|
25586
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25587
|
+
};
|
|
25588
|
+
};
|
|
25589
|
+
/** @description ServiceAccount is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
25590
|
+
409: {
|
|
25591
|
+
headers: {
|
|
25592
|
+
[name: string]: unknown;
|
|
25593
|
+
};
|
|
25594
|
+
content: {
|
|
25595
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25596
|
+
};
|
|
25597
|
+
};
|
|
25598
|
+
/** @description ServiceAccount could not be deleted. */
|
|
25599
|
+
422: {
|
|
25600
|
+
headers: {
|
|
25601
|
+
[name: string]: unknown;
|
|
25602
|
+
};
|
|
25603
|
+
content: {
|
|
25604
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
25605
|
+
};
|
|
25606
|
+
};
|
|
25607
|
+
/** @description Something went wrong while processing ServiceAccount. */
|
|
24009
25608
|
500: {
|
|
24010
25609
|
headers: {
|
|
24011
25610
|
[name: string]: unknown;
|
|
@@ -47271,7 +48870,10 @@ interface operations {
|
|
|
47271
48870
|
Upload: {
|
|
47272
48871
|
parameters: {
|
|
47273
48872
|
query?: {
|
|
47274
|
-
/**
|
|
48873
|
+
/**
|
|
48874
|
+
* @deprecated
|
|
48875
|
+
* @description Deprecated: use DryRun in the request body. Plan the upload and return the same response without writing anything. Either one asks for a dry run.
|
|
48876
|
+
*/
|
|
47275
48877
|
dry_run?: boolean;
|
|
47276
48878
|
/** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. */
|
|
47277
48879
|
include?: string;
|