@confighub/api 0.8.7 → 0.8.9

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 CHANGED
@@ -117,7 +117,7 @@ interface paths {
117
117
  put?: never;
118
118
  /**
119
119
  * Bulk create (clone) multiple attributes
120
- * @description Clone multiple attributes selected by query parameters with optional name prefixes and destination spaces
120
+ * @description Clone multiple attributes selected by query parameters to destination spaces. A clone keeps the name of the Attribute it clones
121
121
  */
122
122
  post: operations["BulkCreateAttributes"];
123
123
  /**
@@ -162,8 +162,8 @@ interface paths {
162
162
  cookie?: never;
163
163
  };
164
164
  /**
165
- * List all BridgeWorker across spaces
166
- * @description List all BridgeWorker across spaces
165
+ * List of BridgeWorkers across spaces
166
+ * @description Retrieves a list of BridgeWorkers across spaces in the Organization
167
167
  */
168
168
  get: operations["ListAllBridgeWorkers"];
169
169
  put?: never;
@@ -256,20 +256,20 @@ interface paths {
256
256
  get: operations["ListAllChangeOrders"];
257
257
  put?: never;
258
258
  /**
259
- * Bulk create (clone) multiple changeorders
260
- * @description Clone multiple changeorders selected by query parameters with optional name prefixes and destination spaces
259
+ * Bulk create (clone) multiple change orders
260
+ * @description Clone multiple change orders selected by query parameters with optional name prefixes and destination spaces
261
261
  */
262
262
  post: operations["BulkCreateChangeOrders"];
263
263
  /**
264
- * Bulk delete multiple changeorders
265
- * @description Delete multiple changeorders selected by query parameters
264
+ * Bulk delete multiple change orders
265
+ * @description Delete multiple change orders selected by query parameters
266
266
  */
267
267
  delete: operations["BulkDeleteChangeOrders"];
268
268
  options?: never;
269
269
  head?: never;
270
270
  /**
271
- * Bulk patch multiple changeorders
272
- * @description Apply JSON merge patch to multiple changeorders selected by query parameters
271
+ * Bulk patch multiple change orders
272
+ * @description Apply JSON merge patch to multiple change orders selected by query parameters
273
273
  */
274
274
  patch: operations["BulkPatchChangeOrders"];
275
275
  trace?: never;
@@ -288,20 +288,20 @@ interface paths {
288
288
  get: operations["ListAllChangeSets"];
289
289
  put?: never;
290
290
  /**
291
- * Bulk create (clone) multiple changesets
292
- * @description Clone multiple changesets selected by query parameters with optional name prefixes and destination spaces
291
+ * Bulk create (clone) multiple change sets
292
+ * @description Clone multiple change sets selected by query parameters with optional name prefixes and destination spaces
293
293
  */
294
294
  post: operations["BulkCreateChangeSets"];
295
295
  /**
296
- * Bulk delete multiple changesets
297
- * @description Delete multiple changesets selected by query parameters
296
+ * Bulk delete multiple change sets
297
+ * @description Delete multiple change sets selected by query parameters
298
298
  */
299
299
  delete: operations["BulkDeleteChangeSets"];
300
300
  options?: never;
301
301
  head?: never;
302
302
  /**
303
- * Bulk patch multiple changesets
304
- * @description Apply JSON merge patch to multiple changesets selected by query parameters
303
+ * Bulk patch multiple change sets
304
+ * @description Apply JSON merge patch to multiple change sets selected by query parameters
305
305
  */
306
306
  patch: operations["BulkPatchChangeSets"];
307
307
  trace?: never;
@@ -745,15 +745,15 @@ interface paths {
745
745
  */
746
746
  post: operations["BulkCreateLinks"];
747
747
  /**
748
- * Delete multiple Links
749
- * @description Deletes multiple Links based on search criteria
748
+ * Bulk delete multiple links
749
+ * @description Delete multiple links selected by query parameters
750
750
  */
751
751
  delete: operations["BulkDeleteLinks"];
752
752
  options?: never;
753
753
  head?: never;
754
754
  /**
755
- * Update multiple Links
756
- * @description Updates multiple Links based on search criteria
755
+ * Bulk patch multiple links
756
+ * @description Apply JSON merge patch to multiple links selected by query parameters
757
757
  */
758
758
  patch: operations["BulkPatchLinks"];
759
759
  trace?: never;
@@ -3439,6 +3439,7 @@ interface components {
3439
3439
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
3440
3440
  */
3441
3441
  OrganizationID?: string;
3442
+ /** @description Permissions to access this attestation. */
3442
3443
  Permissions?: components["schemas"]["Permissions"];
3443
3444
  /**
3444
3445
  * Format: uuid
@@ -3602,6 +3603,7 @@ interface components {
3602
3603
  OrganizationID?: string;
3603
3604
  /** @description Parameters specifies the function parameters for the getter and setter functions. */
3604
3605
  Parameters?: components["schemas"]["FunctionParameter"][] | null;
3606
+ /** @description Permissions to access this attribute. */
3605
3607
  Permissions?: components["schemas"]["Permissions"];
3606
3608
  /** @description ResourceTypePaths maps resource types to their path-to-visitor-info mappings. */
3607
3609
  ResourceTypePaths?: components["schemas"]["ResourceTypePathsEntry"][] | null;
@@ -3678,6 +3680,7 @@ interface components {
3678
3680
  AttributeName?: string;
3679
3681
  /** @description Data type if the attribute value. */
3680
3682
  DataType?: string;
3683
+ /** @description Additional attribute details */
3681
3684
  Details?: components["schemas"]["AttributeDetails"];
3682
3685
  /** @description Path of the attribute */
3683
3686
  Path?: string;
@@ -3703,6 +3706,7 @@ interface components {
3703
3706
  Comment?: string;
3704
3707
  /** @description Data type if the attribute value. */
3705
3708
  DataType?: string;
3709
+ /** @description Additional attribute details */
3706
3710
  Details?: components["schemas"]["AttributeDetails"];
3707
3711
  /** @description Name of the function invocation corresponding to the output */
3708
3712
  FunctionName?: string;
@@ -3737,9 +3741,11 @@ interface components {
3737
3741
  Key?: string;
3738
3742
  /** @description Resolved path within the needed resource */
3739
3743
  NeededPath?: string;
3744
+ /** @description Resource in the downstream unit that needs the value */
3740
3745
  NeededResource?: components["schemas"]["ResourceInfo"];
3741
3746
  /** @description Resolved path within the provided resource */
3742
3747
  ProvidedPath?: string;
3748
+ /** @description Resource in the upstream unit that provides the value */
3743
3749
  ProvidedResource?: components["schemas"]["ResourceInfo"];
3744
3750
  };
3745
3751
  BindingList: components["schemas"]["Binding"][];
@@ -3810,7 +3816,15 @@ interface components {
3810
3816
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
3811
3817
  */
3812
3818
  OrganizationID?: string;
3819
+ /** @description Permissions to access this bridge worker. */
3813
3820
  Permissions?: components["schemas"]["Permissions"];
3821
+ /**
3822
+ * @description ProvidedInfo contains information about the bridge worker in JSON format.
3823
+ * It is sent by the bridge worker program to the ConfigHub server when it first connects.
3824
+ * It can also be set before the bridge worker connects, but it is not recommended to change
3825
+ * it while a worker is connected.
3826
+ * This can include details about the capabilities, and targets supported by the bridge worker.
3827
+ */
3814
3828
  ProvidedInfo?: components["schemas"]["WorkerInfo"];
3815
3829
  /**
3816
3830
  * @description Secret is a unique secret token for the bridge worker.
@@ -3926,6 +3940,8 @@ interface components {
3926
3940
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
3927
3941
  */
3928
3942
  ChangeWorkflowID?: string;
3943
+ /** @description ContainerImages lists, for each Space the ChangeOrder has landed in, the container images it changed there: in each Unit the end Tag marks, the images get-container-image finds that differ from those at the Revision the start Tag marks. Derived only when a single ChangeOrder is read with container_images=true, never in a list. Spaces and Units the reader cannot view are left out. */
3944
+ readonly ContainerImages?: components["schemas"]["ChangeOrderSpaceContainerImages"][];
3929
3945
  /**
3930
3946
  * Format: date-time
3931
3947
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -3972,6 +3988,7 @@ interface components {
3972
3988
  Parameters?: {
3973
3989
  [key: string]: unknown;
3974
3990
  };
3991
+ /** @description Permissions to access this change order. */
3975
3992
  Permissions?: components["schemas"]["Permissions"];
3976
3993
  /** @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) */
3977
3994
  readonly PromotionFailures?: components["schemas"]["ChangeOrderPromotionFailure"][];
@@ -4087,6 +4104,36 @@ interface components {
4087
4104
  /** @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. */
4088
4105
  WhereUnit?: string;
4089
4106
  };
4107
+ ChangeOrderContainerImageChange: {
4108
+ /** @description The image before the change; absent for a container the change added. */
4109
+ FromImage?: string;
4110
+ /**
4111
+ * Format: int64
4112
+ * @description The Revision the start Tag marks; absent for a Unit the change added.
4113
+ */
4114
+ FromRevisionNum?: number;
4115
+ /** @description The path of the image within the resource. */
4116
+ Path?: string;
4117
+ /** @description The name of the resource the container is in, as it is at the end Tag's Revision. */
4118
+ ResourceName?: string;
4119
+ /** @description The type of the resource the container is in. */
4120
+ ResourceType?: string;
4121
+ /** @description The image after the change; absent for a container the change removed. */
4122
+ ToImage?: string;
4123
+ /**
4124
+ * Format: int64
4125
+ * @description The Revision the end Tag marks.
4126
+ */
4127
+ ToRevisionNum?: number;
4128
+ /**
4129
+ * Format: uuid
4130
+ * @description The Unit the image is in.
4131
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4132
+ */
4133
+ UnitID?: string;
4134
+ /** @description The Unit's slug. */
4135
+ UnitSlug?: string;
4136
+ };
4090
4137
  ChangeOrderCreateOrUpdateResponse: {
4091
4138
  ChangeOrder?: components["schemas"]["ChangeOrder"];
4092
4139
  Error?: components["schemas"]["ResponseError"];
@@ -4186,6 +4233,18 @@ interface components {
4186
4233
  */
4187
4234
  SpaceID?: string;
4188
4235
  };
4236
+ ChangeOrderSpaceContainerImages: {
4237
+ /** @description The images that changed, by Unit, resource, and path. */
4238
+ Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
4239
+ /**
4240
+ * Format: uuid
4241
+ * @description The Space the images changed in.
4242
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4243
+ */
4244
+ SpaceID?: string;
4245
+ /** @description The Space's slug. */
4246
+ SpaceSlug?: string;
4247
+ };
4189
4248
  /** @description Defines an entity changeset. */
4190
4249
  ChangeSet: {
4191
4250
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -4232,6 +4291,7 @@ interface components {
4232
4291
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4233
4292
  */
4234
4293
  OrganizationID?: string;
4294
+ /** @description Permissions to access this change set. */
4235
4295
  Permissions?: components["schemas"]["Permissions"];
4236
4296
  /** @description Unique URL-safe identifier for the entity. */
4237
4297
  Slug: string;
@@ -4304,6 +4364,7 @@ interface components {
4304
4364
  DisplayName?: string;
4305
4365
  /** @description The type of entity. */
4306
4366
  readonly EntityType?: string;
4367
+ /** @description Final is what the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
4307
4368
  Final?: components["schemas"]["ChangeWorkflowFinalStage"];
4308
4369
  /** @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. */
4309
4370
  HiddenReason?: string;
@@ -4317,6 +4378,7 @@ interface components {
4317
4378
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4318
4379
  */
4319
4380
  OrganizationID?: string;
4381
+ /** @description Permissions to access this change workflow. */
4320
4382
  Permissions?: components["schemas"]["Permissions"];
4321
4383
  /** @description Unique URL-safe identifier for the entity. */
4322
4384
  Slug: string;
@@ -4390,6 +4452,7 @@ interface components {
4390
4452
  AttestationPrerequisites?: components["schemas"]["ChangeWorkflowAttestationPrerequisite"][];
4391
4453
  /** @description The checks a stage or Final may gate on beyond the built-in ones. Declared once and named wherever they apply. */
4392
4454
  CustomPrerequisites?: components["schemas"]["ChangeWorkflowPrerequisite"][];
4455
+ /** @description What the last stage must satisfy for the rollout to read as completed. Nothing is promoted into it: a stage's prerequisites gate entry to the stage after it, so the last stage's gate nothing. */
4393
4456
  Final?: components["schemas"]["ChangeWorkflowFinalStage"];
4394
4457
  /** @description The stages a change is promoted through, in order. Ordered between stages and unordered within one. At least one is required. */
4395
4458
  Stages: components["schemas"]["ChangeWorkflowStage"][];
@@ -4414,6 +4477,7 @@ interface components {
4414
4477
  Values?: string[];
4415
4478
  };
4416
4479
  Column: {
4480
+ /** @description Where the column value comes from. Exactly one field should be set, matching ColumnType. */
4417
4481
  ColumnSource?: components["schemas"]["ColumnSource"];
4418
4482
  /** @description The kind of value: MetadataAttribute, MetadataExpression, DataPath or DataExpression. */
4419
4483
  ColumnType?: string;
@@ -4479,6 +4543,7 @@ interface components {
4479
4543
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4480
4544
  */
4481
4545
  OrganizationID?: string;
4546
+ /** @description Permissions to access this component. */
4482
4547
  Permissions?: components["schemas"]["Permissions"];
4483
4548
  /** @description Unique URL-safe identifier for the entity. */
4484
4549
  Slug: string;
@@ -4513,6 +4578,7 @@ interface components {
4513
4578
  };
4514
4579
  /** @description Response for successful delete operation */
4515
4580
  DeleteResponse: {
4581
+ /** @description Error information if the delete operation failed. */
4516
4582
  Error?: components["schemas"]["ResponseError"];
4517
4583
  /** @description Response message. */
4518
4584
  Message?: string;
@@ -4577,6 +4643,7 @@ interface components {
4577
4643
  DemoteUnitResult: {
4578
4644
  /** @description Restore, Mark, or Unchanged. */
4579
4645
  Action?: string;
4646
+ /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
4580
4647
  Diff?: components["schemas"]["ConfigDiff"];
4581
4648
  /**
4582
4649
  * Format: int64
@@ -4594,6 +4661,7 @@ interface components {
4594
4661
  */
4595
4662
  EndRevisionNum?: number;
4596
4663
  Error?: components["schemas"]["ResponseError"];
4664
+ /** @description What the restore changed, or on a dry run would change. Returned when include names Mutations. */
4597
4665
  Mutations?: components["schemas"]["ResourceMutationList"];
4598
4666
  /** Format: int64 */
4599
4667
  PreviousHeadMutationNum?: number;
@@ -4614,12 +4682,17 @@ interface components {
4614
4682
  UnitID?: string;
4615
4683
  };
4616
4684
  DiffRequest: {
4685
+ /** @description The configuration the diff runs from */
4617
4686
  From?: components["schemas"]["DiffSide"];
4687
+ /** @description The configuration the diff runs to */
4618
4688
  To?: components["schemas"]["DiffSide"];
4619
4689
  };
4620
4690
  DiffResult: {
4691
+ /** @description What changed from the From configuration to the To configuration */
4621
4692
  Diff?: components["schemas"]["ConfigDiff"];
4693
+ /** @description What the From side resolved to */
4622
4694
  From?: components["schemas"]["DiffSideResult"];
4695
+ /** @description What the To side resolved to */
4623
4696
  To?: components["schemas"]["DiffSideResult"];
4624
4697
  };
4625
4698
  DiffSide: {
@@ -4693,8 +4766,10 @@ interface components {
4693
4766
  };
4694
4767
  /** @description Attestation with additional related entities expanded based on the request's include parameter. */
4695
4768
  ExtendedAttestation: {
4769
+ /** @description The Attestation. */
4696
4770
  Attestation?: components["schemas"]["Attestation"];
4697
4771
  Organization?: components["schemas"]["Organization"];
4772
+ /** @description The Space the Attestation belongs to. */
4698
4773
  Space?: components["schemas"]["Space"];
4699
4774
  };
4700
4775
  ExtendedAttribute: {
@@ -4750,6 +4825,7 @@ interface components {
4750
4825
  /** @description Group with additional related entities expanded based on the request's include parameter. */
4751
4826
  ExtendedGroup: {
4752
4827
  Error?: components["schemas"]["ResponseError"];
4828
+ /** @description The Group. */
4753
4829
  Group?: components["schemas"]["Group"];
4754
4830
  };
4755
4831
  ExtendedInvocation: {
@@ -4792,8 +4868,11 @@ interface components {
4792
4868
  /** @description Release with additional related entities expanded based on the request's include parameter. */
4793
4869
  ExtendedRelease: {
4794
4870
  Organization?: components["schemas"]["Organization"];
4871
+ /** @description The Release. */
4795
4872
  Release?: components["schemas"]["Release"];
4873
+ /** @description The Space the Release belongs to. */
4796
4874
  Space?: components["schemas"]["Space"];
4875
+ /** @description The Tag the bundled Units were pinned to, if any. Expanded when requested via the include parameter. */
4797
4876
  Tag?: components["schemas"]["Tag"];
4798
4877
  };
4799
4878
  ExtendedResource: {
@@ -4911,15 +4990,25 @@ interface components {
4911
4990
  ChangeSet?: components["schemas"]["ChangeSet"];
4912
4991
  Error?: components["schemas"]["ResponseError"];
4913
4992
  FromLink?: components["schemas"]["Link"][];
4993
+ /** @description The Unit's current HeadMutation */
4914
4994
  HeadMutation?: components["schemas"]["Mutation"];
4995
+ /** @description The Unit's current HeadRevision */
4915
4996
  HeadRevision?: components["schemas"]["Revision"];
4997
+ /** @description The Unit's current LastReleasedRevision */
4916
4998
  LastReleasedRevision?: components["schemas"]["Revision"];
4999
+ /** @description The latest event that took place on the Unit. */
4917
5000
  LatestUnitEvent?: components["schemas"]["UnitEvent"];
5001
+ /** @description The Organization the Unit belongs to. */
4918
5002
  Organization?: components["schemas"]["Organization"];
5003
+ /** @description The Space the Unit belongs to. */
4919
5004
  Space?: components["schemas"]["Space"];
5005
+ /** @description The Target the Unit has been configured to operate with. */
4920
5006
  Target?: components["schemas"]["Target"];
5007
+ /** @description The requested Unit of the operation. */
4921
5008
  Unit?: components["schemas"]["Unit"];
5009
+ /** @description If this Unit is a clone, the Upstream Space the UpstreamUnit belongs to. Optional. */
4922
5010
  UpstreamSpace?: components["schemas"]["Space"];
5011
+ /** @description If this Unit is a clone, the Upstream Unit it was cloned from. Optional. */
4923
5012
  UpstreamUnit?: components["schemas"]["Unit"];
4924
5013
  View?: components["schemas"]["View"];
4925
5014
  ViewColumns?: components["schemas"]["ViewColumn"][];
@@ -4989,6 +5078,7 @@ interface components {
4989
5078
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4990
5079
  */
4991
5080
  OrganizationID?: string;
5081
+ /** @description Permissions to access this filter. */
4992
5082
  Permissions?: components["schemas"]["Permissions"];
4993
5083
  /** @description Resource type to match for the desired ToolchainType, for example apps/v1/Deployment. Valid only for Units. (optional) */
4994
5084
  ResourceType?: string;
@@ -5035,9 +5125,11 @@ interface components {
5035
5125
  FunctionInvocation: {
5036
5126
  /** @description Function arguments */
5037
5127
  Arguments?: components["schemas"]["FunctionArgument"][] | null;
5128
+ /** @description Classes of guarded reason this invocation is cleared for; combined by union with the clearance of whatever drove the execution */
5038
5129
  Clearance?: components["schemas"]["Clearance"];
5039
5130
  /** @description Function name */
5040
5131
  FunctionName?: string;
5132
+ /** @description Guards to record on the paths this invocation writes, so a later operation must be cleared for them; combined with the guards of whatever drove the execution, later winning per key */
5041
5133
  Guards?: components["schemas"]["GuardStamp"];
5042
5134
  /** @description Caller-supplied parameter values for expanding templated argument Values; transient, not persisted */
5043
5135
  Params?: {
@@ -5084,13 +5176,17 @@ interface components {
5084
5176
  FunctionInvocationsResponse: {
5085
5177
  /** @description The resulting configuration data; present only when the invocation changed it */
5086
5178
  ConfigData?: string;
5179
+ /** @description Mutation conflicts produced by writing the invocation's result, such as a path a guard withheld. Empty when nothing was withheld. */
5087
5180
  Conflicts?: components["schemas"]["MutationConflictList"];
5088
5181
  /** @description SHA256 of the resulting configuration data, whether or not ConfigData is present */
5089
5182
  DataHash?: string;
5183
+ /** @description What the invocation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */
5090
5184
  Diff?: components["schemas"]["ConfigDiff"];
5185
+ /** @description Error information if the function invocation failed */
5091
5186
  Error?: components["schemas"]["ResponseError"];
5092
5187
  /** @description Functions produced new mutations (of type other than None) */
5093
5188
  HasNewMutations?: boolean;
5189
+ /** @description List of mutations in the same order as the resources in ConfigData */
5094
5190
  Mutations?: components["schemas"]["ResourceMutationList"];
5095
5191
  /** @description List of function invocation indices that resulted in mutations */
5096
5192
  Mutators?: number[] | null;
@@ -5142,6 +5238,7 @@ interface components {
5142
5238
  OutputType?: string;
5143
5239
  /** @description Name of the result in kabob-case */
5144
5240
  ResultName?: string;
5241
+ /** @description JSON schema of the output type */
5145
5242
  Schema?: components["schemas"]["Schema"];
5146
5243
  };
5147
5244
  FunctionParameter: {
@@ -5163,6 +5260,7 @@ interface components {
5163
5260
  Regexp?: string;
5164
5261
  /** @description Whether the parameter is required */
5165
5262
  Required?: boolean;
5263
+ /** @description JSON schema (for embedded JSON values) */
5166
5264
  Schema?: components["schemas"]["Schema"];
5167
5265
  };
5168
5266
  FunctionSignature: {
@@ -5184,6 +5282,7 @@ interface components {
5184
5282
  Mutating?: boolean;
5185
5283
  /** @description If non-empty, specification of what source(s) are expected in OtherData; if empty, OtherData is not used */
5186
5284
  OtherDataExpected?: string[];
5285
+ /** @description Output description */
5187
5286
  OutputInfo?: components["schemas"]["FunctionOutput"];
5188
5287
  /** @description Function parameters, in order */
5189
5288
  Parameters?: components["schemas"]["FunctionParameter"][] | null;
@@ -5310,6 +5409,7 @@ interface components {
5310
5409
  */
5311
5410
  OrganizationID?: string;
5312
5411
  Parameters?: components["schemas"]["FunctionParameter"][];
5412
+ /** @description Permissions to access this invocation. */
5313
5413
  Permissions?: components["schemas"]["Permissions"];
5314
5414
  /** @description Unique URL-safe identifier for the entity. */
5315
5415
  Slug: string;
@@ -5404,6 +5504,7 @@ interface components {
5404
5504
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5405
5505
  */
5406
5506
  FromUnitID: string;
5507
+ /** @description Guards to record on the paths this link's resolve writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Refused on UpgradeUnit and MergeUnits links, whose guards arrive by propagation from upstream. */
5407
5508
  Guards?: components["schemas"]["GuardStamp"];
5408
5509
  /** @description SHA256 hash of the resolution-relevant Link fields, used to detect changes that require re-resolution. */
5409
5510
  readonly Hash?: string;
@@ -5419,6 +5520,7 @@ interface components {
5419
5520
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5420
5521
  */
5421
5522
  LinkID?: string;
5523
+ /** @description The needs/provides attribute bindings stated for this Link, which resolution uses as they are. Each Binding maps one needed attribute in the downstream Unit to one provided attribute in the upstream Unit. An Insert Link has exactly one, which identifies only the needed attribute (NeededResource and NeededPath) and whose DataType selects how the upstream Unit is inserted: string, the default, inserts it verbatim as text; the downstream Unit's own configuration format inserts it as configuration data. */
5422
5524
  ManualBindings?: components["schemas"]["BindingList"];
5423
5525
  /** @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. */
5424
5526
  MergeEnableSubtraction?: boolean;
@@ -5428,6 +5530,7 @@ interface components {
5428
5530
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5429
5531
  */
5430
5532
  OrganizationID?: string;
5533
+ /** @description Permissions to access this link. */
5431
5534
  Permissions?: components["schemas"]["Permissions"];
5432
5535
  /** @description Records the paths this Link's resolve writes as protected local overrides, so a later merge from upstream does not overwrite them. Without it the resolve claims nothing, as any other change does. Refused on UpgradeUnit and MergeUnits Links, where the upstream keeps updating what it delivered and protecting that content would freeze the downstream one merge in. */
5433
5536
  Protect?: boolean;
@@ -5544,6 +5647,7 @@ interface components {
5544
5647
  readonly CreatedAt?: string;
5545
5648
  /** @description The type of entity. */
5546
5649
  readonly EntityType?: string;
5650
+ /** @description The function invoked if the change was made by a function. */
5547
5651
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
5548
5652
  /** @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. */
5549
5653
  HiddenReason?: string;
@@ -5597,6 +5701,7 @@ interface components {
5597
5701
  OrganizationID?: string;
5598
5702
  /** @description ProvidedPath is the path of the provided value used to satisfy a needed value if the change was made due to resolving a link. */
5599
5703
  ProvidedPath?: string;
5704
+ /** @description ProvidedResource contains the type and name of the resource which provided a value used to satisfy a needed value if the change was made due to resolving a link. */
5600
5705
  ProvidedResource?: components["schemas"]["ResourceInfoType2"];
5601
5706
  ReplayOutcome?: string;
5602
5707
  ReplayReason?: string;
@@ -5660,14 +5765,19 @@ interface components {
5660
5765
  MutationConflict: {
5661
5766
  /** @description Explanation the Reason alone cannot carry, such as the error text of a failed replay */
5662
5767
  Details?: string;
5768
+ /** @description For Guarded: the guard the operation's clearance did not cover */
5663
5769
  Guard?: components["schemas"]["WithheldGuard"];
5770
+ /** @description For GuardWithheld: the guard change that did not propagate */
5664
5771
  GuardChange?: components["schemas"]["GuardDelta"];
5665
5772
  /** @description Path of the mutation; empty for resource-level conflicts */
5666
5773
  Path?: string;
5667
5774
  /** @description Why the mutation was dropped */
5668
5775
  Reason?: string;
5776
+ /** @description Resource the mutation applied to */
5669
5777
  Resource?: components["schemas"]["ResourceInfo"];
5778
+ /** @description The dropped source-side mutation */
5670
5779
  Source?: components["schemas"]["MutationInfo"];
5780
+ /** @description The target-side mutation that caused the drop, when applicable (Subtracted, DeleteShadowed) */
5671
5781
  Target?: components["schemas"]["MutationInfo"];
5672
5782
  /**
5673
5783
  * Format: uuid
@@ -5683,6 +5793,7 @@ interface components {
5683
5793
  * @description Function index or sequence number corresponding to the change
5684
5794
  */
5685
5795
  Index?: number;
5796
+ /** @description Type of mutation performed on the associated configuration element: Add, Update, Replace, Delete, or None, if no change */
5686
5797
  MutationType?: components["schemas"]["MutationType"];
5687
5798
  /** @description Line-level patch for multi-line string updates, in unified diff format. When present on an Update, PatchMutations applies this to the target value instead of replacing with Value. Falls back to Value if the patch cannot be applied cleanly. */
5688
5799
  Patch?: string;
@@ -5695,11 +5806,13 @@ interface components {
5695
5806
  [key: string]: components["schemas"]["MutationInfo"];
5696
5807
  };
5697
5808
  MutationSourcesResponse: {
5809
+ /** @description Sources of mutations affecting the configuration data, by resource and path. */
5698
5810
  MutationSources?: components["schemas"]["ResourceMutationList"];
5699
5811
  };
5700
5812
  /** @enum {string} */
5701
5813
  MutationType: MutationType;
5702
5814
  NamedFunctionResult: {
5815
+ /** @description Non-mutating function invocation that produces OutputTypeAttributeValueList. The Value of the first returned AttributeValue is bound to Name. Worker functions are not supported. */
5703
5816
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
5704
5817
  /** @description Identifier used to reference the value; must be a legal Go and CEL identifier and unique across UpstreamPaths and UpstreamGetters */
5705
5818
  Name?: string;
@@ -5709,6 +5822,7 @@ interface components {
5709
5822
  Name?: string;
5710
5823
  /** @description Resolved path within Resource to read via get-paths */
5711
5824
  Path?: string;
5825
+ /** @description Resource in the upstream Unit that contains Path */
5712
5826
  Resource?: components["schemas"]["ResourceInfo"];
5713
5827
  };
5714
5828
  /** @description A per-app OAuth public client used by a browser app to authenticate against the ConfigHub API. */
@@ -5802,6 +5916,7 @@ interface components {
5802
5916
  Username?: string;
5803
5917
  };
5804
5918
  ParameterizedFunction: {
5919
+ /** @description Mutating function invocation to run on the downstream Unit. Worker functions are not supported. */
5805
5920
  FunctionInvocation?: components["schemas"]["FunctionInvocation"];
5806
5921
  /** @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. */
5807
5922
  Key?: string;
@@ -5825,6 +5940,7 @@ interface components {
5825
5940
  };
5826
5941
  };
5827
5942
  PathChange: {
5943
+ /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
5828
5944
  Attribution?: components["schemas"]["MutationInfo"];
5829
5945
  /** @description Add, Delete, Update, Replace, Reorder, or Rename */
5830
5946
  ChangeType?: string;
@@ -5854,6 +5970,7 @@ interface components {
5854
5970
  Parameters?: string[];
5855
5971
  /** @description Unresolved path within Resource to write via set-attributes */
5856
5972
  Path?: string;
5973
+ /** @description Resource in the downstream Unit that contains Path. Reserved as a pointer for a future optional/WhereResource form; required for now. */
5857
5974
  Resource?: components["schemas"]["ResourceInfo"];
5858
5975
  };
5859
5976
  PathSegment: {
@@ -5874,6 +5991,7 @@ interface components {
5874
5991
  AttributeName?: string;
5875
5992
  /** @description DataType of the attribute at the path */
5876
5993
  DataType?: string;
5994
+ /** @description Additional attribute details */
5877
5995
  Details?: components["schemas"]["AttributeDetails"];
5878
5996
  /** @description Configuration of the embedded accessor, if any */
5879
5997
  EmbeddedAccessorConfig?: string;
@@ -5940,6 +6058,7 @@ interface components {
5940
6058
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
5941
6059
  */
5942
6060
  ChangeSetID?: string;
6061
+ /** @description The guarded reasons the writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
5943
6062
  Clearance?: components["schemas"]["Clearance"];
5944
6063
  /** @description Plan the promotion, evaluate its gates, and return the same response without writing anything. */
5945
6064
  DryRun?: boolean;
@@ -5949,6 +6068,7 @@ interface components {
5949
6068
  Force?: boolean;
5950
6069
  /** @description Why the gates were overridden. Required with Force. */
5951
6070
  ForceReason?: string;
6071
+ /** @description Reasons to record on the paths each Unit write changes. A later operation must be cleared for them before overwriting those paths. Clearance must cover them, since a write is withheld by guards it is not cleared for, its own included. */
5952
6072
  Guards?: components["schemas"]["GuardStamp"];
5953
6073
  /**
5954
6074
  * @description With a ChangeOrder, what to do for a Unit whose last merged upstream Revision is before the ChangeOrder's start there -- typically because a Link in the upstream Space, such as a TransformPaths Link, wrote Revisions after the Unit last merged. Include (the default) merges those Revisions first, as Revisions of their own that do not carry the ChangeOrder, and then the ChangeOrder's range; Skip merges only the ChangeOrder's range, as though the Unit had already merged as far as its start; Error refuses, naming the Revisions. A Unit that has merged past the ChangeOrder's start is an error whatever this says. Refused with an Insert, Upsert, or TransformPaths ChangeOrder, whose Links read their sources as they are at its end rather than merging a range.
@@ -6032,13 +6152,18 @@ interface components {
6032
6152
  PromoteUnitResult: {
6033
6153
  /** @description Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip. */
6034
6154
  Action?: string;
6155
+ /** @description The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes. */
6156
+ ConfigData?: string;
6157
+ /** @description Paths withheld because they were overridden locally or guarded. */
6035
6158
  Conflicts?: components["schemas"]["MutationConflictList"];
6159
+ /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
6036
6160
  Diff?: components["schemas"]["ConfigDiff"];
6037
6161
  Error?: components["schemas"]["ResponseError"];
6038
6162
  /** Format: int64 */
6039
6163
  HeadRevisionNum?: number;
6040
6164
  /** @description For a Resolve, and a Mark made by one, the Links resolved. */
6041
6165
  LinkIDs?: components["schemas"]["UUID"][];
6166
+ /** @description What the write changed, or on a dry run would change: the entries of the Unit's MutationSources it produced. Returned when include names Mutations. */
6042
6167
  Mutations?: components["schemas"]["ResourceMutationList"];
6043
6168
  /** Format: int64 */
6044
6169
  PreviousHeadMutationNum?: number;
@@ -6062,6 +6187,7 @@ interface components {
6062
6187
  };
6063
6188
  /** @description UnitAction is a record of an operation queued for a Worker, such as a function invocation on a unit. Operations are delivered to the worker in creation order; if the worker is disconnected, pending operations are delivered when it reconnects. One or more UnitEvents will correspond to each UnitAction. */
6064
6189
  QueuedOperation: {
6190
+ /** @description Action is the type of action to be performed by the bridge worker. */
6065
6191
  Action?: components["schemas"]["ActionType"];
6066
6192
  /**
6067
6193
  * Format: uuid
@@ -6188,6 +6314,7 @@ interface components {
6188
6314
  Labels?: {
6189
6315
  [key: string]: string;
6190
6316
  };
6317
+ /** @description What the tool deploying the Release, such as argobot for Argo CD, reports about it running. Absent until a tool reports. Written by that tool: EditChildren on the Release's Target grants Edit on the Release. */
6191
6318
  LiveStatus?: components["schemas"]["ReleaseLiveStatus"];
6192
6319
  /** @description OCI digest (sha256:...) of the Release's OCI image manifest. */
6193
6320
  readonly ManifestDigest?: string;
@@ -6196,6 +6323,7 @@ interface components {
6196
6323
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6197
6324
  */
6198
6325
  OrganizationID?: string;
6326
+ /** @description Permissions to access this release. */
6199
6327
  Permissions?: components["schemas"]["Permissions"];
6200
6328
  /** @description Whether the Release is currently served to its consuming Target. Set when the Release is published and cleared when it is withdrawn; a withdrawn Release is retained until deleted. */
6201
6329
  readonly Published?: boolean;
@@ -6307,6 +6435,7 @@ interface components {
6307
6435
  Labels?: {
6308
6436
  [key: string]: string;
6309
6437
  };
6438
+ /** @description Optional Permissions to access the Release. Its publisher is granted Manage in addition. */
6310
6439
  Permissions?: components["schemas"]["Permissions"];
6311
6440
  /**
6312
6441
  * Format: uuid
@@ -6318,6 +6447,7 @@ interface components {
6318
6447
  ReleasePublishResponse: {
6319
6448
  /** @description Set when nothing changed since the latest published Release, so no Release was created. */
6320
6449
  Message?: string;
6450
+ /** @description The published Release, or the latest published Release when no Release was created. */
6321
6451
  Release?: components["schemas"]["Release"];
6322
6452
  };
6323
6453
  /** @description Resource is a configuration element extracted from a Unit's configuration data. Resources are maintained automatically as Units change and are read-only. */
@@ -6392,13 +6522,17 @@ interface components {
6392
6522
  Version?: number;
6393
6523
  };
6394
6524
  ResourceDiff: {
6525
+ /** @description For an Add, the To side's MutationSources entry for the resource, which says what added it; returned when include names Attribution */
6395
6526
  Attribution?: components["schemas"]["MutationInfo"];
6527
+ /** @description Add, Delete, Update, or None when the resource is unchanged */
6396
6528
  ChangeType?: components["schemas"]["MutationType"];
6397
6529
  /** @description Changes within the resource, for an Update, in document order */
6398
6530
  Changes?: components["schemas"]["PathChange"][];
6399
6531
  /** @description The whole resource, for a Delete */
6400
6532
  FromValue?: string;
6533
+ /** @description The resource on the From side, when it was matched across a rename */
6401
6534
  PreviousResource?: components["schemas"]["ResourceInfo"];
6535
+ /** @description Identifies the resource on the To side, or on the From side if it was deleted */
6402
6536
  Resource?: components["schemas"]["ResourceInfo"];
6403
6537
  /** @description The whole resource, for an Add */
6404
6538
  ToValue?: string;
@@ -6408,6 +6542,7 @@ interface components {
6408
6542
  Remove?: {
6409
6543
  [key: string]: string[];
6410
6544
  };
6545
+ /** @description Identifies the resource within the Unit whose guards are being edited */
6411
6546
  Resource?: components["schemas"]["ResourceInfo"];
6412
6547
  /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole */
6413
6548
  Set?: {
@@ -6447,10 +6582,15 @@ interface components {
6447
6582
  AliasesWithoutScopes?: {
6448
6583
  [key: string]: Record<string, never>;
6449
6584
  };
6585
+ /** @description For merge-keyed arrays in which an element was renamed (its merge-key value changed): the array parent path mapped to a previous-merge-key -> new-merge-key map. PatchMutations rewrites the matched element's merge-key field accordingly so child paths and ArrayOrders entries resolve under the new key. */
6450
6586
  ArrayElementAliases?: components["schemas"]["ArrayElementAliasMap"];
6587
+ /** @description For merge-keyed arrays whose element set or order changed in this mutation: the desired sequence of merge-key values in source order, keyed by the array's parent path. PatchMutations applies this as a reorder pass after path mutations so positional associative arrays (e.g., Kubernetes initContainers, env, ports) preserve source-side ordering rather than landing append-on-clash. */
6451
6588
  ArrayOrders?: components["schemas"]["ArrayOrderMap"];
6589
+ /** @description Path-level mutation information; more deeply nested paths override values represented at higher levels */
6452
6590
  PathMutationMap?: components["schemas"]["MutationMap"];
6591
+ /** @description Identifiers of the resource to which the mutations correspond */
6453
6592
  Resource?: components["schemas"]["ResourceInfo"];
6593
+ /** @description Resource-level mutation information, such as for Add, Delete, or Replace */
6454
6594
  ResourceMutationInfo?: components["schemas"]["MutationInfo"];
6455
6595
  };
6456
6596
  ResourceMutationList: components["schemas"]["ResourceMutation"][];
@@ -6467,7 +6607,9 @@ interface components {
6467
6607
  PathAnnotationMap?: {
6468
6608
  [key: string]: components["schemas"]["PathAnnotations"];
6469
6609
  };
6610
+ /** @description Identifiers of the resource whose paths are annotated */
6470
6611
  Resource?: components["schemas"]["ResourceInfo"];
6612
+ /** @description Annotations on the resource as a whole, inherited by paths with no more specific entry */
6471
6613
  ResourceAnnotations?: components["schemas"]["PathAnnotations"];
6472
6614
  };
6473
6615
  ResourceProtection: {
@@ -6475,6 +6617,7 @@ interface components {
6475
6617
  Protected?: {
6476
6618
  [key: string]: boolean;
6477
6619
  } | null;
6620
+ /** @description Identifies the resource within the unit whose path protection is being set */
6478
6621
  Resource?: components["schemas"]["ResourceInfo"];
6479
6622
  };
6480
6623
  ResourceTypePathsEntry: {
@@ -6512,6 +6655,7 @@ interface components {
6512
6655
  Details?: string[];
6513
6656
  /** @description The type of error (e.g., validation, not-found) */
6514
6657
  ErrorCategory?: string;
6658
+ /** @description Structured error details like field violations */
6515
6659
  ErrorMetadata?: components["schemas"]["ErrorMetadata"];
6516
6660
  /** @description The primary error message */
6517
6661
  Message?: string;
@@ -6546,6 +6690,7 @@ interface components {
6546
6690
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6547
6691
  */
6548
6692
  ReplyToID?: string;
6693
+ /** @description Resource to which the remark is attached; optional */
6549
6694
  Resource?: components["schemas"]["ResourceInfoType2"];
6550
6695
  /**
6551
6696
  * Format: uuid
@@ -6663,6 +6808,7 @@ interface components {
6663
6808
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6664
6809
  */
6665
6810
  OrganizationID?: string;
6811
+ /** @description Annotations on locations within the Unit's configuration data as of this Revision. */
6666
6812
  PathAnnotations?: components["schemas"]["PathAnnotationList"];
6667
6813
  /** @description Attribute paths this Revision's configuration provides to downstream Units via NeedsProvides Links. */
6668
6814
  ProvidedPaths?: components["schemas"]["AttributeInfo"][];
@@ -6786,6 +6932,7 @@ interface components {
6786
6932
  UnitID?: string;
6787
6933
  };
6788
6934
  RevisionMutationSources: {
6935
+ /** @description Sources of mutations affecting the configuration data, by resource and path. */
6789
6936
  MutationSources?: components["schemas"]["ResourceMutationList"];
6790
6937
  /**
6791
6938
  * Format: uuid
@@ -6871,6 +7018,7 @@ interface components {
6871
7018
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6872
7019
  */
6873
7020
  OrganizationID?: string;
7021
+ /** @description Permissions to access this space. */
6874
7022
  Permissions?: components["schemas"]["Permissions"];
6875
7023
  /**
6876
7024
  * Format: uuid
@@ -7055,6 +7203,7 @@ interface components {
7055
7203
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7056
7204
  */
7057
7205
  OrganizationID?: string;
7206
+ /** @description Permissions to access this tag. */
7058
7207
  Permissions?: components["schemas"]["Permissions"];
7059
7208
  /**
7060
7209
  * Format: uuid
@@ -7135,6 +7284,7 @@ interface components {
7135
7284
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7136
7285
  */
7137
7286
  OrganizationID?: string;
7287
+ /** @description Permissions to access this target. */
7138
7288
  Permissions?: components["schemas"]["Permissions"];
7139
7289
  /** @description Unique URL-safe identifier for the entity. */
7140
7290
  Slug: string;
@@ -7280,6 +7430,7 @@ interface components {
7280
7430
  FailOpenAfter?: number | null;
7281
7431
  /** @description Function name */
7282
7432
  FunctionName?: string;
7433
+ /** @description Guards to record on the paths this trigger's function writes, naming the reasons those paths hold what they hold, so a later operation must be cleared for them before overwriting. Sibling to Protect: Protect claims the paths, Guards say why. Add and overwrite only -- retiring a guard is the /guard API (cub unit set-guard --remove-guard). Only meaningful for a mutating trigger, and part of the trigger's Hash, unlike Protect. */
7283
7434
  Guards?: components["schemas"]["GuardStamp"];
7284
7435
  /** @description SHA256 hash of the trigger's specification fields, used to detect changes. */
7285
7436
  readonly Hash?: string;
@@ -7303,6 +7454,7 @@ interface components {
7303
7454
  OrganizationID?: string;
7304
7455
  /** @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. When empty, the function is passed the sources its signature lists in OtherDataExpected. */
7305
7456
  OtherDataSource?: string;
7457
+ /** @description Permissions to access this trigger. */
7306
7458
  Permissions?: components["schemas"]["Permissions"];
7307
7459
  /**
7308
7460
  * @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.
@@ -7483,6 +7635,7 @@ interface components {
7483
7635
  OrganizationID?: string;
7484
7636
  /** @description Annotations on locations within the Unit's configuration data, by resource and path. */
7485
7637
  readonly PathAnnotations?: components["schemas"]["PathAnnotationList"];
7638
+ /** @description Permissions to access this unit. */
7486
7639
  Permissions?: components["schemas"]["Permissions"];
7487
7640
  /** @description Attribute paths that this Unit provides to downstream Units via NeedsProvides Links. Computed from get-provided and stored on data updates. */
7488
7641
  readonly ProvidedPaths?: components["schemas"]["AttributeInfo"][];
@@ -7567,6 +7720,7 @@ interface components {
7567
7720
  };
7568
7721
  /** @description UnitAction is a record of an operation queued for a Worker, such as a function invocation on a unit. Operations are delivered to the worker in creation order; if the worker is disconnected, pending operations are delivered when it reconnects. One or more UnitEvents will correspond to each UnitAction. */
7569
7722
  UnitAction: {
7723
+ /** @description Action is the type of action to be performed by the bridge worker. */
7570
7724
  Action?: components["schemas"]["ActionType"];
7571
7725
  /**
7572
7726
  * Format: uuid
@@ -7680,20 +7834,25 @@ interface components {
7680
7834
  UnitConflictsResponse: {
7681
7835
  /** @description Number of conflicts whose withheld change was applied */
7682
7836
  Applied?: number;
7837
+ /** @description The Unit's outstanding conflicts after the request */
7683
7838
  Conflicts?: components["schemas"]["MutationConflictList"];
7839
+ /** @description What applying the withheld changes changed in the configuration, or would change for a dry run, path by path with the values on both sides */
7684
7840
  Diff?: components["schemas"]["ConfigDiff"];
7685
7841
  /** @description Number of conflicts dropped without changing the configuration data */
7686
7842
  Dismissed?: number;
7687
7843
  Error?: components["schemas"]["ResponseError"];
7844
+ /** @description The Unit as the request left it, or would have left it for a dry run */
7688
7845
  Unit?: components["schemas"]["Unit"];
7689
7846
  };
7690
7847
  UnitCreateOrUpdateResponse: {
7691
7848
  /** @description The configuration the operation produced; returned when include names ConfigData. */
7692
7849
  ConfigData?: string;
7693
7850
  Conflicts?: components["schemas"]["MutationConflictList"];
7851
+ /** @description What the operation changed, or on a dry run would change, path by path with the values on both sides; returned when include names Diff. */
7694
7852
  Diff?: components["schemas"]["ConfigDiff"];
7695
7853
  Error?: components["schemas"]["ResponseError"];
7696
7854
  Links?: components["schemas"]["LinkCreateOrUpdateResponse"][];
7855
+ /** @description What set each value in the configuration the operation produced; returned when include names MutationSources. */
7697
7856
  MutationSources?: components["schemas"]["ResourceMutationList"];
7698
7857
  Unit?: components["schemas"]["Unit"];
7699
7858
  };
@@ -7725,6 +7884,7 @@ interface components {
7725
7884
  UnitID?: string;
7726
7885
  };
7727
7886
  UnitDiff: {
7887
+ /** @description What changed from the From Revision to the To Revision */
7728
7888
  Diff?: components["schemas"]["ConfigDiff"];
7729
7889
  Error?: components["schemas"]["ResponseError"];
7730
7890
  /**
@@ -7840,11 +8000,13 @@ interface components {
7840
8000
  Version?: number;
7841
8001
  };
7842
8002
  UnitGuardRequest: {
8003
+ /** @description The classes of reason this edit is cleared for; required to edit a path that already carries guards */
7843
8004
  Clearance?: components["schemas"]["Clearance"];
7844
8005
  /** @description Per-resource guard edits to apply to the Unit's PathAnnotations */
7845
8006
  ResourceGuards?: components["schemas"]["ResourceGuards"][] | null;
7846
8007
  };
7847
8008
  UnitGuardResponse: {
8009
+ /** @description The Unit's PathAnnotations after applying the guard edits */
7848
8010
  PathAnnotations?: components["schemas"]["PathAnnotationList"];
7849
8011
  };
7850
8012
  UnitMoveRequest: {
@@ -7874,6 +8036,7 @@ interface components {
7874
8036
  UnitMutationSources: {
7875
8037
  /** @description SHA256 of the configuration data the MutationSources describe. */
7876
8038
  DataHash?: string;
8039
+ /** @description Sources of mutations affecting the configuration data, by resource and path. */
7877
8040
  MutationSources?: components["schemas"]["ResourceMutationList"];
7878
8041
  /** @description Slug of the Unit. */
7879
8042
  Slug?: string;
@@ -7898,6 +8061,7 @@ interface components {
7898
8061
  };
7899
8062
  UnitProtectionResponse: {
7900
8063
  Error?: components["schemas"]["ResponseError"];
8064
+ /** @description The Unit's MutationSources after applying the protection edits */
7901
8065
  MutationSources?: components["schemas"]["ResourceMutationList"];
7902
8066
  };
7903
8067
  UnitTagRequest: {
@@ -7976,6 +8140,7 @@ interface components {
7976
8140
  /** @description Inferred links dropped to keep the link graph acyclic. */
7977
8141
  BrokenLinks?: components["schemas"]["UploadBrokenEdge"][];
7978
8142
  Name?: string;
8143
+ /** @description Set when CreateNamespace was asked for but the bundle already carried the release Namespace. */
7979
8144
  NamespaceCollision?: components["schemas"]["UploadNamespaceCollision"];
7980
8145
  /** @description Secret resources dropped from the bundle, as Kind/namespace/name. Secrets are never uploaded. */
7981
8146
  SkippedSecrets?: string[];
@@ -8040,8 +8205,12 @@ interface components {
8040
8205
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
8041
8206
  */
8042
8207
  ChangeSetID?: string;
8208
+ /** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
8209
+ Clearance?: components["schemas"]["Clearance"];
8043
8210
  /** @description Placement of each component. Exactly one is supported. */
8044
8211
  Components?: components["schemas"]["UploadComponentRequest"][];
8212
+ /** @description Plan the upload and return the same response without writing anything. */
8213
+ DryRun?: boolean;
8045
8214
  /** @description The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given. */
8046
8215
  Files?: components["schemas"]["UploadRequestFile"][];
8047
8216
  /** @description The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied. */
@@ -8053,6 +8222,14 @@ interface components {
8053
8222
  };
8054
8223
  /** @description Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}. */
8055
8224
  SpacePattern?: string;
8225
+ /** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */
8226
+ Subgroup?: string;
8227
+ /**
8228
+ * Format: uuid
8229
+ * @description A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written.
8230
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
8231
+ */
8232
+ TagID?: string;
8056
8233
  };
8057
8234
  UploadRequestFile: {
8058
8235
  /** @description The file's contents. */
@@ -8073,6 +8250,7 @@ interface components {
8073
8250
  /** @description The client that uploaded: cub, installer, ui. */
8074
8251
  Client?: string;
8075
8252
  ClientVersion?: string;
8253
+ /** @description Registry credentials for the pull. Used for this request only; never stored, logged, or returned. */
8076
8254
  Credentials?: components["schemas"]["UploadRegistryCredentials"];
8077
8255
  /** @description The resolved digest, when the transport has one. */
8078
8256
  Digest?: string;
@@ -8120,10 +8298,14 @@ interface components {
8120
8298
  UploadUnitResult: {
8121
8299
  /** @description Create, Update, Unchanged, Empty, Revive, or Adopt. */
8122
8300
  Action?: string;
8301
+ /** @description Paths withheld because they were overridden locally or guarded. */
8123
8302
  Conflicts?: components["schemas"]["MutationConflictList"];
8303
+ /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
8124
8304
  Diff?: components["schemas"]["ConfigDiff"];
8305
+ /** @description For a BackingUnit, what became of the entity its document describes. */
8125
8306
  Entity?: components["schemas"]["UploadEntityResult"];
8126
8307
  Error?: components["schemas"]["ResponseError"];
8308
+ /** @description What the write changed, or on a dry run would change: the entries of the Unit's MutationSources it produced. Returned when include names Mutations. */
8127
8309
  Mutations?: components["schemas"]["ResourceMutationList"];
8128
8310
  /** @description The resource identity this Unit is keyed by. */
8129
8311
  Resource?: string;
@@ -8217,6 +8399,7 @@ interface components {
8217
8399
  ValidationResult: {
8218
8400
  /** @description Deprecated. Use Issues or FailedAttributes instead. Optional list of failure details when not associated with specific attributes/paths. */
8219
8401
  Details?: string[];
8402
+ /** @description optional list of failed attributes/paths and issues found for them. Preferred over Issues and Details. */
8220
8403
  FailedAttributes?: components["schemas"]["AttributeValueList"];
8221
8404
  /** @description Name of the function invocation corresponding to the result */
8222
8405
  FunctionName?: string;
@@ -8283,6 +8466,7 @@ interface components {
8283
8466
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
8284
8467
  */
8285
8468
  OrganizationID?: string;
8469
+ /** @description Permissions to access this view. */
8286
8470
  Permissions?: components["schemas"]["Permissions"];
8287
8471
  /** @description Unique URL-safe identifier for the entity. */
8288
8472
  Slug: string;
@@ -8334,6 +8518,7 @@ interface components {
8334
8518
  Value?: string;
8335
8519
  };
8336
8520
  WorkerInfo: {
8521
+ /** @description FunctionWorker capabilities */
8337
8522
  FunctionWorkerInfo?: components["schemas"]["FunctionWorkerInfo"];
8338
8523
  /** @description If true, this is a server-hosted worker: an identity that no worker process connects as, and that runs no functions. It cannot be changed after the worker is created. */
8339
8524
  IsServerWorker?: boolean;
@@ -9003,7 +9188,7 @@ interface operations {
9003
9188
  "application/json": components["schemas"]["SpaceCreateOrUpdateResponse"][];
9004
9189
  };
9005
9190
  };
9006
- /** @description Multi-Status: Mixed success and failure results */
9191
+ /** @description Multi-Status (partial success) */
9007
9192
  207: {
9008
9193
  headers: {
9009
9194
  [name: string]: unknown;
@@ -10148,8 +10333,6 @@ interface operations {
10148
10333
  limit?: number;
10149
10334
  /** @description The token from the ConfigHub-Continue header of the previous request, to act on the Attribute entities after the last one it acted on. The request's other parameters, except limit, must be the same as those of the request that returned the token. */
10150
10335
  continue?: string;
10151
- /** @description Comma-separated list of prefixes to apply to cloned Attribute names */
10152
- name_prefixes?: string;
10153
10336
  /**
10154
10337
  * @description The specified string is an expression for the purpose of filtering
10155
10338
  * the list of Spaces returned. The expression syntax was inspired by SQL.
@@ -11176,6 +11359,60 @@ interface operations {
11176
11359
  "application/json": components["schemas"]["ExtendedBridgeWorker"][];
11177
11360
  };
11178
11361
  };
11362
+ /** @description BridgeWorker request is invalid (Bad Request). */
11363
+ 400: {
11364
+ headers: {
11365
+ [name: string]: unknown;
11366
+ };
11367
+ content: {
11368
+ "application/json": components["schemas"]["StandardErrorResponse"];
11369
+ };
11370
+ };
11371
+ /** @description Unauthorized access. */
11372
+ 401: {
11373
+ headers: {
11374
+ [name: string]: unknown;
11375
+ };
11376
+ content: {
11377
+ "application/json": components["schemas"]["StandardErrorResponse"];
11378
+ };
11379
+ };
11380
+ /** @description Forbidden access. */
11381
+ 403: {
11382
+ headers: {
11383
+ [name: string]: unknown;
11384
+ };
11385
+ content: {
11386
+ "application/json": components["schemas"]["StandardErrorResponse"];
11387
+ };
11388
+ };
11389
+ /** @description BridgeWorker not found. */
11390
+ 404: {
11391
+ headers: {
11392
+ [name: string]: unknown;
11393
+ };
11394
+ content: {
11395
+ "application/json": components["schemas"]["StandardErrorResponse"];
11396
+ };
11397
+ };
11398
+ /** @description Something went wrong while processing BridgeWorker. */
11399
+ 500: {
11400
+ headers: {
11401
+ [name: string]: unknown;
11402
+ };
11403
+ content: {
11404
+ "application/json": components["schemas"]["StandardErrorResponse"];
11405
+ };
11406
+ };
11407
+ /** @description Unexpected error. */
11408
+ default: {
11409
+ headers: {
11410
+ [name: string]: unknown;
11411
+ };
11412
+ content: {
11413
+ "application/json": components["schemas"]["StandardErrorResponse"];
11414
+ };
11415
+ };
11179
11416
  };
11180
11417
  };
11181
11418
  BulkDeleteBridgeWorkers: {
@@ -11351,7 +11588,7 @@ interface operations {
11351
11588
  "application/json": components["schemas"]["StandardErrorResponse"];
11352
11589
  };
11353
11590
  };
11354
- /** @description BridgeWorker could not be deleted. */
11591
+ /** @description Unable to delete entity */
11355
11592
  422: {
11356
11593
  headers: {
11357
11594
  [name: string]: unknown;
@@ -12294,7 +12531,7 @@ interface operations {
12294
12531
  *
12295
12532
  * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
12296
12533
  *
12297
- * Where expression to select destination spaces for cloning changeorders
12534
+ * Where expression to select destination spaces for cloning change orders
12298
12535
  *
12299
12536
  * The whole string must be query-encoded.
12300
12537
  */
@@ -13242,7 +13479,7 @@ interface operations {
13242
13479
  *
13243
13480
  * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
13244
13481
  *
13245
- * Where expression to select destination spaces for cloning changesets
13482
+ * Where expression to select destination spaces for cloning change sets
13246
13483
  *
13247
13484
  * The whole string must be query-encoded.
13248
13485
  */
@@ -16581,7 +16818,7 @@ interface operations {
16581
16818
  name_prefixes?: string;
16582
16819
  /** @description Comma-separated list of labels with multiple values for cloned Filter labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
16583
16820
  variant_labels?: string;
16584
- /** @description A Go-template string for clone name, use .SourceEntity to access the original entity and .Labels to access variant labels */
16821
+ /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
16585
16822
  name_pattern?: string;
16586
16823
  /**
16587
16824
  * @description The specified string is an expression for the purpose of filtering
@@ -20105,8 +20342,6 @@ interface operations {
20105
20342
  *
20106
20343
  * 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.
20107
20344
  *
20108
- * filter
20109
- *
20110
20345
  * The whole string must be query-encoded.
20111
20346
  */
20112
20347
  where?: string;
@@ -20309,8 +20544,6 @@ interface operations {
20309
20544
  *
20310
20545
  * 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.
20311
20546
  *
20312
- * filter
20313
- *
20314
20547
  * The whole string must be query-encoded.
20315
20548
  */
20316
20549
  where?: string;
@@ -22003,7 +22236,7 @@ interface operations {
22003
22236
  * @description Deprecated: use DryRun in the request body. Plan the promotion, evaluate its gates, and return the same response without writing anything. Either one asks for a dry run.
22004
22237
  */
22005
22238
  dry_run?: boolean;
22006
- /** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. On a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. */
22239
+ /** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named. */
22007
22240
  include?: string;
22008
22241
  };
22009
22242
  header?: never;
@@ -27112,6 +27345,8 @@ interface operations {
27112
27345
  * The whole string must be query-encoded.
27113
27346
  */
27114
27347
  select?: string;
27348
+ /** @description If true, fill in ContainerImages: for each Space the ChangeOrder has landed in, the container images get-container-image finds at the Revisions its end Tag marks that differ from those at the Revisions its start Tag marks. */
27349
+ container_images?: boolean;
27115
27350
  };
27116
27351
  header?: never;
27117
27352
  path: {
@@ -43388,6 +43623,10 @@ interface operations {
43388
43623
  continue?: string;
43389
43624
  /** @description Comma-separated list of prefixes to apply to cloned Trigger names */
43390
43625
  name_prefixes?: string;
43626
+ /** @description Comma-separated list of labels with multiple values for cloned Trigger labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
43627
+ variant_labels?: string;
43628
+ /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
43629
+ name_pattern?: string;
43391
43630
  /**
43392
43631
  * @description The specified string is an expression for the purpose of filtering
43393
43632
  * the list of Spaces returned. The expression syntax was inspired by SQL.
@@ -45066,7 +45305,7 @@ interface operations {
45066
45305
  "application/json": components["schemas"]["StandardErrorResponse"];
45067
45306
  };
45068
45307
  };
45069
- /** @description Unable to delete entities */
45308
+ /** @description Unable to delete entity */
45070
45309
  422: {
45071
45310
  headers: {
45072
45311
  [name: string]: unknown;
@@ -47046,7 +47285,10 @@ interface operations {
47046
47285
  Upload: {
47047
47286
  parameters: {
47048
47287
  query?: {
47049
- /** @description Plan the upload and return the same response without writing anything. */
47288
+ /**
47289
+ * @deprecated
47290
+ * @description Deprecated: use DryRun in the request body. Plan the upload and return the same response without writing anything. Either one asks for a dry run.
47291
+ */
47050
47292
  dry_run?: boolean;
47051
47293
  /** @description Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. */
47052
47294
  include?: string;
@@ -48017,7 +48259,7 @@ interface operations {
48017
48259
  continue?: string;
48018
48260
  /** @description Comma-separated list of prefixes to apply to cloned View names */
48019
48261
  name_prefixes?: string;
48020
- /** @description Comma-separated list of labels with multiple values fro cloned View labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
48262
+ /** @description Comma-separated list of labels with multiple values for cloned View labels, in the format of key1=value1|value2,key2=value1|value2|value3 */
48021
48263
  variant_labels?: string;
48022
48264
  /** @description A string for clone names, use the prefix 'template:' for a Go-template with .SourceEntitySlug to access the original entity's slug and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}' */
48023
48265
  name_pattern?: string;