@confighub/api 0.8.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.ts CHANGED
@@ -598,10 +598,10 @@ interface paths {
598
598
  cookie?: never;
599
599
  };
600
600
  /**
601
- * List ExtendedGroups
602
- * @description List ExtendedGroups
601
+ * List Groups
602
+ * @description List Groups
603
603
  */
604
- get: operations["ListExtendedGroups"];
604
+ get: operations["ListGroups"];
605
605
  put?: never;
606
606
  post?: never;
607
607
  delete?: never;
@@ -618,10 +618,10 @@ interface paths {
618
618
  cookie?: never;
619
619
  };
620
620
  /**
621
- * Get ExtendedGroup
622
- * @description Get ExtendedGroup
621
+ * Get Group
622
+ * @description Get Group
623
623
  */
624
- get: operations["GetExtendedGroup"];
624
+ get: operations["GetGroup"];
625
625
  put?: never;
626
626
  post?: never;
627
627
  delete?: never;
@@ -630,6 +630,30 @@ interface paths {
630
630
  patch?: never;
631
631
  trace?: never;
632
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
+ };
633
657
  "/info": {
634
658
  parameters: {
635
659
  query?: never;
@@ -3635,7 +3659,7 @@ interface components {
3635
3659
  */
3636
3660
  readonly ClaimToken?: string;
3637
3661
  /** @description Condition represents the worker's readiness state (Ready, NotReady, Unresponsive, Disconnected). */
3638
- Condition?: string;
3662
+ readonly Condition?: string;
3639
3663
  /**
3640
3664
  * Format: date-time
3641
3665
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -3782,7 +3806,8 @@ interface components {
3782
3806
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
3783
3807
  */
3784
3808
  ChangeOrderID?: string;
3785
- ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
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"];
3786
3811
  /**
3787
3812
  * Format: uuid
3788
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.
@@ -3836,8 +3861,12 @@ interface components {
3836
3861
  [key: string]: unknown;
3837
3862
  };
3838
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) */
3839
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) */
3840
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"][];
3841
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. */
3842
3871
  readonly ReleasedRestoredSpaceIDs?: components["schemas"]["UUID"][];
3843
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. */
@@ -3941,13 +3970,27 @@ interface components {
3941
3970
  * The whole string must be query-encoded.
3942
3971
  */
3943
3972
  WhereSpace?: string;
3944
- /** @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. */
3945
3974
  WhereUnit?: string;
3946
3975
  };
3947
3976
  ChangeOrderCreateOrUpdateResponse: {
3948
3977
  ChangeOrder?: components["schemas"]["ChangeOrder"];
3949
3978
  Error?: components["schemas"]["ResponseError"];
3950
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
+ };
3951
3994
  ChangeOrderPromotionFailure: {
3952
3995
  /**
3953
3996
  * Format: date-time
@@ -3955,16 +3998,26 @@ interface components {
3955
3998
  */
3956
3999
  FailedAt?: string;
3957
4000
  Spaces?: components["schemas"]["ChangeOrderPromotionFailureSpace"][];
3958
- TargetStage?: string;
4001
+ Stage?: string;
3959
4002
  /**
3960
4003
  * Format: uuid
3961
4004
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
3962
4005
  */
3963
4006
  UserID?: string;
3964
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
+ };
3965
4017
  ChangeOrderPromotionFailureSpace: {
3966
4018
  Action?: string;
3967
4019
  Error?: string;
4020
+ Links?: components["schemas"]["ChangeOrderPromotionFailureLink"][];
3968
4021
  Reason?: string;
3969
4022
  /**
3970
4023
  * Format: uuid
@@ -3992,6 +4045,7 @@ interface components {
3992
4045
  */
3993
4046
  OverriddenAt?: string;
3994
4047
  Reason?: string;
4048
+ SpaceIDs?: components["schemas"]["UUID"][];
3995
4049
  Stage?: string;
3996
4050
  /**
3997
4051
  * Format: uuid
@@ -4228,10 +4282,15 @@ interface components {
4228
4282
  };
4229
4283
  Column: {
4230
4284
  ColumnSource?: components["schemas"]["ColumnSource"];
4285
+ /** @description The kind of value: MetadataAttribute, MetadataExpression, DataPath or DataExpression. */
4231
4286
  ColumnType?: string;
4287
+ /** @description The expected data type of the column value: string, int, bool, uuid or time. */
4232
4288
  DataType?: string;
4289
+ /** @description Group by this column. Priority is in column list order, after the View's GroupBy. */
4233
4290
  GroupBy?: boolean;
4291
+ /** @description The display name for the column. */
4234
4292
  Name: string;
4293
+ /** @description Sort by this column, ASC or DESC. Priority is in column list order, after the View's OrderBy. */
4235
4294
  OrderByDirection?: string;
4236
4295
  };
4237
4296
  ColumnSource: {
@@ -5008,7 +5067,7 @@ interface components {
5008
5067
  /** @description Supported ToolchainTypes */
5009
5068
  ToolchainTypes?: string[] | null;
5010
5069
  };
5011
- /** @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. */
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. */
5012
5071
  Group: {
5013
5072
  /**
5014
5073
  * Format: date-time
@@ -5172,7 +5231,8 @@ interface components {
5172
5231
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5173
5232
  */
5174
5233
  readonly BackingUnitID?: string;
5175
- Bindings?: components["schemas"]["BindingList"];
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"];
5176
5236
  Clearance?: components["schemas"]["Clearance"];
5177
5237
  /**
5178
5238
  * Format: date-time
@@ -6023,6 +6083,12 @@ interface components {
6023
6083
  * @example 2025-04-04T11:50:02.95102-07:00
6024
6084
  */
6025
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;
6026
6092
  /**
6027
6093
  * Format: int64
6028
6094
  * @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
@@ -6962,10 +7028,6 @@ interface components {
6962
7028
  OrganizationID?: string;
6963
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. */
6964
7030
  OtherDataSource?: string;
6965
- /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
6966
- Params?: {
6967
- [key: string]: unknown;
6968
- };
6969
7031
  Permissions?: components["schemas"]["Permissions"];
6970
7032
  /**
6971
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.
@@ -7031,7 +7093,7 @@ interface components {
7031
7093
  Warn?: boolean;
7032
7094
  /** @description Restricts which resources within a Unit's configuration data the Trigger's function operates on, using ConfigHub metadata path expressions. */
7033
7095
  WhereResource?: string;
7034
- /** @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'`. */
7035
7097
  WhereUnit?: string;
7036
7098
  };
7037
7099
  TriggerCreateOrUpdateResponse: {
@@ -7069,7 +7131,7 @@ interface components {
7069
7131
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7070
7132
  */
7071
7133
  ChangeSetID?: string;
7072
- Conflicts?: components["schemas"]["MutationConflictList"];
7134
+ readonly Conflicts?: components["schemas"]["MutationConflictList"];
7073
7135
  /**
7074
7136
  * Format: date-time
7075
7137
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -7144,7 +7206,8 @@ interface components {
7144
7206
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7145
7207
  */
7146
7208
  OrganizationID?: string;
7147
- PathAnnotations?: components["schemas"]["PathAnnotationList"];
7209
+ /** @description Annotations on locations within the Unit's configuration data, by resource and path. */
7210
+ readonly PathAnnotations?: components["schemas"]["PathAnnotationList"];
7148
7211
  Permissions?: components["schemas"]["Permissions"];
7149
7212
  /** @description Attribute paths that this Unit provides to downstream Units via NeedsProvides Links. Computed from get-provided and stored on data updates. */
7150
7213
  readonly ProvidedPaths?: components["schemas"]["AttributeInfo"][];
@@ -7799,7 +7862,7 @@ interface components {
7799
7862
  readonly EntityType?: string;
7800
7863
  /** @description Unique identifier for the External Identity Provider record matching this User. */
7801
7864
  ExternalID?: string;
7802
- /** @description The Groups the User belongs to, from the identity provider's claims at their last login. (readonly) */
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) */
7803
7866
  GroupIDs?: components["schemas"]["UUID"][];
7804
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. */
7805
7868
  HiddenReason?: string;
@@ -7978,9 +8041,9 @@ interface components {
7978
8041
  };
7979
8042
  WorkerInfo: {
7980
8043
  FunctionWorkerInfo?: components["schemas"]["FunctionWorkerInfo"];
7981
- /** @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. */
7982
8045
  IsServerWorker?: boolean;
7983
- /** @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. */
7984
8047
  UseUserIdentity?: boolean;
7985
8048
  };
7986
8049
  };
@@ -8570,6 +8633,8 @@ interface operations {
8570
8633
  where_unit?: string;
8571
8634
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
8572
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;
8573
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. */
8574
8639
  dry_run?: boolean;
8575
8640
  };
@@ -9809,6 +9874,8 @@ interface operations {
9809
9874
  where_unit?: string;
9810
9875
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
9811
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;
9812
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. */
9813
9880
  dry_run?: boolean;
9814
9881
  };
@@ -10992,7 +11059,6 @@ interface operations {
10992
11059
  Annotations?: {
10993
11060
  [key: string]: string | null;
10994
11061
  } | null;
10995
- Condition?: string | null;
10996
11062
  /** @description An optional set of gates that, if any is present, will block deletion */
10997
11063
  DeleteGates?: {
10998
11064
  [key: string]: boolean | null;
@@ -11458,7 +11524,7 @@ interface operations {
11458
11524
  * An example conjunction is:
11459
11525
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
11460
11526
  *
11461
- * 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.
11462
11528
  *
11463
11529
  * The whole string must be query-encoded.
11464
11530
  */
@@ -11636,7 +11702,7 @@ interface operations {
11636
11702
  * An example conjunction is:
11637
11703
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
11638
11704
  *
11639
- * 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.
11640
11706
  *
11641
11707
  * The whole string must be query-encoded.
11642
11708
  */
@@ -11932,7 +11998,7 @@ interface operations {
11932
11998
  * An example conjunction is:
11933
11999
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
11934
12000
  *
11935
- * 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.
11936
12002
  *
11937
12003
  * The whole string must be query-encoded.
11938
12004
  */
@@ -12128,7 +12194,7 @@ interface operations {
12128
12194
  * An example conjunction is:
12129
12195
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
12130
12196
  *
12131
- * 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.
12132
12198
  *
12133
12199
  * The whole string must be query-encoded.
12134
12200
  */
@@ -13770,6 +13836,8 @@ interface operations {
13770
13836
  where_unit?: string;
13771
13837
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
13772
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;
13773
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. */
13774
13842
  dry_run?: boolean;
13775
13843
  };
@@ -15969,6 +16037,8 @@ interface operations {
15969
16037
  where_unit?: string;
15970
16038
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
15971
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;
15972
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. */
15973
16043
  dry_run?: boolean;
15974
16044
  };
@@ -17079,7 +17149,7 @@ interface operations {
17079
17149
  };
17080
17150
  };
17081
17151
  };
17082
- ListExtendedGroups: {
17152
+ ListGroups: {
17083
17153
  parameters: {
17084
17154
  query?: {
17085
17155
  /**
@@ -17122,6 +17192,20 @@ interface operations {
17122
17192
  * The whole string must be query-encoded.
17123
17193
  */
17124
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;
17125
17209
  /**
17126
17210
  * @description Free text search that approximately matches the specified string against string fields and map keys/values.
17127
17211
  *
@@ -17140,6 +17224,17 @@ interface operations {
17140
17224
  * The whole string must be query-encoded.
17141
17225
  */
17142
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;
17143
17238
  /**
17144
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.
17145
17240
  *
@@ -17166,7 +17261,7 @@ interface operations {
17166
17261
  "application/json": components["schemas"]["ExtendedGroup"][];
17167
17262
  };
17168
17263
  };
17169
- /** @description ExtendedGroup request is invalid (Bad Request). */
17264
+ /** @description Group request is invalid (Bad Request). */
17170
17265
  400: {
17171
17266
  headers: {
17172
17267
  [name: string]: unknown;
@@ -17193,7 +17288,7 @@ interface operations {
17193
17288
  "application/json": components["schemas"]["StandardErrorResponse"];
17194
17289
  };
17195
17290
  };
17196
- /** @description ExtendedGroup not found. */
17291
+ /** @description Group not found. */
17197
17292
  404: {
17198
17293
  headers: {
17199
17294
  [name: string]: unknown;
@@ -17202,7 +17297,7 @@ interface operations {
17202
17297
  "application/json": components["schemas"]["StandardErrorResponse"];
17203
17298
  };
17204
17299
  };
17205
- /** @description Something went wrong while processing ExtendedGroup. */
17300
+ /** @description Something went wrong while processing Group. */
17206
17301
  500: {
17207
17302
  headers: {
17208
17303
  [name: string]: unknown;
@@ -17222,9 +17317,21 @@ interface operations {
17222
17317
  };
17223
17318
  };
17224
17319
  };
17225
- GetExtendedGroup: {
17320
+ GetGroup: {
17226
17321
  parameters: {
17227
- query?: never;
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
+ };
17228
17335
  header?: never;
17229
17336
  path: {
17230
17337
  /** @description Unique identifier for a group_id */
@@ -17243,7 +17350,174 @@ interface operations {
17243
17350
  "application/json": components["schemas"]["ExtendedGroup"];
17244
17351
  };
17245
17352
  };
17246
- /** @description ExtendedGroup request is invalid (Bad Request). */
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. */
17381
+ 404: {
17382
+ headers: {
17383
+ [name: string]: unknown;
17384
+ };
17385
+ content: {
17386
+ "application/json": components["schemas"]["StandardErrorResponse"];
17387
+ };
17388
+ };
17389
+ /** @description Something went wrong while processing Group. */
17390
+ 500: {
17391
+ headers: {
17392
+ [name: string]: unknown;
17393
+ };
17394
+ content: {
17395
+ "application/json": components["schemas"]["StandardErrorResponse"];
17396
+ };
17397
+ };
17398
+ /** @description Unexpected error. */
17399
+ default: {
17400
+ headers: {
17401
+ [name: string]: unknown;
17402
+ };
17403
+ content: {
17404
+ "application/json": components["schemas"]["StandardErrorResponse"];
17405
+ };
17406
+ };
17407
+ };
17408
+ };
17409
+ AddGroupBotUser: {
17410
+ parameters: {
17411
+ query?: never;
17412
+ header?: never;
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
+ };
17419
+ cookie?: never;
17420
+ };
17421
+ requestBody?: never;
17422
+ responses: {
17423
+ /** @description a User in Confighub. */
17424
+ 200: {
17425
+ headers: {
17426
+ [name: string]: unknown;
17427
+ };
17428
+ content: {
17429
+ "application/json": components["schemas"]["User"];
17430
+ };
17431
+ };
17432
+ /** @description Group request is invalid (Bad Request). */
17433
+ 400: {
17434
+ headers: {
17435
+ [name: string]: unknown;
17436
+ };
17437
+ content: {
17438
+ "application/json": components["schemas"]["StandardErrorResponse"];
17439
+ };
17440
+ };
17441
+ /** @description Unauthorized access. */
17442
+ 401: {
17443
+ headers: {
17444
+ [name: string]: unknown;
17445
+ };
17446
+ content: {
17447
+ "application/json": components["schemas"]["StandardErrorResponse"];
17448
+ };
17449
+ };
17450
+ /** @description Forbidden access. */
17451
+ 403: {
17452
+ headers: {
17453
+ [name: string]: unknown;
17454
+ };
17455
+ content: {
17456
+ "application/json": components["schemas"]["StandardErrorResponse"];
17457
+ };
17458
+ };
17459
+ /** @description Group not found. */
17460
+ 404: {
17461
+ headers: {
17462
+ [name: string]: unknown;
17463
+ };
17464
+ content: {
17465
+ "application/json": components["schemas"]["StandardErrorResponse"];
17466
+ };
17467
+ };
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. */
17478
+ 500: {
17479
+ headers: {
17480
+ [name: string]: unknown;
17481
+ };
17482
+ content: {
17483
+ "application/json": components["schemas"]["StandardErrorResponse"];
17484
+ };
17485
+ };
17486
+ /** @description Unexpected error. */
17487
+ default: {
17488
+ headers: {
17489
+ [name: string]: unknown;
17490
+ };
17491
+ content: {
17492
+ "application/json": components["schemas"]["StandardErrorResponse"];
17493
+ };
17494
+ };
17495
+ };
17496
+ };
17497
+ RemoveGroupBotUser: {
17498
+ parameters: {
17499
+ query?: never;
17500
+ header?: never;
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;
17506
+ };
17507
+ cookie?: never;
17508
+ };
17509
+ requestBody?: never;
17510
+ responses: {
17511
+ /** @description a User in Confighub. */
17512
+ 200: {
17513
+ headers: {
17514
+ [name: string]: unknown;
17515
+ };
17516
+ content: {
17517
+ "application/json": components["schemas"]["User"];
17518
+ };
17519
+ };
17520
+ /** @description Group request is invalid (Bad Request). */
17247
17521
  400: {
17248
17522
  headers: {
17249
17523
  [name: string]: unknown;
@@ -17270,7 +17544,7 @@ interface operations {
17270
17544
  "application/json": components["schemas"]["StandardErrorResponse"];
17271
17545
  };
17272
17546
  };
17273
- /** @description ExtendedGroup not found. */
17547
+ /** @description Group not found. */
17274
17548
  404: {
17275
17549
  headers: {
17276
17550
  [name: string]: unknown;
@@ -17279,7 +17553,25 @@ interface operations {
17279
17553
  "application/json": components["schemas"]["StandardErrorResponse"];
17280
17554
  };
17281
17555
  };
17282
- /** @description Something went wrong while processing ExtendedGroup. */
17556
+ /** @description Group is still in use: it has DeleteGates, or other entities still reference it. Or data has changed since last read. */
17557
+ 409: {
17558
+ headers: {
17559
+ [name: string]: unknown;
17560
+ };
17561
+ content: {
17562
+ "application/json": components["schemas"]["StandardErrorResponse"];
17563
+ };
17564
+ };
17565
+ /** @description Group could not be deleted. */
17566
+ 422: {
17567
+ headers: {
17568
+ [name: string]: unknown;
17569
+ };
17570
+ content: {
17571
+ "application/json": components["schemas"]["StandardErrorResponse"];
17572
+ };
17573
+ };
17574
+ /** @description Something went wrong while processing Group. */
17283
17575
  500: {
17284
17576
  headers: {
17285
17577
  [name: string]: unknown;
@@ -17708,6 +18000,8 @@ interface operations {
17708
18000
  where_unit?: string;
17709
18001
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
17710
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;
17711
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. */
17712
18006
  dry_run?: boolean;
17713
18007
  };
@@ -18847,6 +19141,8 @@ interface operations {
18847
19141
  where_unit?: string;
18848
19142
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
18849
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;
18850
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. */
18851
19147
  dry_run?: boolean;
18852
19148
  };
@@ -21067,7 +21363,7 @@ interface operations {
21067
21363
  * An example conjunction is:
21068
21364
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
21069
21365
  *
21070
- * 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.
21071
21367
  *
21072
21368
  * The whole string must be query-encoded.
21073
21369
  */
@@ -24612,7 +24908,6 @@ interface operations {
24612
24908
  Annotations?: {
24613
24909
  [key: string]: string | null;
24614
24910
  } | null;
24615
- Condition?: string | null;
24616
24911
  /** @description An optional set of gates that, if any is present, will block deletion */
24617
24912
  DeleteGates?: {
24618
24913
  [key: string]: boolean | null;
@@ -24948,7 +25243,7 @@ interface operations {
24948
25243
  * An example conjunction is:
24949
25244
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
24950
25245
  *
24951
- * 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.
24952
25247
  *
24953
25248
  * The whole string must be query-encoded.
24954
25249
  */
@@ -30417,7 +30712,7 @@ interface operations {
30417
30712
  * An example conjunction is:
30418
30713
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
30419
30714
  *
30420
- * 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.
30421
30716
  *
30422
30717
  * The whole string must be query-encoded.
30423
30718
  */
@@ -33283,8 +33578,6 @@ interface operations {
33283
33578
  [key: string]: string | null;
33284
33579
  } | null;
33285
33580
  OtherDataSource?: string | null;
33286
- /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
33287
- Params?: Record<string, never> | null;
33288
33581
  Permissions?: {
33289
33582
  [key: string]: Record<string, never> | null;
33290
33583
  } | null;
@@ -39903,6 +40196,8 @@ interface operations {
39903
40196
  where_unit?: string;
39904
40197
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
39905
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;
39906
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. */
39907
40202
  dry_run?: boolean;
39908
40203
  };
@@ -39947,8 +40242,6 @@ interface operations {
39947
40242
  [key: string]: string | null;
39948
40243
  } | null;
39949
40244
  OtherDataSource?: string | null;
39950
- /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
39951
- Params?: Record<string, never> | null;
39952
40245
  Permissions?: {
39953
40246
  [key: string]: Record<string, never> | null;
39954
40247
  } | null;
@@ -40401,8 +40694,6 @@ interface operations {
40401
40694
  [key: string]: string | null;
40402
40695
  } | null;
40403
40696
  OtherDataSource?: string | null;
40404
- /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
40405
- Params?: Record<string, never> | null;
40406
40697
  Permissions?: {
40407
40698
  [key: string]: Record<string, never> | null;
40408
40699
  } | null;
@@ -44305,6 +44596,8 @@ interface operations {
44305
44596
  where_unit?: string;
44306
44597
  /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
44307
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;
44308
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. */
44309
44602
  dry_run?: boolean;
44310
44603
  };