@confighub/api 0.8.30 → 0.8.31

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
@@ -4310,14 +4310,14 @@ interface components {
4310
4310
  };
4311
4311
  BindingList: components["schemas"]["Binding"][];
4312
4312
  /**
4313
- * @description BridgeWorker represents a bridge worker in ConfigHub.
4314
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
4315
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
4316
- * to be applied. Bridge workers are responsible for executing configuration changes on
4317
- * remote targets and reporting status back to ConfigHub.
4313
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
4314
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
4315
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
4316
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
4317
+ * only through Releases, so a worker does not apply it to targets.
4318
4318
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
4319
4319
  * required for authentication with the ConfigHub server. These credentials allow the
4320
- * bridge worker to establish a secure connection and receive configuration actions.
4320
+ * bridge worker to establish a secure connection and receive function invocations.
4321
4321
  */
4322
4322
  BridgeWorker: {
4323
4323
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -4678,7 +4678,7 @@ interface components {
4678
4678
  * An example conjunction is:
4679
4679
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
4680
4680
  *
4681
- * 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.
4681
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
4682
4682
  *
4683
4683
  * The whole string must be query-encoded.
4684
4684
  */
@@ -6198,6 +6198,11 @@ interface components {
6198
6198
  BridgeWorkerID?: string;
6199
6199
  /** @description ChangeDescription is a description of the change being made, if any. */
6200
6200
  ChangeDescription?: string;
6201
+ /**
6202
+ * Format: uuid
6203
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6204
+ */
6205
+ ChannelID?: string;
6201
6206
  FunctionInvocations?: components["schemas"]["FunctionInvocationList"];
6202
6207
  /** @description Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them */
6203
6208
  IncludeConflicts?: boolean;
@@ -7283,11 +7288,11 @@ interface components {
7283
7288
  };
7284
7289
  /** @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. */
7285
7290
  QueuedOperation: {
7286
- /** @description Action is the type of action to be performed by the bridge worker. */
7291
+ /** @description Action is the type of action to be performed by the worker, such as InvokeFunctions or Cancel. UnitActions queued for bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
7287
7292
  Action?: components["schemas"]["ActionType"];
7288
7293
  /**
7289
7294
  * Format: uuid
7290
- * @description BridgeWorkerID is the unique identifier of the bridge worker that will process this operation.
7295
+ * @description BridgeWorkerID is the unique identifier of the worker that will process this operation.
7291
7296
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7292
7297
  */
7293
7298
  BridgeWorkerID?: string;
@@ -7299,7 +7304,7 @@ interface components {
7299
7304
  CreatedAt?: string;
7300
7305
  /**
7301
7306
  * Format: base64
7302
- * @description The result of a dry-run Data-changing action like refresh and import, where the data is not stored in the Unit.
7307
+ * @description Data is the result the worker reported for a finished function invocation: its FunctionInvocationResponse, as JSON.
7303
7308
  */
7304
7309
  Data?: string;
7305
7310
  /** @description Unused. No longer populated or consulted for delivery; retained for schema compatibility and scheduled for removal. */
@@ -7414,6 +7419,8 @@ interface components {
7414
7419
  LiveStatus?: components["schemas"]["ReleaseLiveStatus"];
7415
7420
  /** @description OCI digest (sha256:...) of the Release's OCI image manifest. */
7416
7421
  readonly ManifestDigest?: string;
7422
+ /** @description The OCI repository the Release is served from: its Space's, as the Space's OCIRepositoryURL says, while the Release is Published. It is oci://<registry host>:<port>/space/<space slug>, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */
7423
+ readonly OCIRepositoryURL?: string;
7417
7424
  /**
7418
7425
  * Format: uuid
7419
7426
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
@@ -8194,6 +8201,8 @@ interface components {
8194
8201
  Labels?: {
8195
8202
  [key: string]: string;
8196
8203
  };
8204
+ /** @description The OCI repository the Space's Releases are served from, set when the Space has a ReleaseTargetID. It is oci://<registry host>:<port>/space/<space slug>, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */
8205
+ readonly OCIRepositoryURL?: string;
8197
8206
  /**
8198
8207
  * Format: uuid
8199
8208
  * @description Unique identifier for an organization.
@@ -8903,11 +8912,11 @@ interface components {
8903
8912
  };
8904
8913
  /** @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. */
8905
8914
  UnitAction: {
8906
- /** @description Action is the type of action to be performed by the bridge worker. */
8915
+ /** @description Action is the type of action to be performed by the worker, such as InvokeFunctions or Cancel. UnitActions queued for bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
8907
8916
  Action?: components["schemas"]["ActionType"];
8908
8917
  /**
8909
8918
  * Format: uuid
8910
- * @description BridgeWorkerID is the unique identifier of the bridge worker that will process this operation.
8919
+ * @description BridgeWorkerID is the unique identifier of the worker that will process this operation.
8911
8920
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
8912
8921
  */
8913
8922
  BridgeWorkerID?: string;
@@ -8919,7 +8928,7 @@ interface components {
8919
8928
  CreatedAt?: string;
8920
8929
  /**
8921
8930
  * Format: base64
8922
- * @description The result of a dry-run Data-changing action like refresh and import, where the data is not stored in the Unit.
8931
+ * @description Data is the result the worker reported for a finished function invocation: its FunctionInvocationResponse, as JSON.
8923
8932
  */
8924
8933
  Data?: string;
8925
8934
  /** @description Unused. No longer populated or consulted for delivery; retained for schema compatibility and scheduled for removal. */
@@ -9096,19 +9105,23 @@ interface components {
9096
9105
  UnitID?: string;
9097
9106
  };
9098
9107
  /**
9099
- * @description UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks
9100
- * the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target
9101
- * live system. The event captures the current status of the operation, any configuration
9102
- * drift detected, and timing information about when the action started and completed.
9103
- * Actions are atomic from ConfigHub's perspective but may involve multiple steps
9104
- * in the connected Bridge. The status and drift detection help track the health
9105
- * and consistency of the provisioned configuration compared to what is defined in the Unit.
9108
+ * @description UnitEvent records the outcome of a UnitAction on a Unit: the result a worker reported for an
9109
+ * operation queued for it, such as a function invocation on the Unit completing or failing, or a
9110
+ * cancellation being acknowledged, and the failure of an operation that could not be delivered to
9111
+ * its worker. Each event records the action, its result and status, any message, and when the
9112
+ * operation started and ended. UnitEvents are numbered per Unit by UnitEventNum.
9113
+ *
9114
+ * UnitEvents do not report on live systems. Configuration reaches live systems through Releases,
9115
+ * which GitOps tools such as Argo CD and Flux pull. Events written by bridge workers, which applied,
9116
+ * destroyed, and refreshed Units in live systems and have been removed, can remain in a Unit's
9117
+ * history, but are no longer written.
9106
9118
  */
9107
9119
  UnitEvent: {
9120
+ /** @description Action is the action of the UnitAction this event reports on, such as InvokeFunctions or Cancel. Events written by bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
9108
9121
  Action?: components["schemas"]["ActionType"];
9109
9122
  /**
9110
9123
  * Format: uuid
9111
- * @description BridgeWorkerID is the ID of the bridge worker that performed this action: the worker that reported the result.
9124
+ * @description BridgeWorkerID is the ID of the worker the UnitAction was queued for: the worker that reported the result.
9112
9125
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9113
9126
  */
9114
9127
  BridgeWorkerID?: string;
@@ -9122,6 +9135,7 @@ interface components {
9122
9135
  readonly EntityType?: string;
9123
9136
  /** @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. */
9124
9137
  HiddenReason?: string;
9138
+ /** @description Message is the message reported with the result, by the worker or, for an operation that failed before reaching it, by ConfigHub. */
9125
9139
  Message?: string;
9126
9140
  /**
9127
9141
  * Format: uuid
@@ -9131,12 +9145,16 @@ interface components {
9131
9145
  OrganizationID?: string;
9132
9146
  /**
9133
9147
  * Format: uuid
9134
- * @description QueuedOperationID is the unique identifier for the corresponding queued operation.
9148
+ * @description QueuedOperationID is the unique identifier of the UnitAction this event reports on.
9135
9149
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9136
9150
  */
9137
9151
  QueuedOperationID?: string;
9152
+ /** @description Result is what the action produced: FunctionInvocationCompleted or FunctionInvocationFailed for a function invocation, and None otherwise. Events written by bridge workers, which have been removed, can carry the results they reported. */
9138
9153
  Result?: components["schemas"]["ActionResultType"];
9139
- /** Format: int64 */
9154
+ /**
9155
+ * Format: int64
9156
+ * @description RevisionNum is the number of the Unit's Revision the action was performed on.
9157
+ */
9140
9158
  RevisionNum?: number;
9141
9159
  /**
9142
9160
  * Format: uuid
@@ -9148,20 +9166,26 @@ interface components {
9148
9166
  readonly SpaceSlug?: string;
9149
9167
  /**
9150
9168
  * Format: date-time
9169
+ * @description StartedAt is when the operation started, in "2023-01-01T12:00:00Z" format.
9151
9170
  * @example 2006-01-02T15:04:05Z07:00
9152
9171
  */
9153
9172
  StartedAt?: string;
9173
+ /** @description Status is the state of the operation the event reports: None, Pending, Submitted, Progressing, Completed, Failed, Canceled, or Aborted. */
9154
9174
  Status?: components["schemas"]["ActionStatusType"];
9155
- /** Format: date-time */
9175
+ /**
9176
+ * Format: date-time
9177
+ * @description TerminatedAt is when the operation ended, in "2023-01-01T12:00:00Z" format. It is absent for an operation that had not ended when the event was recorded.
9178
+ */
9156
9179
  TerminatedAt?: string | null;
9157
9180
  /**
9158
9181
  * Format: uuid
9182
+ * @description UnitEventID is the unique identifier for this UnitEvent.
9159
9183
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9160
9184
  */
9161
9185
  UnitEventID?: string;
9162
9186
  /**
9163
9187
  * Format: int64
9164
- * @description Sequence number for this unit event.
9188
+ * @description UnitEventNum is the sequence number of this UnitEvent among the Unit's UnitEvents.
9165
9189
  */
9166
9190
  UnitEventNum?: number;
9167
9191
  /**
@@ -10667,7 +10691,7 @@ interface operations {
10667
10691
  * An example conjunction is:
10668
10692
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
10669
10693
  *
10670
- * 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.
10694
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
10671
10695
  *
10672
10696
  * The whole string must be query-encoded.
10673
10697
  */
@@ -10967,7 +10991,7 @@ interface operations {
10967
10991
  * An example conjunction is:
10968
10992
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
10969
10993
  *
10970
- * 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.
10994
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
10971
10995
  *
10972
10996
  * The whole string must be query-encoded.
10973
10997
  */
@@ -11175,7 +11199,7 @@ interface operations {
11175
11199
  * An example conjunction is:
11176
11200
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
11177
11201
  *
11178
- * 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.
11202
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
11179
11203
  *
11180
11204
  * The whole string must be query-encoded.
11181
11205
  */
@@ -12046,7 +12070,7 @@ interface operations {
12046
12070
  * An example conjunction is:
12047
12071
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
12048
12072
  *
12049
- * 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.
12073
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
12050
12074
  *
12051
12075
  * Where expression to select destination spaces for cloning attributes
12052
12076
  *
@@ -14227,7 +14251,7 @@ interface operations {
14227
14251
  * An example conjunction is:
14228
14252
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
14229
14253
  *
14230
- * 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.
14254
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
14231
14255
  *
14232
14256
  * Where expression to select destination spaces for cloning change orders
14233
14257
  *
@@ -15191,7 +15215,7 @@ interface operations {
15191
15215
  * An example conjunction is:
15192
15216
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
15193
15217
  *
15194
- * 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.
15218
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
15195
15219
  *
15196
15220
  * Where expression to select destination spaces for cloning change sets
15197
15221
  *
@@ -16312,7 +16336,7 @@ interface operations {
16312
16336
  * An example conjunction is:
16313
16337
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
16314
16338
  *
16315
- * 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.
16339
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
16316
16340
  *
16317
16341
  * Where expression to select destination spaces for cloning change workflows
16318
16342
  *
@@ -17513,7 +17537,7 @@ interface operations {
17513
17537
  * An example conjunction is:
17514
17538
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17515
17539
  *
17516
- * 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.
17540
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
17517
17541
  *
17518
17542
  * Where expression to select destination spaces for cloning channels
17519
17543
  *
@@ -20079,7 +20103,7 @@ interface operations {
20079
20103
  * An example conjunction is:
20080
20104
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20081
20105
  *
20082
- * 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.
20106
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
20083
20107
  *
20084
20108
  * Where expression to select destination spaces for cloning filters
20085
20109
  *
@@ -22138,7 +22162,7 @@ interface operations {
22138
22162
  * An example conjunction is:
22139
22163
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
22140
22164
  *
22141
- * 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.
22165
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
22142
22166
  *
22143
22167
  * Where expression to select destination spaces for cloning invocations
22144
22168
  *
@@ -25661,7 +25685,7 @@ interface operations {
25661
25685
  * An example conjunction is:
25662
25686
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25663
25687
  *
25664
- * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
25688
+ * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
25665
25689
  *
25666
25690
  * The whole string must be query-encoded.
25667
25691
  */
@@ -28654,7 +28678,7 @@ interface operations {
28654
28678
  * An example conjunction is:
28655
28679
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
28656
28680
  *
28657
- * 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.
28681
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
28658
28682
  *
28659
28683
  * The whole string must be query-encoded.
28660
28684
  */
@@ -30930,14 +30954,14 @@ interface operations {
30930
30954
  };
30931
30955
  responses: {
30932
30956
  /**
30933
- * @description BridgeWorker represents a bridge worker in ConfigHub.
30934
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
30935
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
30936
- * to be applied. Bridge workers are responsible for executing configuration changes on
30937
- * remote targets and reporting status back to ConfigHub.
30957
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
30958
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
30959
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
30960
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
30961
+ * only through Releases, so a worker does not apply it to targets.
30938
30962
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
30939
30963
  * required for authentication with the ConfigHub server. These credentials allow the
30940
- * bridge worker to establish a secure connection and receive configuration actions.
30964
+ * bridge worker to establish a secure connection and receive function invocations.
30941
30965
  */
30942
30966
  200: {
30943
30967
  headers: {
@@ -31135,14 +31159,14 @@ interface operations {
31135
31159
  };
31136
31160
  responses: {
31137
31161
  /**
31138
- * @description BridgeWorker represents a bridge worker in ConfigHub.
31139
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
31140
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
31141
- * to be applied. Bridge workers are responsible for executing configuration changes on
31142
- * remote targets and reporting status back to ConfigHub.
31162
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
31163
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
31164
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
31165
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
31166
+ * only through Releases, so a worker does not apply it to targets.
31143
31167
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
31144
31168
  * required for authentication with the ConfigHub server. These credentials allow the
31145
- * bridge worker to establish a secure connection and receive configuration actions.
31169
+ * bridge worker to establish a secure connection and receive function invocations.
31146
31170
  */
31147
31171
  200: {
31148
31172
  headers: {
@@ -31365,14 +31389,14 @@ interface operations {
31365
31389
  };
31366
31390
  responses: {
31367
31391
  /**
31368
- * @description BridgeWorker represents a bridge worker in ConfigHub.
31369
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
31370
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
31371
- * to be applied. Bridge workers are responsible for executing configuration changes on
31372
- * remote targets and reporting status back to ConfigHub.
31392
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
31393
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
31394
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
31395
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
31396
+ * only through Releases, so a worker does not apply it to targets.
31373
31397
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
31374
31398
  * required for authentication with the ConfigHub server. These credentials allow the
31375
- * bridge worker to establish a secure connection and receive configuration actions.
31399
+ * bridge worker to establish a secure connection and receive function invocations.
31376
31400
  */
31377
31401
  200: {
31378
31402
  headers: {
@@ -39199,7 +39223,7 @@ interface operations {
39199
39223
  * An example conjunction is:
39200
39224
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
39201
39225
  *
39202
- * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
39226
+ * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
39203
39227
  *
39204
39228
  * The whole string must be query-encoded.
39205
39229
  */
@@ -46683,13 +46707,16 @@ interface operations {
46683
46707
  requestBody?: never;
46684
46708
  responses: {
46685
46709
  /**
46686
- * @description UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks
46687
- * the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target
46688
- * live system. The event captures the current status of the operation, any configuration
46689
- * drift detected, and timing information about when the action started and completed.
46690
- * Actions are atomic from ConfigHub's perspective but may involve multiple steps
46691
- * in the connected Bridge. The status and drift detection help track the health
46692
- * and consistency of the provisioned configuration compared to what is defined in the Unit.
46710
+ * @description UnitEvent records the outcome of a UnitAction on a Unit: the result a worker reported for an
46711
+ * operation queued for it, such as a function invocation on the Unit completing or failing, or a
46712
+ * cancellation being acknowledged, and the failure of an operation that could not be delivered to
46713
+ * its worker. Each event records the action, its result and status, any message, and when the
46714
+ * operation started and ended. UnitEvents are numbered per Unit by UnitEventNum.
46715
+ *
46716
+ * UnitEvents do not report on live systems. Configuration reaches live systems through Releases,
46717
+ * which GitOps tools such as Argo CD and Flux pull. Events written by bridge workers, which applied,
46718
+ * destroyed, and refreshed Units in live systems and have been removed, can remain in a Unit's
46719
+ * history, but are no longer written.
46693
46720
  */
46694
46721
  200: {
46695
46722
  headers: {
@@ -48016,7 +48043,7 @@ interface operations {
48016
48043
  * An example conjunction is:
48017
48044
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
48018
48045
  *
48019
- * 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.
48046
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
48020
48047
  *
48021
48048
  * Where expression to select destination spaces for cloning tags
48022
48049
  *
@@ -49129,7 +49156,7 @@ interface operations {
49129
49156
  * An example conjunction is:
49130
49157
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
49131
49158
  *
49132
- * 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.
49159
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
49133
49160
  *
49134
49161
  * Where expression to select destination spaces for cloning targets
49135
49162
  *
@@ -50334,7 +50361,7 @@ interface operations {
50334
50361
  * An example conjunction is:
50335
50362
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
50336
50363
  *
50337
- * 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.
50364
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
50338
50365
  *
50339
50366
  * Where expression to select destination spaces for cloning triggers
50340
50367
  *
@@ -51595,7 +51622,7 @@ interface operations {
51595
51622
  * An example conjunction is:
51596
51623
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51597
51624
  *
51598
- * 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.
51625
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
51599
51626
  *
51600
51627
  * Where expression to select destination spaces for cloning units
51601
51628
  *
@@ -55027,7 +55054,7 @@ interface operations {
55027
55054
  * An example conjunction is:
55028
55055
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
55029
55056
  *
55030
- * 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.
55057
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
55031
55058
  *
55032
55059
  * Where expression to select destination spaces for cloning views
55033
55060
  *
package/dist/index.d.ts CHANGED
@@ -4310,14 +4310,14 @@ interface components {
4310
4310
  };
4311
4311
  BindingList: components["schemas"]["Binding"][];
4312
4312
  /**
4313
- * @description BridgeWorker represents a bridge worker in ConfigHub.
4314
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
4315
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
4316
- * to be applied. Bridge workers are responsible for executing configuration changes on
4317
- * remote targets and reporting status back to ConfigHub.
4313
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
4314
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
4315
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
4316
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
4317
+ * only through Releases, so a worker does not apply it to targets.
4318
4318
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
4319
4319
  * required for authentication with the ConfigHub server. These credentials allow the
4320
- * bridge worker to establish a secure connection and receive configuration actions.
4320
+ * bridge worker to establish a secure connection and receive function invocations.
4321
4321
  */
4322
4322
  BridgeWorker: {
4323
4323
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -4678,7 +4678,7 @@ interface components {
4678
4678
  * An example conjunction is:
4679
4679
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
4680
4680
  *
4681
- * 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.
4681
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
4682
4682
  *
4683
4683
  * The whole string must be query-encoded.
4684
4684
  */
@@ -6198,6 +6198,11 @@ interface components {
6198
6198
  BridgeWorkerID?: string;
6199
6199
  /** @description ChangeDescription is a description of the change being made, if any. */
6200
6200
  ChangeDescription?: string;
6201
+ /**
6202
+ * Format: uuid
6203
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
6204
+ */
6205
+ ChannelID?: string;
6201
6206
  FunctionInvocations?: components["schemas"]["FunctionInvocationList"];
6202
6207
  /** @description Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them */
6203
6208
  IncludeConflicts?: boolean;
@@ -7283,11 +7288,11 @@ interface components {
7283
7288
  };
7284
7289
  /** @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. */
7285
7290
  QueuedOperation: {
7286
- /** @description Action is the type of action to be performed by the bridge worker. */
7291
+ /** @description Action is the type of action to be performed by the worker, such as InvokeFunctions or Cancel. UnitActions queued for bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
7287
7292
  Action?: components["schemas"]["ActionType"];
7288
7293
  /**
7289
7294
  * Format: uuid
7290
- * @description BridgeWorkerID is the unique identifier of the bridge worker that will process this operation.
7295
+ * @description BridgeWorkerID is the unique identifier of the worker that will process this operation.
7291
7296
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7292
7297
  */
7293
7298
  BridgeWorkerID?: string;
@@ -7299,7 +7304,7 @@ interface components {
7299
7304
  CreatedAt?: string;
7300
7305
  /**
7301
7306
  * Format: base64
7302
- * @description The result of a dry-run Data-changing action like refresh and import, where the data is not stored in the Unit.
7307
+ * @description Data is the result the worker reported for a finished function invocation: its FunctionInvocationResponse, as JSON.
7303
7308
  */
7304
7309
  Data?: string;
7305
7310
  /** @description Unused. No longer populated or consulted for delivery; retained for schema compatibility and scheduled for removal. */
@@ -7414,6 +7419,8 @@ interface components {
7414
7419
  LiveStatus?: components["schemas"]["ReleaseLiveStatus"];
7415
7420
  /** @description OCI digest (sha256:...) of the Release's OCI image manifest. */
7416
7421
  readonly ManifestDigest?: string;
7422
+ /** @description The OCI repository the Release is served from: its Space's, as the Space's OCIRepositoryURL says, while the Release is Published. It is oci://<registry host>:<port>/space/<space slug>, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */
7423
+ readonly OCIRepositoryURL?: string;
7417
7424
  /**
7418
7425
  * Format: uuid
7419
7426
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
@@ -8194,6 +8201,8 @@ interface components {
8194
8201
  Labels?: {
8195
8202
  [key: string]: string;
8196
8203
  };
8204
+ /** @description The OCI repository the Space's Releases are served from, set when the Space has a ReleaseTargetID. It is oci://<registry host>:<port>/space/<space slug>, for a GitOps operator such as Argo CD or Flux to pull: its tag latest is the newest Release published for the Space's current release Target, and a ManifestDigest pins one. The registry is the one GET /api/info advertises to the same caller (OCIHost and OCIPort). Derived when the entity is read rather than stored, and returned whatever select names. (readonly) */
8205
+ readonly OCIRepositoryURL?: string;
8197
8206
  /**
8198
8207
  * Format: uuid
8199
8208
  * @description Unique identifier for an organization.
@@ -8903,11 +8912,11 @@ interface components {
8903
8912
  };
8904
8913
  /** @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. */
8905
8914
  UnitAction: {
8906
- /** @description Action is the type of action to be performed by the bridge worker. */
8915
+ /** @description Action is the type of action to be performed by the worker, such as InvokeFunctions or Cancel. UnitActions queued for bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
8907
8916
  Action?: components["schemas"]["ActionType"];
8908
8917
  /**
8909
8918
  * Format: uuid
8910
- * @description BridgeWorkerID is the unique identifier of the bridge worker that will process this operation.
8919
+ * @description BridgeWorkerID is the unique identifier of the worker that will process this operation.
8911
8920
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
8912
8921
  */
8913
8922
  BridgeWorkerID?: string;
@@ -8919,7 +8928,7 @@ interface components {
8919
8928
  CreatedAt?: string;
8920
8929
  /**
8921
8930
  * Format: base64
8922
- * @description The result of a dry-run Data-changing action like refresh and import, where the data is not stored in the Unit.
8931
+ * @description Data is the result the worker reported for a finished function invocation: its FunctionInvocationResponse, as JSON.
8923
8932
  */
8924
8933
  Data?: string;
8925
8934
  /** @description Unused. No longer populated or consulted for delivery; retained for schema compatibility and scheduled for removal. */
@@ -9096,19 +9105,23 @@ interface components {
9096
9105
  UnitID?: string;
9097
9106
  };
9098
9107
  /**
9099
- * @description UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks
9100
- * the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target
9101
- * live system. The event captures the current status of the operation, any configuration
9102
- * drift detected, and timing information about when the action started and completed.
9103
- * Actions are atomic from ConfigHub's perspective but may involve multiple steps
9104
- * in the connected Bridge. The status and drift detection help track the health
9105
- * and consistency of the provisioned configuration compared to what is defined in the Unit.
9108
+ * @description UnitEvent records the outcome of a UnitAction on a Unit: the result a worker reported for an
9109
+ * operation queued for it, such as a function invocation on the Unit completing or failing, or a
9110
+ * cancellation being acknowledged, and the failure of an operation that could not be delivered to
9111
+ * its worker. Each event records the action, its result and status, any message, and when the
9112
+ * operation started and ended. UnitEvents are numbered per Unit by UnitEventNum.
9113
+ *
9114
+ * UnitEvents do not report on live systems. Configuration reaches live systems through Releases,
9115
+ * which GitOps tools such as Argo CD and Flux pull. Events written by bridge workers, which applied,
9116
+ * destroyed, and refreshed Units in live systems and have been removed, can remain in a Unit's
9117
+ * history, but are no longer written.
9106
9118
  */
9107
9119
  UnitEvent: {
9120
+ /** @description Action is the action of the UnitAction this event reports on, such as InvokeFunctions or Cancel. Events written by bridge workers, which have been removed, can carry the actions they performed, such as Apply. */
9108
9121
  Action?: components["schemas"]["ActionType"];
9109
9122
  /**
9110
9123
  * Format: uuid
9111
- * @description BridgeWorkerID is the ID of the bridge worker that performed this action: the worker that reported the result.
9124
+ * @description BridgeWorkerID is the ID of the worker the UnitAction was queued for: the worker that reported the result.
9112
9125
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9113
9126
  */
9114
9127
  BridgeWorkerID?: string;
@@ -9122,6 +9135,7 @@ interface components {
9122
9135
  readonly EntityType?: string;
9123
9136
  /** @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. */
9124
9137
  HiddenReason?: string;
9138
+ /** @description Message is the message reported with the result, by the worker or, for an operation that failed before reaching it, by ConfigHub. */
9125
9139
  Message?: string;
9126
9140
  /**
9127
9141
  * Format: uuid
@@ -9131,12 +9145,16 @@ interface components {
9131
9145
  OrganizationID?: string;
9132
9146
  /**
9133
9147
  * Format: uuid
9134
- * @description QueuedOperationID is the unique identifier for the corresponding queued operation.
9148
+ * @description QueuedOperationID is the unique identifier of the UnitAction this event reports on.
9135
9149
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9136
9150
  */
9137
9151
  QueuedOperationID?: string;
9152
+ /** @description Result is what the action produced: FunctionInvocationCompleted or FunctionInvocationFailed for a function invocation, and None otherwise. Events written by bridge workers, which have been removed, can carry the results they reported. */
9138
9153
  Result?: components["schemas"]["ActionResultType"];
9139
- /** Format: int64 */
9154
+ /**
9155
+ * Format: int64
9156
+ * @description RevisionNum is the number of the Unit's Revision the action was performed on.
9157
+ */
9140
9158
  RevisionNum?: number;
9141
9159
  /**
9142
9160
  * Format: uuid
@@ -9148,20 +9166,26 @@ interface components {
9148
9166
  readonly SpaceSlug?: string;
9149
9167
  /**
9150
9168
  * Format: date-time
9169
+ * @description StartedAt is when the operation started, in "2023-01-01T12:00:00Z" format.
9151
9170
  * @example 2006-01-02T15:04:05Z07:00
9152
9171
  */
9153
9172
  StartedAt?: string;
9173
+ /** @description Status is the state of the operation the event reports: None, Pending, Submitted, Progressing, Completed, Failed, Canceled, or Aborted. */
9154
9174
  Status?: components["schemas"]["ActionStatusType"];
9155
- /** Format: date-time */
9175
+ /**
9176
+ * Format: date-time
9177
+ * @description TerminatedAt is when the operation ended, in "2023-01-01T12:00:00Z" format. It is absent for an operation that had not ended when the event was recorded.
9178
+ */
9156
9179
  TerminatedAt?: string | null;
9157
9180
  /**
9158
9181
  * Format: uuid
9182
+ * @description UnitEventID is the unique identifier for this UnitEvent.
9159
9183
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
9160
9184
  */
9161
9185
  UnitEventID?: string;
9162
9186
  /**
9163
9187
  * Format: int64
9164
- * @description Sequence number for this unit event.
9188
+ * @description UnitEventNum is the sequence number of this UnitEvent among the Unit's UnitEvents.
9165
9189
  */
9166
9190
  UnitEventNum?: number;
9167
9191
  /**
@@ -10667,7 +10691,7 @@ interface operations {
10667
10691
  * An example conjunction is:
10668
10692
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
10669
10693
  *
10670
- * 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.
10694
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
10671
10695
  *
10672
10696
  * The whole string must be query-encoded.
10673
10697
  */
@@ -10967,7 +10991,7 @@ interface operations {
10967
10991
  * An example conjunction is:
10968
10992
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
10969
10993
  *
10970
- * 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.
10994
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
10971
10995
  *
10972
10996
  * The whole string must be query-encoded.
10973
10997
  */
@@ -11175,7 +11199,7 @@ interface operations {
11175
11199
  * An example conjunction is:
11176
11200
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
11177
11201
  *
11178
- * 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.
11202
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
11179
11203
  *
11180
11204
  * The whole string must be query-encoded.
11181
11205
  */
@@ -12046,7 +12070,7 @@ interface operations {
12046
12070
  * An example conjunction is:
12047
12071
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
12048
12072
  *
12049
- * 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.
12073
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
12050
12074
  *
12051
12075
  * Where expression to select destination spaces for cloning attributes
12052
12076
  *
@@ -14227,7 +14251,7 @@ interface operations {
14227
14251
  * An example conjunction is:
14228
14252
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
14229
14253
  *
14230
- * 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.
14254
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
14231
14255
  *
14232
14256
  * Where expression to select destination spaces for cloning change orders
14233
14257
  *
@@ -15191,7 +15215,7 @@ interface operations {
15191
15215
  * An example conjunction is:
15192
15216
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
15193
15217
  *
15194
- * 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.
15218
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
15195
15219
  *
15196
15220
  * Where expression to select destination spaces for cloning change sets
15197
15221
  *
@@ -16312,7 +16336,7 @@ interface operations {
16312
16336
  * An example conjunction is:
16313
16337
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
16314
16338
  *
16315
- * 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.
16339
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
16316
16340
  *
16317
16341
  * Where expression to select destination spaces for cloning change workflows
16318
16342
  *
@@ -17513,7 +17537,7 @@ interface operations {
17513
17537
  * An example conjunction is:
17514
17538
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
17515
17539
  *
17516
- * 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.
17540
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
17517
17541
  *
17518
17542
  * Where expression to select destination spaces for cloning channels
17519
17543
  *
@@ -20079,7 +20103,7 @@ interface operations {
20079
20103
  * An example conjunction is:
20080
20104
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
20081
20105
  *
20082
- * 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.
20106
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
20083
20107
  *
20084
20108
  * Where expression to select destination spaces for cloning filters
20085
20109
  *
@@ -22138,7 +22162,7 @@ interface operations {
22138
22162
  * An example conjunction is:
22139
22163
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
22140
22164
  *
22141
- * 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.
22165
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
22142
22166
  *
22143
22167
  * Where expression to select destination spaces for cloning invocations
22144
22168
  *
@@ -25661,7 +25685,7 @@ interface operations {
25661
25685
  * An example conjunction is:
25662
25686
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
25663
25687
  *
25664
- * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
25688
+ * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
25665
25689
  *
25666
25690
  * The whole string must be query-encoded.
25667
25691
  */
@@ -28654,7 +28678,7 @@ interface operations {
28654
28678
  * An example conjunction is:
28655
28679
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
28656
28680
  *
28657
- * 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.
28681
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
28658
28682
  *
28659
28683
  * The whole string must be query-encoded.
28660
28684
  */
@@ -30930,14 +30954,14 @@ interface operations {
30930
30954
  };
30931
30955
  responses: {
30932
30956
  /**
30933
- * @description BridgeWorker represents a bridge worker in ConfigHub.
30934
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
30935
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
30936
- * to be applied. Bridge workers are responsible for executing configuration changes on
30937
- * remote targets and reporting status back to ConfigHub.
30957
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
30958
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
30959
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
30960
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
30961
+ * only through Releases, so a worker does not apply it to targets.
30938
30962
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
30939
30963
  * required for authentication with the ConfigHub server. These credentials allow the
30940
- * bridge worker to establish a secure connection and receive configuration actions.
30964
+ * bridge worker to establish a secure connection and receive function invocations.
30941
30965
  */
30942
30966
  200: {
30943
30967
  headers: {
@@ -31135,14 +31159,14 @@ interface operations {
31135
31159
  };
31136
31160
  responses: {
31137
31161
  /**
31138
- * @description BridgeWorker represents a bridge worker in ConfigHub.
31139
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
31140
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
31141
- * to be applied. Bridge workers are responsible for executing configuration changes on
31142
- * remote targets and reporting status back to ConfigHub.
31162
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
31163
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
31164
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
31165
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
31166
+ * only through Releases, so a worker does not apply it to targets.
31143
31167
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
31144
31168
  * required for authentication with the ConfigHub server. These credentials allow the
31145
- * bridge worker to establish a secure connection and receive configuration actions.
31169
+ * bridge worker to establish a secure connection and receive function invocations.
31146
31170
  */
31147
31171
  200: {
31148
31172
  headers: {
@@ -31365,14 +31389,14 @@ interface operations {
31365
31389
  };
31366
31390
  responses: {
31367
31391
  /**
31368
- * @description BridgeWorker represents a bridge worker in ConfigHub.
31369
- * A bridge worker is a worker program that connects ConfigHub to external systems and targets.
31370
- * It acts as a bridge between ConfigHub and the infrastructure where configurations need
31371
- * to be applied. Bridge workers are responsible for executing configuration changes on
31372
- * remote targets and reporting status back to ConfigHub.
31392
+ * @description BridgeWorker represents a worker in ConfigHub: an identity, with a secret,
31393
+ * for a program that connects to ConfigHub to serve external functions. Workers are deprecated
31394
+ * for anything else: a ServiceAccount is the identity for automation, including a GitOps tool
31395
+ * pulling Releases, and a Channel carries events and commands. Configuration reaches clusters
31396
+ * only through Releases, so a worker does not apply it to targets.
31373
31397
  * When starting a bridge worker program, both the BridgeWorkerID and Secret are
31374
31398
  * required for authentication with the ConfigHub server. These credentials allow the
31375
- * bridge worker to establish a secure connection and receive configuration actions.
31399
+ * bridge worker to establish a secure connection and receive function invocations.
31376
31400
  */
31377
31401
  200: {
31378
31402
  headers: {
@@ -39199,7 +39223,7 @@ interface operations {
39199
39223
  * An example conjunction is:
39200
39224
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
39201
39225
  *
39202
- * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
39226
+ * Supported attributes for filtering on Release: Annotations, ChangeOrderID, CreatedAt, DeleteGates, Digest, HiddenReason, Labels, LiveStatus, ManifestDigest, OCIRepositoryURL, OrganizationID, Permissions, Published, ReleaseID, ReleaseNum, SkippedUnits, SpaceID, TagID, TargetID, UnitCount, UpdatedAt, UserID.
39203
39227
  *
39204
39228
  * The whole string must be query-encoded.
39205
39229
  */
@@ -46683,13 +46707,16 @@ interface operations {
46683
46707
  requestBody?: never;
46684
46708
  responses: {
46685
46709
  /**
46686
- * @description UnitEvent represents an event of action performed on a Unit's configuration. Each action tracks
46687
- * the lifecycle of applying, destroying, or refreshing a Unit's configuration in the target
46688
- * live system. The event captures the current status of the operation, any configuration
46689
- * drift detected, and timing information about when the action started and completed.
46690
- * Actions are atomic from ConfigHub's perspective but may involve multiple steps
46691
- * in the connected Bridge. The status and drift detection help track the health
46692
- * and consistency of the provisioned configuration compared to what is defined in the Unit.
46710
+ * @description UnitEvent records the outcome of a UnitAction on a Unit: the result a worker reported for an
46711
+ * operation queued for it, such as a function invocation on the Unit completing or failing, or a
46712
+ * cancellation being acknowledged, and the failure of an operation that could not be delivered to
46713
+ * its worker. Each event records the action, its result and status, any message, and when the
46714
+ * operation started and ended. UnitEvents are numbered per Unit by UnitEventNum.
46715
+ *
46716
+ * UnitEvents do not report on live systems. Configuration reaches live systems through Releases,
46717
+ * which GitOps tools such as Argo CD and Flux pull. Events written by bridge workers, which applied,
46718
+ * destroyed, and refreshed Units in live systems and have been removed, can remain in a Unit's
46719
+ * history, but are no longer written.
46693
46720
  */
46694
46721
  200: {
46695
46722
  headers: {
@@ -48016,7 +48043,7 @@ interface operations {
48016
48043
  * An example conjunction is:
48017
48044
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
48018
48045
  *
48019
- * 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.
48046
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
48020
48047
  *
48021
48048
  * Where expression to select destination spaces for cloning tags
48022
48049
  *
@@ -49129,7 +49156,7 @@ interface operations {
49129
49156
  * An example conjunction is:
49130
49157
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
49131
49158
  *
49132
- * 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.
49159
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
49133
49160
  *
49134
49161
  * Where expression to select destination spaces for cloning targets
49135
49162
  *
@@ -50334,7 +50361,7 @@ interface operations {
50334
50361
  * An example conjunction is:
50335
50362
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
50336
50363
  *
50337
- * 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.
50364
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
50338
50365
  *
50339
50366
  * Where expression to select destination spaces for cloning triggers
50340
50367
  *
@@ -51595,7 +51622,7 @@ interface operations {
51595
51622
  * An example conjunction is:
51596
51623
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
51597
51624
  *
51598
- * 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.
51625
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
51599
51626
  *
51600
51627
  * Where expression to select destination spaces for cloning units
51601
51628
  *
@@ -55027,7 +55054,7 @@ interface operations {
55027
55054
  * An example conjunction is:
55028
55055
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
55029
55056
  *
55030
- * 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.
55057
+ * Supported attributes for filtering on Space: Annotations, AttributeFilterID, AttributeHash, AttributeIDs, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OCIRepositoryURL, OrganizationID, Permissions, ReleaseTargetID, Slug, SpaceID, TriggerFilterID, TriggerHash, TriggerIDs, UpdatedAt, UpstreamSpaceID.
55031
55058
  *
55032
55059
  * Where expression to select destination spaces for cloning views
55033
55060
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.8.30",
3
+ "version": "0.8.31",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {