@confighub/api 0.7.0 → 0.8.1
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 +910 -271
- package/dist/index.d.ts +910 -271
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -590,6 +590,70 @@ interface paths {
|
|
|
590
590
|
patch?: never;
|
|
591
591
|
trace?: never;
|
|
592
592
|
};
|
|
593
|
+
"/group": {
|
|
594
|
+
parameters: {
|
|
595
|
+
query?: never;
|
|
596
|
+
header?: never;
|
|
597
|
+
path?: never;
|
|
598
|
+
cookie?: never;
|
|
599
|
+
};
|
|
600
|
+
/**
|
|
601
|
+
* List Groups
|
|
602
|
+
* @description List Groups
|
|
603
|
+
*/
|
|
604
|
+
get: operations["ListGroups"];
|
|
605
|
+
put?: never;
|
|
606
|
+
post?: never;
|
|
607
|
+
delete?: never;
|
|
608
|
+
options?: never;
|
|
609
|
+
head?: never;
|
|
610
|
+
patch?: never;
|
|
611
|
+
trace?: never;
|
|
612
|
+
};
|
|
613
|
+
"/group/{group_id}": {
|
|
614
|
+
parameters: {
|
|
615
|
+
query?: never;
|
|
616
|
+
header?: never;
|
|
617
|
+
path?: never;
|
|
618
|
+
cookie?: never;
|
|
619
|
+
};
|
|
620
|
+
/**
|
|
621
|
+
* Get Group
|
|
622
|
+
* @description Get Group
|
|
623
|
+
*/
|
|
624
|
+
get: operations["GetGroup"];
|
|
625
|
+
put?: never;
|
|
626
|
+
post?: never;
|
|
627
|
+
delete?: never;
|
|
628
|
+
options?: never;
|
|
629
|
+
head?: never;
|
|
630
|
+
patch?: never;
|
|
631
|
+
trace?: never;
|
|
632
|
+
};
|
|
633
|
+
"/group/{group_id}/user/{user_id}": {
|
|
634
|
+
parameters: {
|
|
635
|
+
query?: never;
|
|
636
|
+
header?: never;
|
|
637
|
+
path?: never;
|
|
638
|
+
cookie?: never;
|
|
639
|
+
};
|
|
640
|
+
get?: never;
|
|
641
|
+
put?: never;
|
|
642
|
+
/**
|
|
643
|
+
* 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.
|
|
645
|
+
*/
|
|
646
|
+
post: operations["AddGroupBotUser"];
|
|
647
|
+
/**
|
|
648
|
+
* 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.
|
|
650
|
+
*/
|
|
651
|
+
delete: operations["RemoveGroupBotUser"];
|
|
652
|
+
options?: never;
|
|
653
|
+
head?: never;
|
|
654
|
+
patch?: never;
|
|
655
|
+
trace?: never;
|
|
656
|
+
};
|
|
593
657
|
"/info": {
|
|
594
658
|
parameters: {
|
|
595
659
|
query?: never;
|
|
@@ -3555,10 +3619,10 @@ interface components {
|
|
|
3555
3619
|
Binding: {
|
|
3556
3620
|
/** @description Shared attribute name that matched the need to the provide */
|
|
3557
3621
|
AttributeName?: string;
|
|
3558
|
-
/** @description Whether this binding should be automatically updated when the provided value changes; if false, the binding is manual and will not be modified by automatic resolution */
|
|
3559
|
-
AutoUpdate?: boolean;
|
|
3560
3622
|
/** @description DataType of the bound value */
|
|
3561
3623
|
DataType?: string;
|
|
3624
|
+
/** @description Identifies a binding within its Link's ManualBindings, so that a merge of two versions of the Link matches bindings by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */
|
|
3625
|
+
Key?: string;
|
|
3562
3626
|
/** @description Resolved path within the needed resource */
|
|
3563
3627
|
NeededPath?: string;
|
|
3564
3628
|
NeededResource?: components["schemas"]["ResourceInfo"];
|
|
@@ -3595,7 +3659,7 @@ interface components {
|
|
|
3595
3659
|
*/
|
|
3596
3660
|
readonly ClaimToken?: string;
|
|
3597
3661
|
/** @description Condition represents the worker's readiness state (Ready, NotReady, Unresponsive, Disconnected). */
|
|
3598
|
-
Condition?: string;
|
|
3662
|
+
readonly Condition?: string;
|
|
3599
3663
|
/**
|
|
3600
3664
|
* Format: date-time
|
|
3601
3665
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -3742,7 +3806,8 @@ interface components {
|
|
|
3742
3806
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3743
3807
|
*/
|
|
3744
3808
|
ChangeOrderID?: string;
|
|
3745
|
-
ChangeWorkflow
|
|
3809
|
+
/** @description ChangeWorkflow governs how this ChangeOrder is promoted: the ordered stages it moves through and the gates that have to pass before it enters one. It is a copy taken when the workflow was associated, not a reference, so editing the ChangeWorkflow afterwards cannot change the rules a rollout already started under. Empty is a ChangeOrder no workflow governs, which is promoted ungated. */
|
|
3810
|
+
readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
|
|
3746
3811
|
/**
|
|
3747
3812
|
* Format: uuid
|
|
3748
3813
|
* @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key.
|
|
@@ -3796,8 +3861,12 @@ interface components {
|
|
|
3796
3861
|
[key: string]: unknown;
|
|
3797
3862
|
};
|
|
3798
3863
|
Permissions?: components["schemas"]["Permissions"];
|
|
3864
|
+
/** @description PromotionFailures records each promotion that did not complete: who ran it, when, into which Stage, and each Space it failed or was blocked in, with the Space's error or reason and the error of each Unit and Link whose write failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
3799
3865
|
readonly PromotionFailures?: components["schemas"]["ChangeOrderPromotionFailure"][];
|
|
3866
|
+
/** @description PromotionOverrides records each promotion forced into a Stage whose gates did not hold: who forced it, when, into which Stage and Spaces, why, and which gates failed. The most recent entries are kept. Set by the server. (readonly) */
|
|
3800
3867
|
readonly PromotionOverrides?: components["schemas"]["ChangeOrderPromotionOverride"][];
|
|
3868
|
+
/** @description Promotions records each promotion that wrote the change into Spaces: who ran it, when, into which Stage, and which Spaces. A promotion entering several Stages records one entry per Stage. The most recent entries are kept. Set by the server. (readonly) */
|
|
3869
|
+
readonly Promotions?: components["schemas"]["ChangeOrderPromotion"][];
|
|
3801
3870
|
/** @description ReleasedRestoredSpaceIDs is where the undoing has been released: the Spaces in RestoredSpaceIDs whose Units are released at or past the Revision the restore Tag marks. Covering ReleasedSpaceIDs is what State reports as RestoreReleased. Derived when the ChangeOrder is read. */
|
|
3802
3871
|
readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
|
|
3803
3872
|
/** @description ReleasedSpaceIDs is where the ChangeOrder has been released: the Spaces in scope whose Units in the Space's release are applied at or past the Revision the end Tag marks. Derived when the ChangeOrder is read. */
|
|
@@ -3901,13 +3970,27 @@ interface components {
|
|
|
3901
3970
|
* The whole string must be query-encoded.
|
|
3902
3971
|
*/
|
|
3903
3972
|
WhereSpace?: string;
|
|
3904
|
-
/** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
|
|
3973
|
+
/** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'`. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
|
|
3905
3974
|
WhereUnit?: string;
|
|
3906
3975
|
};
|
|
3907
3976
|
ChangeOrderCreateOrUpdateResponse: {
|
|
3908
3977
|
ChangeOrder?: components["schemas"]["ChangeOrder"];
|
|
3909
3978
|
Error?: components["schemas"]["ResponseError"];
|
|
3910
3979
|
};
|
|
3980
|
+
ChangeOrderPromotion: {
|
|
3981
|
+
/**
|
|
3982
|
+
* Format: date-time
|
|
3983
|
+
* @example 2006-01-02T15:04:05Z07:00
|
|
3984
|
+
*/
|
|
3985
|
+
PromotedAt?: string;
|
|
3986
|
+
SpaceIDs?: components["schemas"]["UUID"][];
|
|
3987
|
+
Stage?: string;
|
|
3988
|
+
/**
|
|
3989
|
+
* Format: uuid
|
|
3990
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3991
|
+
*/
|
|
3992
|
+
UserID?: string;
|
|
3993
|
+
};
|
|
3911
3994
|
ChangeOrderPromotionFailure: {
|
|
3912
3995
|
/**
|
|
3913
3996
|
* Format: date-time
|
|
@@ -3915,16 +3998,26 @@ interface components {
|
|
|
3915
3998
|
*/
|
|
3916
3999
|
FailedAt?: string;
|
|
3917
4000
|
Spaces?: components["schemas"]["ChangeOrderPromotionFailureSpace"][];
|
|
3918
|
-
|
|
4001
|
+
Stage?: string;
|
|
3919
4002
|
/**
|
|
3920
4003
|
* Format: uuid
|
|
3921
4004
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
3922
4005
|
*/
|
|
3923
4006
|
UserID?: string;
|
|
3924
4007
|
};
|
|
4008
|
+
ChangeOrderPromotionFailureLink: {
|
|
4009
|
+
Error?: string;
|
|
4010
|
+
/**
|
|
4011
|
+
* Format: uuid
|
|
4012
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
4013
|
+
*/
|
|
4014
|
+
LinkID?: string;
|
|
4015
|
+
Slug?: string;
|
|
4016
|
+
};
|
|
3925
4017
|
ChangeOrderPromotionFailureSpace: {
|
|
3926
4018
|
Action?: string;
|
|
3927
4019
|
Error?: string;
|
|
4020
|
+
Links?: components["schemas"]["ChangeOrderPromotionFailureLink"][];
|
|
3928
4021
|
Reason?: string;
|
|
3929
4022
|
/**
|
|
3930
4023
|
* Format: uuid
|
|
@@ -3952,6 +4045,7 @@ interface components {
|
|
|
3952
4045
|
*/
|
|
3953
4046
|
OverriddenAt?: string;
|
|
3954
4047
|
Reason?: string;
|
|
4048
|
+
SpaceIDs?: components["schemas"]["UUID"][];
|
|
3955
4049
|
Stage?: string;
|
|
3956
4050
|
/**
|
|
3957
4051
|
* Format: uuid
|
|
@@ -4188,10 +4282,15 @@ interface components {
|
|
|
4188
4282
|
};
|
|
4189
4283
|
Column: {
|
|
4190
4284
|
ColumnSource?: components["schemas"]["ColumnSource"];
|
|
4285
|
+
/** @description The kind of value: MetadataAttribute, MetadataExpression, DataPath or DataExpression. */
|
|
4191
4286
|
ColumnType?: string;
|
|
4287
|
+
/** @description The expected data type of the column value: string, int, bool, uuid or time. */
|
|
4192
4288
|
DataType?: string;
|
|
4289
|
+
/** @description Group by this column. Priority is in column list order, after the View's GroupBy. */
|
|
4193
4290
|
GroupBy?: boolean;
|
|
4291
|
+
/** @description The display name for the column. */
|
|
4194
4292
|
Name: string;
|
|
4293
|
+
/** @description Sort by this column, ASC or DESC. Priority is in column list order, after the View's OrderBy. */
|
|
4195
4294
|
OrderByDirection?: string;
|
|
4196
4295
|
};
|
|
4197
4296
|
ColumnSource: {
|
|
@@ -4515,6 +4614,11 @@ interface components {
|
|
|
4515
4614
|
Organization?: components["schemas"]["Organization"];
|
|
4516
4615
|
Space?: components["schemas"]["Space"];
|
|
4517
4616
|
};
|
|
4617
|
+
/** @description Group with additional related entities expanded based on the request's include parameter. */
|
|
4618
|
+
ExtendedGroup: {
|
|
4619
|
+
Error?: components["schemas"]["ResponseError"];
|
|
4620
|
+
Group?: components["schemas"]["Group"];
|
|
4621
|
+
};
|
|
4518
4622
|
ExtendedInvocation: {
|
|
4519
4623
|
BridgeWorker?: components["schemas"]["BridgeWorker"];
|
|
4520
4624
|
Error?: components["schemas"]["ResponseError"];
|
|
@@ -4544,6 +4648,14 @@ interface components {
|
|
|
4544
4648
|
Trigger?: components["schemas"]["Trigger"];
|
|
4545
4649
|
Unit?: components["schemas"]["Unit"];
|
|
4546
4650
|
};
|
|
4651
|
+
ExtendedOrganization: {
|
|
4652
|
+
Error?: components["schemas"]["ResponseError"];
|
|
4653
|
+
Organization?: components["schemas"]["Organization"];
|
|
4654
|
+
};
|
|
4655
|
+
ExtendedOrganizationMember: {
|
|
4656
|
+
Error?: components["schemas"]["ResponseError"];
|
|
4657
|
+
OrganizationMember?: components["schemas"]["OrganizationMember"];
|
|
4658
|
+
};
|
|
4547
4659
|
/** @description Release with additional related entities expanded based on the request's include parameter. */
|
|
4548
4660
|
ExtendedRelease: {
|
|
4549
4661
|
Organization?: components["schemas"]["Organization"];
|
|
@@ -4671,6 +4783,10 @@ interface components {
|
|
|
4671
4783
|
View?: components["schemas"]["View"];
|
|
4672
4784
|
ViewColumns?: components["schemas"]["ViewColumn"][];
|
|
4673
4785
|
};
|
|
4786
|
+
ExtendedUser: {
|
|
4787
|
+
Error?: components["schemas"]["ResponseError"];
|
|
4788
|
+
User?: components["schemas"]["User"];
|
|
4789
|
+
};
|
|
4674
4790
|
ExtendedView: {
|
|
4675
4791
|
Error?: components["schemas"]["ResponseError"];
|
|
4676
4792
|
Filter?: components["schemas"]["Filter"];
|
|
@@ -4951,6 +5067,42 @@ interface components {
|
|
|
4951
5067
|
/** @description Supported ToolchainTypes */
|
|
4952
5068
|
ToolchainTypes?: string[] | null;
|
|
4953
5069
|
};
|
|
5070
|
+
/** @description A Group of Users, a subject in an entity's Permissions. Groups and their membership are managed in the identity provider, and like Users are not scoped to an Organization; a Group is provisioned when a User in it logs in. Bot Users are the exception: they are added to a Group through the API. */
|
|
5071
|
+
Group: {
|
|
5072
|
+
/**
|
|
5073
|
+
* Format: date-time
|
|
5074
|
+
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
5075
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5076
|
+
*/
|
|
5077
|
+
readonly CreatedAt?: string;
|
|
5078
|
+
/** @description Friendly name for the entity. */
|
|
5079
|
+
DisplayName?: string;
|
|
5080
|
+
/** @description The type of entity. */
|
|
5081
|
+
readonly EntityType?: string;
|
|
5082
|
+
/** @description Unique identifier for the External Identity Provider record matching this Group. */
|
|
5083
|
+
readonly ExternalID?: string;
|
|
5084
|
+
/**
|
|
5085
|
+
* Format: uuid
|
|
5086
|
+
* @description Unique identifier for a Group. (readonly)
|
|
5087
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5088
|
+
*/
|
|
5089
|
+
GroupID?: string;
|
|
5090
|
+
/** @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. */
|
|
5091
|
+
HiddenReason?: string;
|
|
5092
|
+
/** @description Unique URL-safe identifier for the entity. */
|
|
5093
|
+
Slug: string;
|
|
5094
|
+
/**
|
|
5095
|
+
* Format: date-time
|
|
5096
|
+
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
5097
|
+
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5098
|
+
*/
|
|
5099
|
+
readonly UpdatedAt?: string;
|
|
5100
|
+
/**
|
|
5101
|
+
* Format: int64
|
|
5102
|
+
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
5103
|
+
*/
|
|
5104
|
+
Version?: number;
|
|
5105
|
+
};
|
|
4954
5106
|
GuardDelta: {
|
|
4955
5107
|
/** @description The path whose guards changed; empty for the resource as a whole */
|
|
4956
5108
|
Path?: string;
|
|
@@ -5079,7 +5231,8 @@ interface components {
|
|
|
5079
5231
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5080
5232
|
*/
|
|
5081
5233
|
readonly BackingUnitID?: string;
|
|
5082
|
-
|
|
5234
|
+
/** @description The needs/provides attribute bindings resolution found for this Link and keeps up to date: one for each needed attribute of the downstream Unit it matched with an attribute the upstream Unit provides. Set by the server, and rebuilt by each resolve. A needed attribute that a binding in ManualBindings names is not matched again. */
|
|
5235
|
+
readonly Bindings?: components["schemas"]["BindingList"];
|
|
5083
5236
|
Clearance?: components["schemas"]["Clearance"];
|
|
5084
5237
|
/**
|
|
5085
5238
|
* Format: date-time
|
|
@@ -5125,6 +5278,7 @@ interface components {
|
|
|
5125
5278
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
5126
5279
|
*/
|
|
5127
5280
|
LinkID?: string;
|
|
5281
|
+
ManualBindings?: components["schemas"]["BindingList"];
|
|
5128
5282
|
/** @description Enables the subtraction (override-preservation) step of the merge performed when resolving this Link. When false (the default), the source patch is applied without subtraction and the downstream Unit's local differences are preserved by the stored Mutation Protected values alone, widened by WhereMutation if it is set. When true, the merge additionally subtracts the downstream Unit's local differences from the source patch and the stored values are not consulted. Only meaningful for UpgradeUnit and MergeUnits Links. */
|
|
5129
5283
|
MergeEnableSubtraction?: boolean;
|
|
5130
5284
|
/**
|
|
@@ -5508,6 +5662,8 @@ interface components {
|
|
|
5508
5662
|
};
|
|
5509
5663
|
ParameterizedFunction: {
|
|
5510
5664
|
FunctionInvocation?: components["schemas"]["FunctionInvocation"];
|
|
5665
|
+
/** @description Identifies the entry within DownstreamSetters, so that a merge of two versions of the Link matches entries by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */
|
|
5666
|
+
Key?: string;
|
|
5511
5667
|
/** @description Names of upstream values whose values are exposed to string-argument template expansion. Each entry must match a Name in UpstreamPaths or UpstreamGetters. */
|
|
5512
5668
|
Parameters?: string[];
|
|
5513
5669
|
};
|
|
@@ -5551,6 +5707,8 @@ interface components {
|
|
|
5551
5707
|
Evaluator?: string;
|
|
5552
5708
|
/** @description Go template or CEL expression that evaluates to the value to write. Parameters and FunctionContext fields are in scope. */
|
|
5553
5709
|
Expression?: string;
|
|
5710
|
+
/** @description Identifies the entry within DownstreamPaths, so that a merge of two versions of the Link matches entries by Key rather than by position. Optional, and unique within the list when present. Letters, digits, '-' and '_', starting with a letter or digit; at most 128 characters. */
|
|
5711
|
+
Key?: string;
|
|
5554
5712
|
/** @description Names of upstream values referenced by Expression. Each entry must be a legal identifier and must match a Name in UpstreamPaths or UpstreamGetters. */
|
|
5555
5713
|
Parameters?: string[];
|
|
5556
5714
|
/** @description Unresolved path within Resource to write via set-attributes */
|
|
@@ -5925,6 +6083,12 @@ interface components {
|
|
|
5925
6083
|
* @example 2025-04-04T11:50:02.95102-07:00
|
|
5926
6084
|
*/
|
|
5927
6085
|
readonly UpdatedAt?: string;
|
|
6086
|
+
/**
|
|
6087
|
+
* Format: uuid
|
|
6088
|
+
* @description The User who published the Release. Absent for Releases published before it was recorded. (readonly)
|
|
6089
|
+
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6090
|
+
*/
|
|
6091
|
+
readonly UserID?: string;
|
|
5928
6092
|
/**
|
|
5929
6093
|
* Format: int64
|
|
5930
6094
|
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
@@ -6575,6 +6739,9 @@ interface components {
|
|
|
6575
6739
|
Message?: string;
|
|
6576
6740
|
};
|
|
6577
6741
|
Subjects: {
|
|
6742
|
+
GroupIDs?: {
|
|
6743
|
+
[key: string]: boolean;
|
|
6744
|
+
};
|
|
6578
6745
|
UserIDs?: {
|
|
6579
6746
|
[key: string]: boolean;
|
|
6580
6747
|
};
|
|
@@ -6861,10 +7028,6 @@ interface components {
|
|
|
6861
7028
|
OrganizationID?: string;
|
|
6862
7029
|
/** @description Specifies the source of additional configuration data to pass to functions that need it (e.g., vet-immutable needs a baseline revision to compare against). Uses revision specifier format such as LastReleasedRevisionNum or Before:HeadRevisionNum. */
|
|
6863
7030
|
OtherDataSource?: string;
|
|
6864
|
-
/** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
6865
|
-
Params?: {
|
|
6866
|
-
[key: string]: unknown;
|
|
6867
|
-
};
|
|
6868
7031
|
Permissions?: components["schemas"]["Permissions"];
|
|
6869
7032
|
/**
|
|
6870
7033
|
* @description Protect indicates whether the paths this trigger's function writes are recorded as protected local overrides, so a later merge from upstream does not overwrite them. A change claims nothing by default and so does a trigger; set this for a trigger that decides a value on the Unit's behalf and will not be back to decide it again, such as a PostClone trigger customizing a variant. Only meaningful for a mutating trigger.
|
|
@@ -6930,7 +7093,7 @@ interface components {
|
|
|
6930
7093
|
Warn?: boolean;
|
|
6931
7094
|
/** @description Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions. */
|
|
6932
7095
|
WhereResource?: string;
|
|
6933
|
-
/** @description A filter expression to restrict which Units this Trigger applies to. */
|
|
7096
|
+
/** @description A filter expression to restrict which Units this Trigger applies to. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'` and `UpstreamUnit.Slug = 'base'`. */
|
|
6934
7097
|
WhereUnit?: string;
|
|
6935
7098
|
};
|
|
6936
7099
|
TriggerCreateOrUpdateResponse: {
|
|
@@ -6968,7 +7131,7 @@ interface components {
|
|
|
6968
7131
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
6969
7132
|
*/
|
|
6970
7133
|
ChangeSetID?: string;
|
|
6971
|
-
Conflicts?: components["schemas"]["MutationConflictList"];
|
|
7134
|
+
readonly Conflicts?: components["schemas"]["MutationConflictList"];
|
|
6972
7135
|
/**
|
|
6973
7136
|
* Format: date-time
|
|
6974
7137
|
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
@@ -7043,7 +7206,8 @@ interface components {
|
|
|
7043
7206
|
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
7044
7207
|
*/
|
|
7045
7208
|
OrganizationID?: string;
|
|
7046
|
-
|
|
7209
|
+
/** @description Annotations on locations within the Unit's configuration data, by resource and path. */
|
|
7210
|
+
readonly PathAnnotations?: components["schemas"]["PathAnnotationList"];
|
|
7047
7211
|
Permissions?: components["schemas"]["Permissions"];
|
|
7048
7212
|
/** @description Attribute paths that this Unit provides to downstream Units via NeedsProvides Links. Computed from get-provided and stored on data updates. */
|
|
7049
7213
|
readonly ProvidedPaths?: components["schemas"]["AttributeInfo"][];
|
|
@@ -7698,6 +7862,8 @@ interface components {
|
|
|
7698
7862
|
readonly EntityType?: string;
|
|
7699
7863
|
/** @description Unique identifier for the External Identity Provider record matching this User. */
|
|
7700
7864
|
ExternalID?: string;
|
|
7865
|
+
/** @description The Groups the User belongs to, from the identity provider's claims at their last login. A bot User's Groups are the ones it was added to through the Group API instead. (readonly) */
|
|
7866
|
+
GroupIDs?: components["schemas"]["UUID"][];
|
|
7701
7867
|
/** @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. */
|
|
7702
7868
|
HiddenReason?: string;
|
|
7703
7869
|
/** @description The URL to get the profile avatar picture of the User. */
|
|
@@ -7875,9 +8041,9 @@ interface components {
|
|
|
7875
8041
|
};
|
|
7876
8042
|
WorkerInfo: {
|
|
7877
8043
|
FunctionWorkerInfo?: components["schemas"]["FunctionWorkerInfo"];
|
|
7878
|
-
/** @description If true, this is a server-hosted worker. */
|
|
8044
|
+
/** @description If true, this is a server-hosted worker. It cannot be changed after the worker is created. */
|
|
7879
8045
|
IsServerWorker?: boolean;
|
|
7880
|
-
/** @description If true, the server worker operates using the requesting user's identity rather than the worker's bot identity. Requires IsServerWorker to be true. */
|
|
8046
|
+
/** @description If true, the server worker operates using the requesting user's identity rather than the worker's bot identity. Requires IsServerWorker to be true. It cannot be changed after the worker is created. */
|
|
7881
8047
|
UseUserIdentity?: boolean;
|
|
7882
8048
|
};
|
|
7883
8049
|
};
|
|
@@ -8467,6 +8633,8 @@ interface operations {
|
|
|
8467
8633
|
where_unit?: string;
|
|
8468
8634
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
8469
8635
|
filter_unit?: string;
|
|
8636
|
+
/** @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. */
|
|
8637
|
+
patch_existing?: boolean;
|
|
8470
8638
|
/** @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. */
|
|
8471
8639
|
dry_run?: boolean;
|
|
8472
8640
|
};
|
|
@@ -9706,6 +9874,8 @@ interface operations {
|
|
|
9706
9874
|
where_unit?: string;
|
|
9707
9875
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
9708
9876
|
filter_unit?: string;
|
|
9877
|
+
/** @description With from_backing_units, patch a Attribute 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 Attribute is returned as it is. */
|
|
9878
|
+
patch_existing?: boolean;
|
|
9709
9879
|
/** @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. */
|
|
9710
9880
|
dry_run?: boolean;
|
|
9711
9881
|
};
|
|
@@ -10889,7 +11059,6 @@ interface operations {
|
|
|
10889
11059
|
Annotations?: {
|
|
10890
11060
|
[key: string]: string | null;
|
|
10891
11061
|
} | null;
|
|
10892
|
-
Condition?: string | null;
|
|
10893
11062
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
10894
11063
|
DeleteGates?: {
|
|
10895
11064
|
[key: string]: boolean | null;
|
|
@@ -11355,7 +11524,7 @@ interface operations {
|
|
|
11355
11524
|
* An example conjunction is:
|
|
11356
11525
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11357
11526
|
*
|
|
11358
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
11527
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
11359
11528
|
*
|
|
11360
11529
|
* The whole string must be query-encoded.
|
|
11361
11530
|
*/
|
|
@@ -11533,7 +11702,7 @@ interface operations {
|
|
|
11533
11702
|
* An example conjunction is:
|
|
11534
11703
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11535
11704
|
*
|
|
11536
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
11705
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
11537
11706
|
*
|
|
11538
11707
|
* The whole string must be query-encoded.
|
|
11539
11708
|
*/
|
|
@@ -11829,7 +11998,7 @@ interface operations {
|
|
|
11829
11998
|
* An example conjunction is:
|
|
11830
11999
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11831
12000
|
*
|
|
11832
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12001
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
11833
12002
|
*
|
|
11834
12003
|
* The whole string must be query-encoded.
|
|
11835
12004
|
*/
|
|
@@ -12025,7 +12194,7 @@ interface operations {
|
|
|
12025
12194
|
* An example conjunction is:
|
|
12026
12195
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12027
12196
|
*
|
|
12028
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12197
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
12029
12198
|
*
|
|
12030
12199
|
* The whole string must be query-encoded.
|
|
12031
12200
|
*/
|
|
@@ -13667,6 +13836,8 @@ interface operations {
|
|
|
13667
13836
|
where_unit?: string;
|
|
13668
13837
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
13669
13838
|
filter_unit?: string;
|
|
13839
|
+
/** @description With from_backing_units, patch a ChangeWorkflow 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 ChangeWorkflow is returned as it is. */
|
|
13840
|
+
patch_existing?: boolean;
|
|
13670
13841
|
/** @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. */
|
|
13671
13842
|
dry_run?: boolean;
|
|
13672
13843
|
};
|
|
@@ -15866,6 +16037,8 @@ interface operations {
|
|
|
15866
16037
|
where_unit?: string;
|
|
15867
16038
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
15868
16039
|
filter_unit?: string;
|
|
16040
|
+
/** @description With from_backing_units, patch a Filter 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 Filter is returned as it is. */
|
|
16041
|
+
patch_existing?: boolean;
|
|
15869
16042
|
/** @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. */
|
|
15870
16043
|
dry_run?: boolean;
|
|
15871
16044
|
};
|
|
@@ -16584,7 +16757,627 @@ interface operations {
|
|
|
16584
16757
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16585
16758
|
};
|
|
16586
16759
|
};
|
|
16587
|
-
/** @description Filter not found. */
|
|
16760
|
+
/** @description Filter not found. */
|
|
16761
|
+
404: {
|
|
16762
|
+
headers: {
|
|
16763
|
+
[name: string]: unknown;
|
|
16764
|
+
};
|
|
16765
|
+
content: {
|
|
16766
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16767
|
+
};
|
|
16768
|
+
};
|
|
16769
|
+
/** @description Filter data conflict. Data has changed since last read. */
|
|
16770
|
+
409: {
|
|
16771
|
+
headers: {
|
|
16772
|
+
[name: string]: unknown;
|
|
16773
|
+
};
|
|
16774
|
+
content: {
|
|
16775
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16776
|
+
};
|
|
16777
|
+
};
|
|
16778
|
+
/** @description Something went wrong while processing Filter. */
|
|
16779
|
+
500: {
|
|
16780
|
+
headers: {
|
|
16781
|
+
[name: string]: unknown;
|
|
16782
|
+
};
|
|
16783
|
+
content: {
|
|
16784
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16785
|
+
};
|
|
16786
|
+
};
|
|
16787
|
+
/** @description Unexpected error. */
|
|
16788
|
+
default: {
|
|
16789
|
+
headers: {
|
|
16790
|
+
[name: string]: unknown;
|
|
16791
|
+
};
|
|
16792
|
+
content: {
|
|
16793
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16794
|
+
};
|
|
16795
|
+
};
|
|
16796
|
+
};
|
|
16797
|
+
};
|
|
16798
|
+
ListOrgFunctions: {
|
|
16799
|
+
parameters: {
|
|
16800
|
+
query?: {
|
|
16801
|
+
/** @description Space ID or slug whose executor to use for listing or invoking builtin functions */
|
|
16802
|
+
executor_space?: string;
|
|
16803
|
+
/**
|
|
16804
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
16805
|
+
* the list of FunctionSignatures returned. The expression syntax was inspired by SQL.
|
|
16806
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
16807
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
16808
|
+
* as in the JSON encoding.
|
|
16809
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
16810
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
16811
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
16812
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
16813
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
16814
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
16815
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
16816
|
+
* UUID and time literals must be quoted as string literals.
|
|
16817
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
16818
|
+
* Time literals use the same form as when serialized as JSON,
|
|
16819
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
16820
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
16821
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
16822
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
16823
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
16824
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
16825
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
16826
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
16827
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
16828
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
16829
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
16830
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
16831
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
16832
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
16833
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
16834
|
+
* Conjunctions are supported using the `AND` operator.
|
|
16835
|
+
* An example conjunction is:
|
|
16836
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16837
|
+
*
|
|
16838
|
+
* Supported attributes for filtering on FunctionSignature: AttributeName, Description, FunctionName, FunctionType, Hermetic, Idempotent, Mutating, OutputInfo.Description, OutputInfo.OutputType, OutputInfo.ResultName, Replayable, RequiredParameters, ToolchainType, Validating, VarArgs.
|
|
16839
|
+
*
|
|
16840
|
+
* The whole string must be query-encoded.
|
|
16841
|
+
*/
|
|
16842
|
+
where?: string;
|
|
16843
|
+
};
|
|
16844
|
+
header?: never;
|
|
16845
|
+
path?: never;
|
|
16846
|
+
cookie?: never;
|
|
16847
|
+
};
|
|
16848
|
+
requestBody?: never;
|
|
16849
|
+
responses: {
|
|
16850
|
+
/** @description OK */
|
|
16851
|
+
200: {
|
|
16852
|
+
headers: {
|
|
16853
|
+
[name: string]: unknown;
|
|
16854
|
+
};
|
|
16855
|
+
content: {
|
|
16856
|
+
"application/json": {
|
|
16857
|
+
[key: string]: {
|
|
16858
|
+
[key: string]: components["schemas"]["FunctionSignature"];
|
|
16859
|
+
};
|
|
16860
|
+
};
|
|
16861
|
+
};
|
|
16862
|
+
};
|
|
16863
|
+
/** @description Function request is invalid (Bad Request). */
|
|
16864
|
+
400: {
|
|
16865
|
+
headers: {
|
|
16866
|
+
[name: string]: unknown;
|
|
16867
|
+
};
|
|
16868
|
+
content: {
|
|
16869
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16870
|
+
};
|
|
16871
|
+
};
|
|
16872
|
+
/** @description Unauthorized access. */
|
|
16873
|
+
401: {
|
|
16874
|
+
headers: {
|
|
16875
|
+
[name: string]: unknown;
|
|
16876
|
+
};
|
|
16877
|
+
content: {
|
|
16878
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16879
|
+
};
|
|
16880
|
+
};
|
|
16881
|
+
/** @description Forbidden access. */
|
|
16882
|
+
403: {
|
|
16883
|
+
headers: {
|
|
16884
|
+
[name: string]: unknown;
|
|
16885
|
+
};
|
|
16886
|
+
content: {
|
|
16887
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16888
|
+
};
|
|
16889
|
+
};
|
|
16890
|
+
/** @description Function not found. */
|
|
16891
|
+
404: {
|
|
16892
|
+
headers: {
|
|
16893
|
+
[name: string]: unknown;
|
|
16894
|
+
};
|
|
16895
|
+
content: {
|
|
16896
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16897
|
+
};
|
|
16898
|
+
};
|
|
16899
|
+
/** @description Something went wrong while processing Function. */
|
|
16900
|
+
500: {
|
|
16901
|
+
headers: {
|
|
16902
|
+
[name: string]: unknown;
|
|
16903
|
+
};
|
|
16904
|
+
content: {
|
|
16905
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16906
|
+
};
|
|
16907
|
+
};
|
|
16908
|
+
/** @description Unexpected error. */
|
|
16909
|
+
default: {
|
|
16910
|
+
headers: {
|
|
16911
|
+
[name: string]: unknown;
|
|
16912
|
+
};
|
|
16913
|
+
content: {
|
|
16914
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16915
|
+
};
|
|
16916
|
+
};
|
|
16917
|
+
};
|
|
16918
|
+
};
|
|
16919
|
+
InvokeFunctionsOnOrg: {
|
|
16920
|
+
parameters: {
|
|
16921
|
+
query?: {
|
|
16922
|
+
/** @description Space ID or slug whose executor to use for listing or invoking builtin functions */
|
|
16923
|
+
executor_space?: string;
|
|
16924
|
+
/** @description Dry run mode: when true, skip updating configuration data even if it changed */
|
|
16925
|
+
dry_run?: string;
|
|
16926
|
+
/** @description Record the paths this operation writes as protected local overrides, so a later merge from upstream does not overwrite them. Without it the operation claims nothing: each written path keeps whatever the Unit already has for it, and a path with no history is left unprotected. It only ever adds protection -- re-opening a path is the /protection API (cub unit set-protection --unprotect). */
|
|
16927
|
+
protect?: boolean;
|
|
16928
|
+
/** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
|
|
16929
|
+
clearance?: string;
|
|
16930
|
+
/** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
|
|
16931
|
+
guards?: string;
|
|
16932
|
+
/** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
16933
|
+
change_set_id?: string;
|
|
16934
|
+
/** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
|
|
16935
|
+
change_order?: string;
|
|
16936
|
+
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
16937
|
+
subgroup?: string;
|
|
16938
|
+
/** @description Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers: LastReleasedRevisionNum, HeadRevisionNum. Can be prefixed with 'Before:' (e.g., Before:HeadRevisionNum). May be repeated for multiple sources. */
|
|
16939
|
+
other_data_source?: string;
|
|
16940
|
+
/**
|
|
16941
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
16942
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
16943
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
16944
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
16945
|
+
* as in the JSON encoding.
|
|
16946
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
16947
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
16948
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
16949
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
16950
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
16951
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
16952
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
16953
|
+
* UUID and time literals must be quoted as string literals.
|
|
16954
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
16955
|
+
* Time literals use the same form as when serialized as JSON,
|
|
16956
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
16957
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
16958
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
16959
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
16960
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
16961
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
16962
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
16963
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
16964
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
16965
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
16966
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
16967
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
16968
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
16969
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
16970
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
16971
|
+
* Conjunctions are supported using the `AND` operator.
|
|
16972
|
+
* An example conjunction is:
|
|
16973
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16974
|
+
*
|
|
16975
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16976
|
+
*
|
|
16977
|
+
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
16978
|
+
*
|
|
16979
|
+
* The whole string must be query-encoded.
|
|
16980
|
+
*/
|
|
16981
|
+
where?: string;
|
|
16982
|
+
/**
|
|
16983
|
+
* @description UUID of a Filter entity to apply to the Unit list.
|
|
16984
|
+
*
|
|
16985
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
16986
|
+
*
|
|
16987
|
+
* The Filter's From field must match the entity type being filtered (Unit).
|
|
16988
|
+
*
|
|
16989
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
16990
|
+
*
|
|
16991
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
16992
|
+
*
|
|
16993
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
16994
|
+
*/
|
|
16995
|
+
filter?: string;
|
|
16996
|
+
/**
|
|
16997
|
+
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
16998
|
+
*
|
|
16999
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
17000
|
+
*
|
|
17001
|
+
* 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.
|
|
17002
|
+
*
|
|
17003
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
17004
|
+
*/
|
|
17005
|
+
include_hidden?: string;
|
|
17006
|
+
/** @description Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides. */
|
|
17007
|
+
include?: string;
|
|
17008
|
+
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
17009
|
+
resource_type?: string;
|
|
17010
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
17011
|
+
where_data?: string;
|
|
17012
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
17013
|
+
where_data_engine?: string;
|
|
17014
|
+
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
17015
|
+
where_trigger?: string;
|
|
17016
|
+
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
17017
|
+
trigger_filter?: string;
|
|
17018
|
+
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
17019
|
+
triggers_passed?: boolean;
|
|
17020
|
+
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
17021
|
+
view?: string;
|
|
17022
|
+
};
|
|
17023
|
+
header?: never;
|
|
17024
|
+
path?: never;
|
|
17025
|
+
cookie?: never;
|
|
17026
|
+
};
|
|
17027
|
+
requestBody?: {
|
|
17028
|
+
content: {
|
|
17029
|
+
"application/json": components["schemas"]["FunctionInvocationsRequest"];
|
|
17030
|
+
};
|
|
17031
|
+
};
|
|
17032
|
+
responses: {
|
|
17033
|
+
/** @description OK */
|
|
17034
|
+
200: {
|
|
17035
|
+
headers: {
|
|
17036
|
+
[name: string]: unknown;
|
|
17037
|
+
};
|
|
17038
|
+
content: {
|
|
17039
|
+
"application/json": components["schemas"]["FunctionInvocationsResponse"][];
|
|
17040
|
+
};
|
|
17041
|
+
};
|
|
17042
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
17043
|
+
207: {
|
|
17044
|
+
headers: {
|
|
17045
|
+
[name: string]: unknown;
|
|
17046
|
+
};
|
|
17047
|
+
content: {
|
|
17048
|
+
"application/json": components["schemas"]["FunctionInvocationsResponse"][];
|
|
17049
|
+
};
|
|
17050
|
+
};
|
|
17051
|
+
/** @description Function request is invalid (Bad Request). */
|
|
17052
|
+
400: {
|
|
17053
|
+
headers: {
|
|
17054
|
+
[name: string]: unknown;
|
|
17055
|
+
};
|
|
17056
|
+
content: {
|
|
17057
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17058
|
+
};
|
|
17059
|
+
};
|
|
17060
|
+
/** @description Unauthorized access. */
|
|
17061
|
+
401: {
|
|
17062
|
+
headers: {
|
|
17063
|
+
[name: string]: unknown;
|
|
17064
|
+
};
|
|
17065
|
+
content: {
|
|
17066
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17067
|
+
};
|
|
17068
|
+
};
|
|
17069
|
+
/** @description Forbidden access. */
|
|
17070
|
+
403: {
|
|
17071
|
+
headers: {
|
|
17072
|
+
[name: string]: unknown;
|
|
17073
|
+
};
|
|
17074
|
+
content: {
|
|
17075
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17076
|
+
};
|
|
17077
|
+
};
|
|
17078
|
+
/** @description Function not found. */
|
|
17079
|
+
404: {
|
|
17080
|
+
headers: {
|
|
17081
|
+
[name: string]: unknown;
|
|
17082
|
+
};
|
|
17083
|
+
content: {
|
|
17084
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17085
|
+
};
|
|
17086
|
+
};
|
|
17087
|
+
/** @description Function data conflict. Data has changed since last read. */
|
|
17088
|
+
409: {
|
|
17089
|
+
headers: {
|
|
17090
|
+
[name: string]: unknown;
|
|
17091
|
+
};
|
|
17092
|
+
content: {
|
|
17093
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17094
|
+
};
|
|
17095
|
+
};
|
|
17096
|
+
/** @description Unable to process configuration data */
|
|
17097
|
+
422: {
|
|
17098
|
+
headers: {
|
|
17099
|
+
[name: string]: unknown;
|
|
17100
|
+
};
|
|
17101
|
+
content: {
|
|
17102
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17103
|
+
};
|
|
17104
|
+
};
|
|
17105
|
+
/** @description Bridge worker is overloaded with outstanding function invocations */
|
|
17106
|
+
429: {
|
|
17107
|
+
headers: {
|
|
17108
|
+
[name: string]: unknown;
|
|
17109
|
+
};
|
|
17110
|
+
content: {
|
|
17111
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17112
|
+
};
|
|
17113
|
+
};
|
|
17114
|
+
/** @description Something went wrong while processing Function. */
|
|
17115
|
+
500: {
|
|
17116
|
+
headers: {
|
|
17117
|
+
[name: string]: unknown;
|
|
17118
|
+
};
|
|
17119
|
+
content: {
|
|
17120
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17121
|
+
};
|
|
17122
|
+
};
|
|
17123
|
+
/** @description Bridge worker is unavailable; one or more function sources were not executed */
|
|
17124
|
+
503: {
|
|
17125
|
+
headers: {
|
|
17126
|
+
[name: string]: unknown;
|
|
17127
|
+
};
|
|
17128
|
+
content: {
|
|
17129
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17130
|
+
};
|
|
17131
|
+
};
|
|
17132
|
+
/** @description Timed out waiting for the bridge worker to return a function result */
|
|
17133
|
+
504: {
|
|
17134
|
+
headers: {
|
|
17135
|
+
[name: string]: unknown;
|
|
17136
|
+
};
|
|
17137
|
+
content: {
|
|
17138
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17139
|
+
};
|
|
17140
|
+
};
|
|
17141
|
+
/** @description Unexpected error. */
|
|
17142
|
+
default: {
|
|
17143
|
+
headers: {
|
|
17144
|
+
[name: string]: unknown;
|
|
17145
|
+
};
|
|
17146
|
+
content: {
|
|
17147
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17148
|
+
};
|
|
17149
|
+
};
|
|
17150
|
+
};
|
|
17151
|
+
};
|
|
17152
|
+
ListGroups: {
|
|
17153
|
+
parameters: {
|
|
17154
|
+
query?: {
|
|
17155
|
+
/**
|
|
17156
|
+
* @description The specified string is an expression for the purpose of filtering
|
|
17157
|
+
* the list of Groups returned. The expression syntax was inspired by SQL.
|
|
17158
|
+
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
17159
|
+
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
17160
|
+
* as in the JSON encoding.
|
|
17161
|
+
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
17162
|
+
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
17163
|
+
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
17164
|
+
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
17165
|
+
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
17166
|
+
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
17167
|
+
* UUIDs and boolean attributes support equality and inequality only.
|
|
17168
|
+
* UUID and time literals must be quoted as string literals.
|
|
17169
|
+
* String literals are quoted with single quotes, such as `'string'`.
|
|
17170
|
+
* Time literals use the same form as when serialized as JSON,
|
|
17171
|
+
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
17172
|
+
* Integer and boolean literals are also supported for attributes of those types.
|
|
17173
|
+
* Arrays support the `?` operator to to match any element of the array,
|
|
17174
|
+
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
17175
|
+
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
17176
|
+
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
17177
|
+
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
17178
|
+
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
17179
|
+
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
17180
|
+
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
17181
|
+
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
17182
|
+
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
17183
|
+
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
17184
|
+
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
17185
|
+
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
17186
|
+
* Conjunctions are supported using the `AND` operator.
|
|
17187
|
+
* An example conjunction is:
|
|
17188
|
+
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
17189
|
+
*
|
|
17190
|
+
* Supported attributes for filtering on Group: CreatedAt, DisplayName, ExternalID, GroupID, Slug, UpdatedAt.
|
|
17191
|
+
*
|
|
17192
|
+
* The whole string must be query-encoded.
|
|
17193
|
+
*/
|
|
17194
|
+
where?: string;
|
|
17195
|
+
/**
|
|
17196
|
+
* @description UUID of a Filter entity to apply to the Group list.
|
|
17197
|
+
*
|
|
17198
|
+
* The Filter must be in the same Organization as the user credentials.
|
|
17199
|
+
*
|
|
17200
|
+
* The Filter's From field must match the entity type being filtered (Group).
|
|
17201
|
+
*
|
|
17202
|
+
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
17203
|
+
*
|
|
17204
|
+
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
17205
|
+
*
|
|
17206
|
+
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
17207
|
+
*/
|
|
17208
|
+
filter?: string;
|
|
17209
|
+
/**
|
|
17210
|
+
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
17211
|
+
*
|
|
17212
|
+
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
17213
|
+
*
|
|
17214
|
+
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
17215
|
+
*
|
|
17216
|
+
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
17217
|
+
*
|
|
17218
|
+
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
17219
|
+
*
|
|
17220
|
+
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
17221
|
+
*
|
|
17222
|
+
* Searchable fields for Group include string and map-type attributes from the queryable attributes list.
|
|
17223
|
+
*
|
|
17224
|
+
* The whole string must be query-encoded.
|
|
17225
|
+
*/
|
|
17226
|
+
contains?: string;
|
|
17227
|
+
/**
|
|
17228
|
+
* @description Select clause for specifying which fields to include in the response for Group.
|
|
17229
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
17230
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
17231
|
+
* If not specified, all fields are returned.
|
|
17232
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
|
|
17233
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
17234
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
17235
|
+
* The whole string must be query-encoded.
|
|
17236
|
+
*/
|
|
17237
|
+
select?: string;
|
|
17238
|
+
/**
|
|
17239
|
+
* @description Hidden Group entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
17240
|
+
*
|
|
17241
|
+
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
17242
|
+
*
|
|
17243
|
+
* 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.
|
|
17244
|
+
*
|
|
17245
|
+
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
17246
|
+
*/
|
|
17247
|
+
include_hidden?: string;
|
|
17248
|
+
};
|
|
17249
|
+
header?: never;
|
|
17250
|
+
path?: never;
|
|
17251
|
+
cookie?: never;
|
|
17252
|
+
};
|
|
17253
|
+
requestBody?: never;
|
|
17254
|
+
responses: {
|
|
17255
|
+
/** @description OK */
|
|
17256
|
+
200: {
|
|
17257
|
+
headers: {
|
|
17258
|
+
[name: string]: unknown;
|
|
17259
|
+
};
|
|
17260
|
+
content: {
|
|
17261
|
+
"application/json": components["schemas"]["ExtendedGroup"][];
|
|
17262
|
+
};
|
|
17263
|
+
};
|
|
17264
|
+
/** @description Group request is invalid (Bad Request). */
|
|
17265
|
+
400: {
|
|
17266
|
+
headers: {
|
|
17267
|
+
[name: string]: unknown;
|
|
17268
|
+
};
|
|
17269
|
+
content: {
|
|
17270
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17271
|
+
};
|
|
17272
|
+
};
|
|
17273
|
+
/** @description Unauthorized access. */
|
|
17274
|
+
401: {
|
|
17275
|
+
headers: {
|
|
17276
|
+
[name: string]: unknown;
|
|
17277
|
+
};
|
|
17278
|
+
content: {
|
|
17279
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17280
|
+
};
|
|
17281
|
+
};
|
|
17282
|
+
/** @description Forbidden access. */
|
|
17283
|
+
403: {
|
|
17284
|
+
headers: {
|
|
17285
|
+
[name: string]: unknown;
|
|
17286
|
+
};
|
|
17287
|
+
content: {
|
|
17288
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17289
|
+
};
|
|
17290
|
+
};
|
|
17291
|
+
/** @description Group not found. */
|
|
17292
|
+
404: {
|
|
17293
|
+
headers: {
|
|
17294
|
+
[name: string]: unknown;
|
|
17295
|
+
};
|
|
17296
|
+
content: {
|
|
17297
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17298
|
+
};
|
|
17299
|
+
};
|
|
17300
|
+
/** @description Something went wrong while processing Group. */
|
|
17301
|
+
500: {
|
|
17302
|
+
headers: {
|
|
17303
|
+
[name: string]: unknown;
|
|
17304
|
+
};
|
|
17305
|
+
content: {
|
|
17306
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17307
|
+
};
|
|
17308
|
+
};
|
|
17309
|
+
/** @description Unexpected error. */
|
|
17310
|
+
default: {
|
|
17311
|
+
headers: {
|
|
17312
|
+
[name: string]: unknown;
|
|
17313
|
+
};
|
|
17314
|
+
content: {
|
|
17315
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17316
|
+
};
|
|
17317
|
+
};
|
|
17318
|
+
};
|
|
17319
|
+
};
|
|
17320
|
+
GetGroup: {
|
|
17321
|
+
parameters: {
|
|
17322
|
+
query?: {
|
|
17323
|
+
/**
|
|
17324
|
+
* @description Select clause for specifying which fields to include in the response for Group.
|
|
17325
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
17326
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
17327
|
+
* If not specified, all fields are returned.
|
|
17328
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, GroupID) and Slug are always returned regardless of the select parameter.
|
|
17329
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
17330
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
17331
|
+
* The whole string must be query-encoded.
|
|
17332
|
+
*/
|
|
17333
|
+
select?: string;
|
|
17334
|
+
};
|
|
17335
|
+
header?: never;
|
|
17336
|
+
path: {
|
|
17337
|
+
/** @description Unique identifier for a group_id */
|
|
17338
|
+
group_id: string;
|
|
17339
|
+
};
|
|
17340
|
+
cookie?: never;
|
|
17341
|
+
};
|
|
17342
|
+
requestBody?: never;
|
|
17343
|
+
responses: {
|
|
17344
|
+
/** @description Group with additional related entities expanded based on the request's include parameter. */
|
|
17345
|
+
200: {
|
|
17346
|
+
headers: {
|
|
17347
|
+
[name: string]: unknown;
|
|
17348
|
+
};
|
|
17349
|
+
content: {
|
|
17350
|
+
"application/json": components["schemas"]["ExtendedGroup"];
|
|
17351
|
+
};
|
|
17352
|
+
};
|
|
17353
|
+
/** @description Group request is invalid (Bad Request). */
|
|
17354
|
+
400: {
|
|
17355
|
+
headers: {
|
|
17356
|
+
[name: string]: unknown;
|
|
17357
|
+
};
|
|
17358
|
+
content: {
|
|
17359
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17360
|
+
};
|
|
17361
|
+
};
|
|
17362
|
+
/** @description Unauthorized access. */
|
|
17363
|
+
401: {
|
|
17364
|
+
headers: {
|
|
17365
|
+
[name: string]: unknown;
|
|
17366
|
+
};
|
|
17367
|
+
content: {
|
|
17368
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17369
|
+
};
|
|
17370
|
+
};
|
|
17371
|
+
/** @description Forbidden access. */
|
|
17372
|
+
403: {
|
|
17373
|
+
headers: {
|
|
17374
|
+
[name: string]: unknown;
|
|
17375
|
+
};
|
|
17376
|
+
content: {
|
|
17377
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17378
|
+
};
|
|
17379
|
+
};
|
|
17380
|
+
/** @description Group not found. */
|
|
16588
17381
|
404: {
|
|
16589
17382
|
headers: {
|
|
16590
17383
|
[name: string]: unknown;
|
|
@@ -16593,16 +17386,7 @@ interface operations {
|
|
|
16593
17386
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16594
17387
|
};
|
|
16595
17388
|
};
|
|
16596
|
-
/** @description
|
|
16597
|
-
409: {
|
|
16598
|
-
headers: {
|
|
16599
|
-
[name: string]: unknown;
|
|
16600
|
-
};
|
|
16601
|
-
content: {
|
|
16602
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16603
|
-
};
|
|
16604
|
-
};
|
|
16605
|
-
/** @description Something went wrong while processing Filter. */
|
|
17389
|
+
/** @description Something went wrong while processing Group. */
|
|
16606
17390
|
500: {
|
|
16607
17391
|
headers: {
|
|
16608
17392
|
[name: string]: unknown;
|
|
@@ -16622,72 +17406,30 @@ interface operations {
|
|
|
16622
17406
|
};
|
|
16623
17407
|
};
|
|
16624
17408
|
};
|
|
16625
|
-
|
|
17409
|
+
AddGroupBotUser: {
|
|
16626
17410
|
parameters: {
|
|
16627
|
-
query?:
|
|
16628
|
-
/** @description Space ID or slug whose executor to use for listing or invoking builtin functions */
|
|
16629
|
-
executor_space?: string;
|
|
16630
|
-
/**
|
|
16631
|
-
* @description The specified string is an expression for the purpose of filtering
|
|
16632
|
-
* the list of FunctionSignatures returned. The expression syntax was inspired by SQL.
|
|
16633
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
16634
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
16635
|
-
* as in the JSON encoding.
|
|
16636
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
16637
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
16638
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
16639
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
16640
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
16641
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
16642
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
16643
|
-
* UUID and time literals must be quoted as string literals.
|
|
16644
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
16645
|
-
* Time literals use the same form as when serialized as JSON,
|
|
16646
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
16647
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
16648
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
16649
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
16650
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
16651
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
16652
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
16653
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
16654
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
16655
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
16656
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
16657
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
16658
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
16659
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
16660
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
16661
|
-
* Conjunctions are supported using the `AND` operator.
|
|
16662
|
-
* An example conjunction is:
|
|
16663
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16664
|
-
*
|
|
16665
|
-
* Supported attributes for filtering on FunctionSignature: AttributeName, Description, FunctionName, FunctionType, Hermetic, Idempotent, Mutating, OutputInfo.Description, OutputInfo.OutputType, OutputInfo.ResultName, Replayable, RequiredParameters, ToolchainType, Validating, VarArgs.
|
|
16666
|
-
*
|
|
16667
|
-
* The whole string must be query-encoded.
|
|
16668
|
-
*/
|
|
16669
|
-
where?: string;
|
|
16670
|
-
};
|
|
17411
|
+
query?: never;
|
|
16671
17412
|
header?: never;
|
|
16672
|
-
path
|
|
17413
|
+
path: {
|
|
17414
|
+
/** @description Unique identifier for a group_id */
|
|
17415
|
+
group_id: string;
|
|
17416
|
+
/** @description Unique identifier for a user_id */
|
|
17417
|
+
user_id: string;
|
|
17418
|
+
};
|
|
16673
17419
|
cookie?: never;
|
|
16674
17420
|
};
|
|
16675
17421
|
requestBody?: never;
|
|
16676
17422
|
responses: {
|
|
16677
|
-
/** @description
|
|
17423
|
+
/** @description a User in Confighub. */
|
|
16678
17424
|
200: {
|
|
16679
17425
|
headers: {
|
|
16680
17426
|
[name: string]: unknown;
|
|
16681
17427
|
};
|
|
16682
17428
|
content: {
|
|
16683
|
-
"application/json":
|
|
16684
|
-
[key: string]: {
|
|
16685
|
-
[key: string]: components["schemas"]["FunctionSignature"];
|
|
16686
|
-
};
|
|
16687
|
-
};
|
|
17429
|
+
"application/json": components["schemas"]["User"];
|
|
16688
17430
|
};
|
|
16689
17431
|
};
|
|
16690
|
-
/** @description
|
|
17432
|
+
/** @description Group request is invalid (Bad Request). */
|
|
16691
17433
|
400: {
|
|
16692
17434
|
headers: {
|
|
16693
17435
|
[name: string]: unknown;
|
|
@@ -16714,7 +17456,7 @@ interface operations {
|
|
|
16714
17456
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16715
17457
|
};
|
|
16716
17458
|
};
|
|
16717
|
-
/** @description
|
|
17459
|
+
/** @description Group not found. */
|
|
16718
17460
|
404: {
|
|
16719
17461
|
headers: {
|
|
16720
17462
|
[name: string]: unknown;
|
|
@@ -16723,7 +17465,16 @@ interface operations {
|
|
|
16723
17465
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16724
17466
|
};
|
|
16725
17467
|
};
|
|
16726
|
-
/** @description
|
|
17468
|
+
/** @description Group data conflict. Data has changed since last read. */
|
|
17469
|
+
409: {
|
|
17470
|
+
headers: {
|
|
17471
|
+
[name: string]: unknown;
|
|
17472
|
+
};
|
|
17473
|
+
content: {
|
|
17474
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
17475
|
+
};
|
|
17476
|
+
};
|
|
17477
|
+
/** @description Something went wrong while processing Group. */
|
|
16727
17478
|
500: {
|
|
16728
17479
|
headers: {
|
|
16729
17480
|
[name: string]: unknown;
|
|
@@ -16743,139 +17494,30 @@ interface operations {
|
|
|
16743
17494
|
};
|
|
16744
17495
|
};
|
|
16745
17496
|
};
|
|
16746
|
-
|
|
17497
|
+
RemoveGroupBotUser: {
|
|
16747
17498
|
parameters: {
|
|
16748
|
-
query?:
|
|
16749
|
-
/** @description Space ID or slug whose executor to use for listing or invoking builtin functions */
|
|
16750
|
-
executor_space?: string;
|
|
16751
|
-
/** @description Dry run mode: when true, skip updating configuration data even if it changed */
|
|
16752
|
-
dry_run?: string;
|
|
16753
|
-
/** @description Record the paths this operation writes as protected local overrides, so a later merge from upstream does not overwrite them. Without it the operation claims nothing: each written path keeps whatever the Unit already has for it, and a path with no history is left unprotected. It only ever adds protection -- re-opening a path is the /protection API (cub unit set-protection --unprotect). */
|
|
16754
|
-
protect?: boolean;
|
|
16755
|
-
/** @description The classes of guarded reason this operation is cleared for, as a JSON Clearance -- a list of {Key, Operator, Values} requirements, where Operator is Exists, In, NotIn, or DoesNotExist. A path whose guards this does not cover is not written, and the withheld change is reported as a Guarded conflict. An absent or empty clearance clears nothing, which only matters for a Unit that has guards. */
|
|
16756
|
-
clearance?: string;
|
|
16757
|
-
/** @description The guards this operation records on the paths it writes, as a JSON object of guard key to value -- the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. The guard analogue of protect: protect claims the paths, this says why. It only ever adds and overwrites the keys it names -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). */
|
|
16758
|
-
guards?: string;
|
|
16759
|
-
/** @description Must match ChangeSetID of affected Units unless in dry run mode; not valid when invoked on Revisions */
|
|
16760
|
-
change_set_id?: string;
|
|
16761
|
-
/** @description ChangeOrder to promote, which must have UpdateType Invoke. What runs then comes from the ChangeOrder rather than from the request body, which may not carry functions, triggers or invocations of its own; that is what holds every Space in scope to the same change. Only the Units the ChangeOrder covers are reached, a Unit that has already taken it is passed over, and every Unit reached is marked with the ChangeOrder's start and end Tags -- both on the head, with no Revision made, where the invocation changed nothing. Not valid when invoked on Revisions. */
|
|
16762
|
-
change_order?: string;
|
|
16763
|
-
/** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
16764
|
-
subgroup?: string;
|
|
16765
|
-
/** @description Source of additional configuration data to pass to functions that need it (e.g., vet-immutable). Supports named revision specifiers: LastReleasedRevisionNum, HeadRevisionNum. Can be prefixed with 'Before:' (e.g., Before:HeadRevisionNum). May be repeated for multiple sources. */
|
|
16766
|
-
other_data_source?: string;
|
|
16767
|
-
/**
|
|
16768
|
-
* @description The specified string is an expression for the purpose of filtering
|
|
16769
|
-
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
16770
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
16771
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
16772
|
-
* as in the JSON encoding.
|
|
16773
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
16774
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
16775
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
16776
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
16777
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
16778
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
16779
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
16780
|
-
* UUID and time literals must be quoted as string literals.
|
|
16781
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
16782
|
-
* Time literals use the same form as when serialized as JSON,
|
|
16783
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
16784
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
16785
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
16786
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
16787
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
16788
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
16789
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
16790
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
16791
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
16792
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
16793
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
16794
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
16795
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
16796
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
16797
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
16798
|
-
* Conjunctions are supported using the `AND` operator.
|
|
16799
|
-
* An example conjunction is:
|
|
16800
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16801
|
-
*
|
|
16802
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastActionAt, LastChangeDescription, LastReleasedRevisionNum, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16803
|
-
*
|
|
16804
|
-
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Unapplied units can be found using `LastReleasedRevisionNum = 0`. Units with unapplied changes can be found with `HeadRevisionNum > LastReleasedRevisionNum`.
|
|
16805
|
-
*
|
|
16806
|
-
* The whole string must be query-encoded.
|
|
16807
|
-
*/
|
|
16808
|
-
where?: string;
|
|
16809
|
-
/**
|
|
16810
|
-
* @description UUID of a Filter entity to apply to the Unit list.
|
|
16811
|
-
*
|
|
16812
|
-
* The Filter must be in the same Organization as the user credentials.
|
|
16813
|
-
*
|
|
16814
|
-
* The Filter's From field must match the entity type being filtered (Unit).
|
|
16815
|
-
*
|
|
16816
|
-
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
16817
|
-
*
|
|
16818
|
-
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
16819
|
-
*
|
|
16820
|
-
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
16821
|
-
*/
|
|
16822
|
-
filter?: string;
|
|
16823
|
-
/**
|
|
16824
|
-
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
16825
|
-
*
|
|
16826
|
-
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
16827
|
-
*
|
|
16828
|
-
* 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.
|
|
16829
|
-
*
|
|
16830
|
-
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
16831
|
-
*/
|
|
16832
|
-
include_hidden?: string;
|
|
16833
|
-
/** @description Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides. */
|
|
16834
|
-
include?: string;
|
|
16835
|
-
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
16836
|
-
resource_type?: string;
|
|
16837
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
16838
|
-
where_data?: string;
|
|
16839
|
-
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
16840
|
-
where_data_engine?: string;
|
|
16841
|
-
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
16842
|
-
where_trigger?: string;
|
|
16843
|
-
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
16844
|
-
trigger_filter?: string;
|
|
16845
|
-
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
16846
|
-
triggers_passed?: boolean;
|
|
16847
|
-
/** @description View slug or UUID. Applies the View's column definitions to extract values for each unit. If the View has a FilterID, its filter is ANDed with other filters. The View must have Of=Unit or a Filter with From=Unit. */
|
|
16848
|
-
view?: string;
|
|
16849
|
-
};
|
|
17499
|
+
query?: never;
|
|
16850
17500
|
header?: never;
|
|
16851
|
-
path
|
|
16852
|
-
|
|
16853
|
-
|
|
16854
|
-
|
|
16855
|
-
|
|
16856
|
-
"application/json": components["schemas"]["FunctionInvocationsRequest"];
|
|
17501
|
+
path: {
|
|
17502
|
+
/** @description Unique identifier for a group_id */
|
|
17503
|
+
group_id: string;
|
|
17504
|
+
/** @description Unique identifier for a user_id */
|
|
17505
|
+
user_id: string;
|
|
16857
17506
|
};
|
|
17507
|
+
cookie?: never;
|
|
16858
17508
|
};
|
|
17509
|
+
requestBody?: never;
|
|
16859
17510
|
responses: {
|
|
16860
|
-
/** @description
|
|
17511
|
+
/** @description a User in Confighub. */
|
|
16861
17512
|
200: {
|
|
16862
17513
|
headers: {
|
|
16863
17514
|
[name: string]: unknown;
|
|
16864
17515
|
};
|
|
16865
17516
|
content: {
|
|
16866
|
-
"application/json": components["schemas"]["
|
|
16867
|
-
};
|
|
16868
|
-
};
|
|
16869
|
-
/** @description Multi-Status: Mixed success and failure results */
|
|
16870
|
-
207: {
|
|
16871
|
-
headers: {
|
|
16872
|
-
[name: string]: unknown;
|
|
16873
|
-
};
|
|
16874
|
-
content: {
|
|
16875
|
-
"application/json": components["schemas"]["FunctionInvocationsResponse"][];
|
|
17517
|
+
"application/json": components["schemas"]["User"];
|
|
16876
17518
|
};
|
|
16877
17519
|
};
|
|
16878
|
-
/** @description
|
|
17520
|
+
/** @description Group request is invalid (Bad Request). */
|
|
16879
17521
|
400: {
|
|
16880
17522
|
headers: {
|
|
16881
17523
|
[name: string]: unknown;
|
|
@@ -16902,7 +17544,7 @@ interface operations {
|
|
|
16902
17544
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16903
17545
|
};
|
|
16904
17546
|
};
|
|
16905
|
-
/** @description
|
|
17547
|
+
/** @description Group not found. */
|
|
16906
17548
|
404: {
|
|
16907
17549
|
headers: {
|
|
16908
17550
|
[name: string]: unknown;
|
|
@@ -16911,7 +17553,7 @@ interface operations {
|
|
|
16911
17553
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16912
17554
|
};
|
|
16913
17555
|
};
|
|
16914
|
-
/** @description
|
|
17556
|
+
/** @description Group is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
|
|
16915
17557
|
409: {
|
|
16916
17558
|
headers: {
|
|
16917
17559
|
[name: string]: unknown;
|
|
@@ -16920,7 +17562,7 @@ interface operations {
|
|
|
16920
17562
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16921
17563
|
};
|
|
16922
17564
|
};
|
|
16923
|
-
/** @description
|
|
17565
|
+
/** @description Group could not be deleted. */
|
|
16924
17566
|
422: {
|
|
16925
17567
|
headers: {
|
|
16926
17568
|
[name: string]: unknown;
|
|
@@ -16929,16 +17571,7 @@ interface operations {
|
|
|
16929
17571
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16930
17572
|
};
|
|
16931
17573
|
};
|
|
16932
|
-
/** @description
|
|
16933
|
-
429: {
|
|
16934
|
-
headers: {
|
|
16935
|
-
[name: string]: unknown;
|
|
16936
|
-
};
|
|
16937
|
-
content: {
|
|
16938
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16939
|
-
};
|
|
16940
|
-
};
|
|
16941
|
-
/** @description Something went wrong while processing Function. */
|
|
17574
|
+
/** @description Something went wrong while processing Group. */
|
|
16942
17575
|
500: {
|
|
16943
17576
|
headers: {
|
|
16944
17577
|
[name: string]: unknown;
|
|
@@ -16947,24 +17580,6 @@ interface operations {
|
|
|
16947
17580
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16948
17581
|
};
|
|
16949
17582
|
};
|
|
16950
|
-
/** @description Bridge worker is unavailable; one or more function sources were not executed */
|
|
16951
|
-
503: {
|
|
16952
|
-
headers: {
|
|
16953
|
-
[name: string]: unknown;
|
|
16954
|
-
};
|
|
16955
|
-
content: {
|
|
16956
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16957
|
-
};
|
|
16958
|
-
};
|
|
16959
|
-
/** @description Timed out waiting for the bridge worker to return a function result */
|
|
16960
|
-
504: {
|
|
16961
|
-
headers: {
|
|
16962
|
-
[name: string]: unknown;
|
|
16963
|
-
};
|
|
16964
|
-
content: {
|
|
16965
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
16966
|
-
};
|
|
16967
|
-
};
|
|
16968
17583
|
/** @description Unexpected error. */
|
|
16969
17584
|
default: {
|
|
16970
17585
|
headers: {
|
|
@@ -17385,6 +18000,8 @@ interface operations {
|
|
|
17385
18000
|
where_unit?: string;
|
|
17386
18001
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
17387
18002
|
filter_unit?: string;
|
|
18003
|
+
/** @description With from_backing_units, patch a Invocation 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 Invocation is returned as it is. */
|
|
18004
|
+
patch_existing?: boolean;
|
|
17388
18005
|
/** @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. */
|
|
17389
18006
|
dry_run?: boolean;
|
|
17390
18007
|
};
|
|
@@ -18179,7 +18796,7 @@ interface operations {
|
|
|
18179
18796
|
* An example conjunction is:
|
|
18180
18797
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18181
18798
|
*
|
|
18182
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18799
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18183
18800
|
*
|
|
18184
18801
|
* The whole string must be query-encoded.
|
|
18185
18802
|
*/
|
|
@@ -18357,7 +18974,7 @@ interface operations {
|
|
|
18357
18974
|
* An example conjunction is:
|
|
18358
18975
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18359
18976
|
*
|
|
18360
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18977
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18361
18978
|
*
|
|
18362
18979
|
* Where expression to select source links to copy
|
|
18363
18980
|
*
|
|
@@ -18415,7 +19032,7 @@ interface operations {
|
|
|
18415
19032
|
* An example conjunction is:
|
|
18416
19033
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18417
19034
|
*
|
|
18418
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
19035
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18419
19036
|
*
|
|
18420
19037
|
* Where expression to find downstream UpgradeUnit links from each source link's FromUnit. Creates one copy per match. Required if reverse is not specified.
|
|
18421
19038
|
*
|
|
@@ -18457,7 +19074,7 @@ interface operations {
|
|
|
18457
19074
|
* An example conjunction is:
|
|
18458
19075
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18459
19076
|
*
|
|
18460
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
19077
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18461
19078
|
*
|
|
18462
19079
|
* Where expression to find downstream UpgradeUnit link from each source link's ToUnit. Exactly one match required. If omitted, ToUnitID/ToSpaceID are unchanged.
|
|
18463
19080
|
*
|
|
@@ -18524,6 +19141,8 @@ interface operations {
|
|
|
18524
19141
|
where_unit?: string;
|
|
18525
19142
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
18526
19143
|
filter_unit?: string;
|
|
19144
|
+
/** @description With from_backing_units, patch a Link 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 Link is returned as it is. */
|
|
19145
|
+
patch_existing?: boolean;
|
|
18527
19146
|
/** @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. */
|
|
18528
19147
|
dry_run?: boolean;
|
|
18529
19148
|
};
|
|
@@ -18539,7 +19158,6 @@ interface operations {
|
|
|
18539
19158
|
[key: string]: string | null;
|
|
18540
19159
|
} | null;
|
|
18541
19160
|
AutoUpdate?: boolean | null;
|
|
18542
|
-
Bindings?: (Record<string, never> | null)[] | null;
|
|
18543
19161
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
18544
19162
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
18545
19163
|
DeleteGates?: {
|
|
@@ -18562,6 +19180,7 @@ interface operations {
|
|
|
18562
19180
|
Labels?: {
|
|
18563
19181
|
[key: string]: string | null;
|
|
18564
19182
|
} | null;
|
|
19183
|
+
ManualBindings?: (Record<string, never> | null)[] | null;
|
|
18565
19184
|
MergeEnableSubtraction?: boolean | null;
|
|
18566
19185
|
Permissions?: {
|
|
18567
19186
|
[key: string]: Record<string, never> | null;
|
|
@@ -18718,7 +19337,7 @@ interface operations {
|
|
|
18718
19337
|
* An example conjunction is:
|
|
18719
19338
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18720
19339
|
*
|
|
18721
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
19340
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18722
19341
|
*
|
|
18723
19342
|
* filter
|
|
18724
19343
|
*
|
|
@@ -18914,7 +19533,7 @@ interface operations {
|
|
|
18914
19533
|
* An example conjunction is:
|
|
18915
19534
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
18916
19535
|
*
|
|
18917
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
19536
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
18918
19537
|
*
|
|
18919
19538
|
* filter
|
|
18920
19539
|
*
|
|
@@ -18994,7 +19613,6 @@ interface operations {
|
|
|
18994
19613
|
[key: string]: string | null;
|
|
18995
19614
|
} | null;
|
|
18996
19615
|
AutoUpdate?: boolean | null;
|
|
18997
|
-
Bindings?: (Record<string, never> | null)[] | null;
|
|
18998
19616
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
18999
19617
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
19000
19618
|
DeleteGates?: {
|
|
@@ -19017,6 +19635,7 @@ interface operations {
|
|
|
19017
19635
|
Labels?: {
|
|
19018
19636
|
[key: string]: string | null;
|
|
19019
19637
|
} | null;
|
|
19638
|
+
ManualBindings?: (Record<string, never> | null)[] | null;
|
|
19020
19639
|
MergeEnableSubtraction?: boolean | null;
|
|
19021
19640
|
Permissions?: {
|
|
19022
19641
|
[key: string]: Record<string, never> | null;
|
|
@@ -19744,7 +20363,7 @@ interface operations {
|
|
|
19744
20363
|
[name: string]: unknown;
|
|
19745
20364
|
};
|
|
19746
20365
|
content: {
|
|
19747
|
-
"application/json": components["schemas"]["
|
|
20366
|
+
"application/json": components["schemas"]["ExtendedOrganization"][];
|
|
19748
20367
|
};
|
|
19749
20368
|
};
|
|
19750
20369
|
/** @description Organization request is invalid (Bad Request). */
|
|
@@ -19927,13 +20546,13 @@ interface operations {
|
|
|
19927
20546
|
};
|
|
19928
20547
|
requestBody?: never;
|
|
19929
20548
|
responses: {
|
|
19930
|
-
/** @description
|
|
20549
|
+
/** @description OK */
|
|
19931
20550
|
200: {
|
|
19932
20551
|
headers: {
|
|
19933
20552
|
[name: string]: unknown;
|
|
19934
20553
|
};
|
|
19935
20554
|
content: {
|
|
19936
|
-
"application/json": components["schemas"]["
|
|
20555
|
+
"application/json": components["schemas"]["ExtendedOrganization"];
|
|
19937
20556
|
};
|
|
19938
20557
|
};
|
|
19939
20558
|
/** @description Organization request is invalid (Bad Request). */
|
|
@@ -20271,7 +20890,7 @@ interface operations {
|
|
|
20271
20890
|
[name: string]: unknown;
|
|
20272
20891
|
};
|
|
20273
20892
|
content: {
|
|
20274
|
-
"application/json": components["schemas"]["
|
|
20893
|
+
"application/json": components["schemas"]["ExtendedOrganizationMember"][];
|
|
20275
20894
|
};
|
|
20276
20895
|
};
|
|
20277
20896
|
/** @description OrganizationMember request is invalid (Bad Request). */
|
|
@@ -20434,13 +21053,13 @@ interface operations {
|
|
|
20434
21053
|
};
|
|
20435
21054
|
requestBody?: never;
|
|
20436
21055
|
responses: {
|
|
20437
|
-
/** @description
|
|
21056
|
+
/** @description OK */
|
|
20438
21057
|
200: {
|
|
20439
21058
|
headers: {
|
|
20440
21059
|
[name: string]: unknown;
|
|
20441
21060
|
};
|
|
20442
21061
|
content: {
|
|
20443
|
-
"application/json": components["schemas"]["
|
|
21062
|
+
"application/json": components["schemas"]["ExtendedOrganizationMember"];
|
|
20444
21063
|
};
|
|
20445
21064
|
};
|
|
20446
21065
|
/** @description OrganizationMember request is invalid (Bad Request). */
|
|
@@ -20744,7 +21363,7 @@ interface operations {
|
|
|
20744
21363
|
* An example conjunction is:
|
|
20745
21364
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
20746
21365
|
*
|
|
20747
|
-
* Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt.
|
|
21366
|
+
* Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
|
|
20748
21367
|
*
|
|
20749
21368
|
* The whole string must be query-encoded.
|
|
20750
21369
|
*/
|
|
@@ -24289,7 +24908,6 @@ interface operations {
|
|
|
24289
24908
|
Annotations?: {
|
|
24290
24909
|
[key: string]: string | null;
|
|
24291
24910
|
} | null;
|
|
24292
|
-
Condition?: string | null;
|
|
24293
24911
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
24294
24912
|
DeleteGates?: {
|
|
24295
24913
|
[key: string]: boolean | null;
|
|
@@ -24625,7 +25243,7 @@ interface operations {
|
|
|
24625
25243
|
* An example conjunction is:
|
|
24626
25244
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
24627
25245
|
*
|
|
24628
|
-
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
25246
|
+
* Supported attributes for filtering on ChangeOrder: AbortedReason, AdoptedEndTagID, Annotations, ChangeOrderID, ChangeWorkflow, ChangeWorkflowID, CreatedAt, DeleteGates, Description, DisplayName, EndTagID, HiddenReason, InScopeSpaceIDs, InvocationID, Labels, OrganizationID, Parameters, Permissions, PromotionFailures, PromotionOverrides, Promotions, ReleasedRestoredSpaceIDs, ReleasedSpaceIDs, ResolvedSpaceIDs, RestoreTagID, RestoredSpaceIDs, SkippedUnits, Slug, SpaceFilterID, SpaceID, Stage, StartTagID, State, UnitFilterID, UpdateType, UpdatedAt, WhereSpace, WhereUnit.
|
|
24629
25247
|
*
|
|
24630
25248
|
* The whole string must be query-encoded.
|
|
24631
25249
|
*/
|
|
@@ -29181,7 +29799,7 @@ interface operations {
|
|
|
29181
29799
|
* An example conjunction is:
|
|
29182
29800
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
29183
29801
|
*
|
|
29184
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
29802
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
29185
29803
|
*
|
|
29186
29804
|
* The whole string must be query-encoded.
|
|
29187
29805
|
*/
|
|
@@ -29749,7 +30367,6 @@ interface operations {
|
|
|
29749
30367
|
[key: string]: string | null;
|
|
29750
30368
|
} | null;
|
|
29751
30369
|
AutoUpdate?: boolean | null;
|
|
29752
|
-
Bindings?: (Record<string, never> | null)[] | null;
|
|
29753
30370
|
Clearance?: (Record<string, never> | null)[] | null;
|
|
29754
30371
|
/** @description An optional set of gates that, if any is present, will block deletion */
|
|
29755
30372
|
DeleteGates?: {
|
|
@@ -29772,6 +30389,7 @@ interface operations {
|
|
|
29772
30389
|
Labels?: {
|
|
29773
30390
|
[key: string]: string | null;
|
|
29774
30391
|
} | null;
|
|
30392
|
+
ManualBindings?: (Record<string, never> | null)[] | null;
|
|
29775
30393
|
MergeEnableSubtraction?: boolean | null;
|
|
29776
30394
|
Permissions?: {
|
|
29777
30395
|
[key: string]: Record<string, never> | null;
|
|
@@ -30094,7 +30712,7 @@ interface operations {
|
|
|
30094
30712
|
* An example conjunction is:
|
|
30095
30713
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
30096
30714
|
*
|
|
30097
|
-
* Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt.
|
|
30715
|
+
* Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
|
|
30098
30716
|
*
|
|
30099
30717
|
* The whole string must be query-encoded.
|
|
30100
30718
|
*/
|
|
@@ -32960,8 +33578,6 @@ interface operations {
|
|
|
32960
33578
|
[key: string]: string | null;
|
|
32961
33579
|
} | null;
|
|
32962
33580
|
OtherDataSource?: string | null;
|
|
32963
|
-
/** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
32964
|
-
Params?: Record<string, never> | null;
|
|
32965
33581
|
Permissions?: {
|
|
32966
33582
|
[key: string]: Record<string, never> | null;
|
|
32967
33583
|
} | null;
|
|
@@ -39580,6 +40196,8 @@ interface operations {
|
|
|
39580
40196
|
where_unit?: string;
|
|
39581
40197
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
39582
40198
|
filter_unit?: string;
|
|
40199
|
+
/** @description With from_backing_units, patch a Trigger 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 Trigger is returned as it is. */
|
|
40200
|
+
patch_existing?: boolean;
|
|
39583
40201
|
/** @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. */
|
|
39584
40202
|
dry_run?: boolean;
|
|
39585
40203
|
};
|
|
@@ -39624,8 +40242,6 @@ interface operations {
|
|
|
39624
40242
|
[key: string]: string | null;
|
|
39625
40243
|
} | null;
|
|
39626
40244
|
OtherDataSource?: string | null;
|
|
39627
|
-
/** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
39628
|
-
Params?: Record<string, never> | null;
|
|
39629
40245
|
Permissions?: {
|
|
39630
40246
|
[key: string]: Record<string, never> | null;
|
|
39631
40247
|
} | null;
|
|
@@ -40078,8 +40694,6 @@ interface operations {
|
|
|
40078
40694
|
[key: string]: string | null;
|
|
40079
40695
|
} | null;
|
|
40080
40696
|
OtherDataSource?: string | null;
|
|
40081
|
-
/** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
|
|
40082
|
-
Params?: Record<string, never> | null;
|
|
40083
40697
|
Permissions?: {
|
|
40084
40698
|
[key: string]: Record<string, never> | null;
|
|
40085
40699
|
} | null;
|
|
@@ -40772,7 +41386,7 @@ interface operations {
|
|
|
40772
41386
|
* An example conjunction is:
|
|
40773
41387
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
40774
41388
|
*
|
|
40775
|
-
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
41389
|
+
* Supported attributes for filtering on Link: Annotations, AutoUpdate, BackingUnitID, Bindings, Clearance, CreatedAt, DeleteGates, DisplayName, DownstreamLastMergedRevisionNum, DownstreamPaths, DownstreamSetters, FromUnitID, Guards, Hash, HiddenReason, Labels, LinkID, ManualBindings, MergeEnableSubtraction, OrganizationID, Permissions, Protect, Slug, SpaceID, Squash, Stale, ToSpaceID, ToUnitID, TransformInvocationID, UpdateType, UpdatedAt, UpstreamGetters, UpstreamLastMergedRevisionNum, UpstreamLinkID, UpstreamPaths, UpstreamSpaceID.
|
|
40776
41390
|
*
|
|
40777
41391
|
* Where expression to filter outgoing links (links to units outside the cloned set) for copying. If non-empty, matching outgoing links are also copied with FromUnitID retargeted to the cloned unit.
|
|
40778
41392
|
*
|
|
@@ -43111,7 +43725,7 @@ interface operations {
|
|
|
43111
43725
|
* An example conjunction is:
|
|
43112
43726
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
43113
43727
|
*
|
|
43114
|
-
* Supported attributes for filtering on User: CreatedAt, DisplayName, ExternalID, HiddenReason, Slug, UpdatedAt, UserID, Username.
|
|
43728
|
+
* Supported attributes for filtering on User: CreatedAt, DisplayName, ExternalID, GroupIDs, HiddenReason, Slug, UpdatedAt, UserID, Username.
|
|
43115
43729
|
*
|
|
43116
43730
|
* The whole string must be query-encoded.
|
|
43117
43731
|
*/
|
|
@@ -43148,6 +43762,17 @@ interface operations {
|
|
|
43148
43762
|
* The whole string must be query-encoded.
|
|
43149
43763
|
*/
|
|
43150
43764
|
contains?: string;
|
|
43765
|
+
/**
|
|
43766
|
+
* @description Select clause for specifying which fields to include in the response for User.
|
|
43767
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
43768
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
43769
|
+
* If not specified, all fields are returned.
|
|
43770
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
|
|
43771
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
43772
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43773
|
+
* The whole string must be query-encoded.
|
|
43774
|
+
*/
|
|
43775
|
+
select?: string;
|
|
43151
43776
|
/**
|
|
43152
43777
|
* @description Hidden User entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
43153
43778
|
*
|
|
@@ -43171,7 +43796,7 @@ interface operations {
|
|
|
43171
43796
|
[name: string]: unknown;
|
|
43172
43797
|
};
|
|
43173
43798
|
content: {
|
|
43174
|
-
"application/json": components["schemas"]["
|
|
43799
|
+
"application/json": components["schemas"]["ExtendedUser"][];
|
|
43175
43800
|
};
|
|
43176
43801
|
};
|
|
43177
43802
|
/** @description User request is invalid (Bad Request). */
|
|
@@ -43232,7 +43857,19 @@ interface operations {
|
|
|
43232
43857
|
};
|
|
43233
43858
|
GetUser: {
|
|
43234
43859
|
parameters: {
|
|
43235
|
-
query?:
|
|
43860
|
+
query?: {
|
|
43861
|
+
/**
|
|
43862
|
+
* @description Select clause for specifying which fields to include in the response for User.
|
|
43863
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
43864
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
43865
|
+
* If not specified, all fields are returned.
|
|
43866
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UserID) and Slug are always returned regardless of the select parameter.
|
|
43867
|
+
* Fields used in where and contains filters, and fields named by order_by, are also automatically included.
|
|
43868
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
43869
|
+
* The whole string must be query-encoded.
|
|
43870
|
+
*/
|
|
43871
|
+
select?: string;
|
|
43872
|
+
};
|
|
43236
43873
|
header?: never;
|
|
43237
43874
|
path: {
|
|
43238
43875
|
/** @description Unique identifier for a user_id */
|
|
@@ -43242,13 +43879,13 @@ interface operations {
|
|
|
43242
43879
|
};
|
|
43243
43880
|
requestBody?: never;
|
|
43244
43881
|
responses: {
|
|
43245
|
-
/** @description
|
|
43882
|
+
/** @description OK */
|
|
43246
43883
|
200: {
|
|
43247
43884
|
headers: {
|
|
43248
43885
|
[name: string]: unknown;
|
|
43249
43886
|
};
|
|
43250
43887
|
content: {
|
|
43251
|
-
"application/json": components["schemas"]["
|
|
43888
|
+
"application/json": components["schemas"]["ExtendedUser"];
|
|
43252
43889
|
};
|
|
43253
43890
|
};
|
|
43254
43891
|
/** @description User request is invalid (Bad Request). */
|
|
@@ -43959,6 +44596,8 @@ interface operations {
|
|
|
43959
44596
|
where_unit?: string;
|
|
43960
44597
|
/** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
43961
44598
|
filter_unit?: string;
|
|
44599
|
+
/** @description With from_backing_units, patch a View 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 View is returned as it is. */
|
|
44600
|
+
patch_existing?: boolean;
|
|
43962
44601
|
/** @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. */
|
|
43963
44602
|
dry_run?: boolean;
|
|
43964
44603
|
};
|