@confighub/api 0.11.8 → 0.11.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 +164 -860
- package/dist/index.d.ts +164 -860
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2974,46 +2974,6 @@ interface paths {
|
|
|
2974
2974
|
patch?: never;
|
|
2975
2975
|
trace?: never;
|
|
2976
2976
|
};
|
|
2977
|
-
"/space/{space_id}/unit/{unit_id}/unit_event": {
|
|
2978
|
-
parameters: {
|
|
2979
|
-
query?: never;
|
|
2980
|
-
header?: never;
|
|
2981
|
-
path?: never;
|
|
2982
|
-
cookie?: never;
|
|
2983
|
-
};
|
|
2984
|
-
/**
|
|
2985
|
-
* List UnitEvents
|
|
2986
|
-
* @description List UnitEvents
|
|
2987
|
-
*/
|
|
2988
|
-
get: operations["ListUnitEvents"];
|
|
2989
|
-
put?: never;
|
|
2990
|
-
post?: never;
|
|
2991
|
-
delete?: never;
|
|
2992
|
-
options?: never;
|
|
2993
|
-
head?: never;
|
|
2994
|
-
patch?: never;
|
|
2995
|
-
trace?: never;
|
|
2996
|
-
};
|
|
2997
|
-
"/space/{space_id}/unit/{unit_id}/unit_event/{unit_event_id}": {
|
|
2998
|
-
parameters: {
|
|
2999
|
-
query?: never;
|
|
3000
|
-
header?: never;
|
|
3001
|
-
path?: never;
|
|
3002
|
-
cookie?: never;
|
|
3003
|
-
};
|
|
3004
|
-
/**
|
|
3005
|
-
* Get UnitEvent
|
|
3006
|
-
* @description Get UnitEvent
|
|
3007
|
-
*/
|
|
3008
|
-
get: operations["GetUnitEvent"];
|
|
3009
|
-
put?: never;
|
|
3010
|
-
post?: never;
|
|
3011
|
-
delete?: never;
|
|
3012
|
-
options?: never;
|
|
3013
|
-
head?: never;
|
|
3014
|
-
patch?: never;
|
|
3015
|
-
trace?: never;
|
|
3016
|
-
};
|
|
3017
2977
|
"/space/{space_id}/view": {
|
|
3018
2978
|
parameters: {
|
|
3019
2979
|
query?: never;
|
|
@@ -3382,26 +3342,6 @@ interface paths {
|
|
|
3382
3342
|
patch?: never;
|
|
3383
3343
|
trace?: never;
|
|
3384
3344
|
};
|
|
3385
|
-
"/unit_event": {
|
|
3386
|
-
parameters: {
|
|
3387
|
-
query?: never;
|
|
3388
|
-
header?: never;
|
|
3389
|
-
path?: never;
|
|
3390
|
-
cookie?: never;
|
|
3391
|
-
};
|
|
3392
|
-
/**
|
|
3393
|
-
* List of UnitEvents across units
|
|
3394
|
-
* @description Retrieves a list of UnitEvents across units in the Organization. By default, returns at most one UnitEvent per unit (the most recent). Set `distinct_on=Off` to receive every matching UnitEvent instead, undeduped -- paginate with `limit`/`offset` to walk the full result set (`distinct_on=Off` requires an explicit `limit` and a non-empty `where` or `filter`, since without deduplication or a filter there is nothing bounding the result set)
|
|
3395
|
-
*/
|
|
3396
|
-
get: operations["ListAllUnitEvents"];
|
|
3397
|
-
put?: never;
|
|
3398
|
-
post?: never;
|
|
3399
|
-
delete?: never;
|
|
3400
|
-
options?: never;
|
|
3401
|
-
head?: never;
|
|
3402
|
-
patch?: never;
|
|
3403
|
-
trace?: never;
|
|
3404
|
-
};
|
|
3405
3345
|
"/unit_mutation_sources": {
|
|
3406
3346
|
parameters: {
|
|
3407
3347
|
query?: never;
|
|
@@ -3537,12 +3477,6 @@ interface paths {
|
|
|
3537
3477
|
}
|
|
3538
3478
|
interface components {
|
|
3539
3479
|
schemas: {
|
|
3540
|
-
/** @enum {string} */
|
|
3541
|
-
ActionResultType: ActionResultType;
|
|
3542
|
-
/** @enum {string} */
|
|
3543
|
-
ActionStatusType: ActionStatusType;
|
|
3544
|
-
/** @enum {string} */
|
|
3545
|
-
ActionType: ActionType;
|
|
3546
3480
|
/** @description Information provided to clients by the server. */
|
|
3547
3481
|
ApiInfo: {
|
|
3548
3482
|
readonly AuthIssuer?: string;
|
|
@@ -5956,8 +5890,6 @@ interface components {
|
|
|
5956
5890
|
HeadRevision?: components["schemas"]["Revision"];
|
|
5957
5891
|
/** @description The Unit's current LastReleasedRevision */
|
|
5958
5892
|
LastReleasedRevision?: components["schemas"]["Revision"];
|
|
5959
|
-
/** @description The latest event that took place on the Unit. */
|
|
5960
|
-
LatestUnitEvent?: components["schemas"]["UnitEvent"];
|
|
5961
5893
|
/** @description The Organization the Unit belongs to. */
|
|
5962
5894
|
Organization?: components["schemas"]["Organization"];
|
|
5963
5895
|
Permissions?: components["schemas"]["ExtendedPermissions"];
|
|
@@ -8646,11 +8578,6 @@ interface components {
|
|
|
8646
8578
|
* @description Sequence number the head Revision.
|
|
8647
8579
|
*/
|
|
8648
8580
|
readonly HeadRevisionNum?: number;
|
|
8649
|
-
/**
|
|
8650
|
-
* Format: int64
|
|
8651
|
-
* @description Sequence number of the head unit event.
|
|
8652
|
-
*/
|
|
8653
|
-
readonly HeadUnitEventNum?: number;
|
|
8654
8581
|
/** @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. */
|
|
8655
8582
|
HiddenReason?: string;
|
|
8656
8583
|
/** @description An optional map of Label key/value pairs to specify identifying attributes of entities for the purpose of grouping and filtering them. */
|
|
@@ -8902,95 +8829,6 @@ interface components {
|
|
|
8902
8829
|
*/
|
|
8903
8830
|
UnitID?: string;
|
|
8904
8831
|
};
|
|
8905
|
-
/**
|
|
8906
|
-
* @description UnitEvent is a historical record of the outcome of an operation on a
|
|
8907
|
-
* Unit, such as a function invocation completing or failing, or a cancellation being acknowledged.
|
|
8908
|
-
* Each event records the action, its result and status, any message, and when the operation started
|
|
8909
|
-
* and ended. UnitEvents are numbered per Unit by UnitEventNum.
|
|
8910
|
-
*
|
|
8911
|
-
* The workers that performed these operations have been removed, so no new UnitEvents are written;
|
|
8912
|
-
* existing ones remain in a Unit's history.
|
|
8913
|
-
*/
|
|
8914
|
-
UnitEvent: {
|
|
8915
|
-
/** @description Action is the operation the event reports on, such as InvokeFunctions, Cancel, or Apply. */
|
|
8916
|
-
Action?: components["schemas"]["ActionType"];
|
|
8917
|
-
/**
|
|
8918
|
-
* Format: date-time
|
|
8919
|
-
* @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
|
|
8920
|
-
* @example 2025-04-04T11:50:02.95102-07:00
|
|
8921
|
-
*/
|
|
8922
|
-
readonly CreatedAt?: string;
|
|
8923
|
-
/** @description The type of entity. */
|
|
8924
|
-
readonly EntityType?: string;
|
|
8925
|
-
/** @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. */
|
|
8926
|
-
HiddenReason?: string;
|
|
8927
|
-
/** @description Message is the message reported with the result. */
|
|
8928
|
-
Message?: string;
|
|
8929
|
-
/**
|
|
8930
|
-
* Format: uuid
|
|
8931
|
-
* @description Unique identifier for an Organization.
|
|
8932
|
-
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8933
|
-
*/
|
|
8934
|
-
OrganizationID?: string;
|
|
8935
|
-
/** @description Result is what the operation produced: FunctionInvocationCompleted or FunctionInvocationFailed for a function invocation, and None otherwise. */
|
|
8936
|
-
Result?: components["schemas"]["ActionResultType"];
|
|
8937
|
-
/**
|
|
8938
|
-
* Format: int64
|
|
8939
|
-
* @description RevisionNum is the number of the Unit's Revision the action was performed on.
|
|
8940
|
-
*/
|
|
8941
|
-
RevisionNum?: number;
|
|
8942
|
-
/**
|
|
8943
|
-
* Format: uuid
|
|
8944
|
-
* @description Unique identifier for a space.
|
|
8945
|
-
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8946
|
-
*/
|
|
8947
|
-
SpaceID?: string;
|
|
8948
|
-
/** @description Slug of the Space this entity belongs to. (readonly) */
|
|
8949
|
-
readonly SpaceSlug?: string;
|
|
8950
|
-
/**
|
|
8951
|
-
* Format: date-time
|
|
8952
|
-
* @description StartedAt is when the operation started, in "2023-01-01T12:00:00Z" format.
|
|
8953
|
-
* @example 2006-01-02T15:04:05Z07:00
|
|
8954
|
-
*/
|
|
8955
|
-
StartedAt?: string;
|
|
8956
|
-
/** @description Status is the state of the operation the event reports: None, Pending, Submitted, Progressing, Completed, Failed, Canceled, or Aborted. */
|
|
8957
|
-
Status?: components["schemas"]["ActionStatusType"];
|
|
8958
|
-
/**
|
|
8959
|
-
* Format: date-time
|
|
8960
|
-
* @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.
|
|
8961
|
-
*/
|
|
8962
|
-
TerminatedAt?: string | null;
|
|
8963
|
-
/**
|
|
8964
|
-
* Format: uuid
|
|
8965
|
-
* @description UnitEventID is the unique identifier for this UnitEvent.
|
|
8966
|
-
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8967
|
-
*/
|
|
8968
|
-
UnitEventID?: string;
|
|
8969
|
-
/**
|
|
8970
|
-
* Format: int64
|
|
8971
|
-
* @description UnitEventNum is the sequence number of this UnitEvent among the Unit's UnitEvents.
|
|
8972
|
-
*/
|
|
8973
|
-
UnitEventNum?: number;
|
|
8974
|
-
/**
|
|
8975
|
-
* Format: uuid
|
|
8976
|
-
* @description Unique identifier for a Unit.
|
|
8977
|
-
* @example 248df4b7-aa70-47b8-a036-33ac447e668d
|
|
8978
|
-
*/
|
|
8979
|
-
UnitID?: string;
|
|
8980
|
-
/** @description Slug of the Unit this entity belongs to. (readonly) */
|
|
8981
|
-
readonly UnitSlug?: string;
|
|
8982
|
-
/**
|
|
8983
|
-
* Format: date-time
|
|
8984
|
-
* @description The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format.
|
|
8985
|
-
* @example 2025-04-04T11:50:02.95102-07:00
|
|
8986
|
-
*/
|
|
8987
|
-
readonly UpdatedAt?: string;
|
|
8988
|
-
/**
|
|
8989
|
-
* Format: int64
|
|
8990
|
-
* @description An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update.
|
|
8991
|
-
*/
|
|
8992
|
-
Version?: number;
|
|
8993
|
-
};
|
|
8994
8832
|
UnitGuardRequest: {
|
|
8995
8833
|
/** @description Recorded on the Revision the edit creates. Defaults to "Set path guards". */
|
|
8996
8834
|
ChangeDescription?: string;
|
|
@@ -10695,7 +10533,7 @@ interface operations {
|
|
|
10695
10533
|
* An example conjunction is:
|
|
10696
10534
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
10697
10535
|
*
|
|
10698
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
10536
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
10699
10537
|
*
|
|
10700
10538
|
* The Units to create entities from, with from_backing_units.
|
|
10701
10539
|
*
|
|
@@ -12046,7 +11884,7 @@ interface operations {
|
|
|
12046
11884
|
* An example conjunction is:
|
|
12047
11885
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12048
11886
|
*
|
|
12049
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
11887
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
12050
11888
|
*
|
|
12051
11889
|
* The Units to create entities from, with from_backing_units.
|
|
12052
11890
|
*
|
|
@@ -15543,7 +15381,7 @@ interface operations {
|
|
|
15543
15381
|
* An example conjunction is:
|
|
15544
15382
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15545
15383
|
*
|
|
15546
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
15384
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
15547
15385
|
*
|
|
15548
15386
|
* The Units to create entities from, with from_backing_units.
|
|
15549
15387
|
*
|
|
@@ -16752,7 +16590,7 @@ interface operations {
|
|
|
16752
16590
|
* An example conjunction is:
|
|
16753
16591
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16754
16592
|
*
|
|
16755
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
16593
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16756
16594
|
*
|
|
16757
16595
|
* The Units to create entities from, with from_backing_units.
|
|
16758
16596
|
*
|
|
@@ -19363,7 +19201,7 @@ interface operations {
|
|
|
19363
19201
|
* An example conjunction is:
|
|
19364
19202
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
19365
19203
|
*
|
|
19366
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
19204
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
19367
19205
|
*
|
|
19368
19206
|
* The Units to create entities from, with from_backing_units.
|
|
19369
19207
|
*
|
|
@@ -20328,7 +20166,7 @@ interface operations {
|
|
|
20328
20166
|
* An example conjunction is:
|
|
20329
20167
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
20330
20168
|
*
|
|
20331
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
20169
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
20332
20170
|
*
|
|
20333
20171
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
20334
20172
|
*
|
|
@@ -21434,7 +21272,7 @@ interface operations {
|
|
|
21434
21272
|
* An example conjunction is:
|
|
21435
21273
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
21436
21274
|
*
|
|
21437
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
21275
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
21438
21276
|
*
|
|
21439
21277
|
* The Units to create entities from, with from_backing_units.
|
|
21440
21278
|
*
|
|
@@ -22707,7 +22545,7 @@ interface operations {
|
|
|
22707
22545
|
* An example conjunction is:
|
|
22708
22546
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22709
22547
|
*
|
|
22710
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
22548
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
22711
22549
|
*
|
|
22712
22550
|
* The Units to create entities from, with from_backing_units, or to create links between, with from_refs.
|
|
22713
22551
|
*
|
|
@@ -36184,7 +36022,7 @@ interface operations {
|
|
|
36184
36022
|
* An example conjunction is:
|
|
36185
36023
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
36186
36024
|
*
|
|
36187
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
36025
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
36188
36026
|
*
|
|
36189
36027
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
36190
36028
|
*
|
|
@@ -41819,7 +41657,7 @@ interface operations {
|
|
|
41819
41657
|
* An example conjunction is:
|
|
41820
41658
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
41821
41659
|
*
|
|
41822
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
41660
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
41823
41661
|
*
|
|
41824
41662
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
41825
41663
|
*
|
|
@@ -41863,7 +41701,7 @@ interface operations {
|
|
|
41863
41701
|
* The attribute names are case-sensitive, PascalCase, and
|
|
41864
41702
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
41865
41703
|
*
|
|
41866
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
41704
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
41867
41705
|
*
|
|
41868
41706
|
* The whole string must be query-encoded.
|
|
41869
41707
|
*/
|
|
@@ -41914,7 +41752,7 @@ interface operations {
|
|
|
41914
41752
|
*
|
|
41915
41753
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
41916
41754
|
*
|
|
41917
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum,
|
|
41755
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
41918
41756
|
*
|
|
41919
41757
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
41920
41758
|
*
|
|
@@ -42148,7 +41986,7 @@ interface operations {
|
|
|
42148
41986
|
* The attribute names are case-sensitive, PascalCase, and
|
|
42149
41987
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
42150
41988
|
*
|
|
42151
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
41989
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
42152
41990
|
*
|
|
42153
41991
|
* The whole string must be query-encoded.
|
|
42154
41992
|
*/
|
|
@@ -45558,296 +45396,6 @@ interface operations {
|
|
|
45558
45396
|
};
|
|
45559
45397
|
};
|
|
45560
45398
|
};
|
|
45561
|
-
ListUnitEvents: {
|
|
45562
|
-
parameters: {
|
|
45563
|
-
query?: {
|
|
45564
|
-
/**
|
|
45565
|
-
* @description The specified string is an expression for the purpose of filtering
|
|
45566
|
-
* the list of UnitEvents returned. The expression syntax was inspired by SQL.
|
|
45567
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
45568
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
45569
|
-
* as in the JSON encoding.
|
|
45570
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
45571
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
45572
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
45573
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
45574
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
45575
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
45576
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
45577
|
-
* UUID and time literals must be quoted as string literals.
|
|
45578
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
45579
|
-
* Time literals use the same form as when serialized as JSON,
|
|
45580
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
45581
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
45582
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
45583
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
45584
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
45585
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
45586
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
45587
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
45588
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
45589
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
45590
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
45591
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
45592
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
45593
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
45594
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
45595
|
-
* Conjunctions are supported using the `AND` operator.
|
|
45596
|
-
* An example conjunction is:
|
|
45597
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
45598
|
-
*
|
|
45599
|
-
* Supported attributes for filtering on UnitEvent: Action, CreatedAt, HiddenReason, OrganizationID, Result, RevisionNum, SpaceID, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt.
|
|
45600
|
-
*
|
|
45601
|
-
* The whole string must be query-encoded.
|
|
45602
|
-
*/
|
|
45603
|
-
where?: string;
|
|
45604
|
-
/**
|
|
45605
|
-
* @description UUID of a Filter entity to apply to the UnitEvent list.
|
|
45606
|
-
*
|
|
45607
|
-
* The Filter must be in the same Organization as the user credentials.
|
|
45608
|
-
*
|
|
45609
|
-
* The Filter's From field must match the entity type being filtered (UnitEvent).
|
|
45610
|
-
*
|
|
45611
|
-
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
45612
|
-
*
|
|
45613
|
-
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
45614
|
-
*
|
|
45615
|
-
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
45616
|
-
*/
|
|
45617
|
-
filter?: string;
|
|
45618
|
-
/**
|
|
45619
|
-
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
45620
|
-
*
|
|
45621
|
-
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
45622
|
-
*
|
|
45623
|
-
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
45624
|
-
*
|
|
45625
|
-
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
45626
|
-
*
|
|
45627
|
-
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
45628
|
-
*
|
|
45629
|
-
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
45630
|
-
*
|
|
45631
|
-
* Searchable fields for UnitEvent include string and map-type attributes from the queryable attributes list.
|
|
45632
|
-
*
|
|
45633
|
-
* The whole string must be query-encoded.
|
|
45634
|
-
*/
|
|
45635
|
-
contains?: string;
|
|
45636
|
-
/**
|
|
45637
|
-
* @description Only return UnitEvent entities on which the caller has this permission, as well as View, which every entity listed needs.
|
|
45638
|
-
*
|
|
45639
|
-
* A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.
|
|
45640
|
-
*
|
|
45641
|
-
* Supported values: Manage, Edit, Use, View.
|
|
45642
|
-
*/
|
|
45643
|
-
where_permission?: PathsSpaceSpace_idUnitUnit_idUnit_eventGetParametersQueryWhere_permission;
|
|
45644
|
-
/**
|
|
45645
|
-
* @description Hidden UnitEvent entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
45646
|
-
*
|
|
45647
|
-
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
45648
|
-
*
|
|
45649
|
-
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
45650
|
-
*
|
|
45651
|
-
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
45652
|
-
*/
|
|
45653
|
-
include_hidden?: string;
|
|
45654
|
-
/**
|
|
45655
|
-
* @deprecated
|
|
45656
|
-
* @description Deprecated: use continue. Number of UnitEvent entities to skip before returning results. Cannot be combined with continue.
|
|
45657
|
-
*/
|
|
45658
|
-
offset?: number;
|
|
45659
|
-
/** @description Maximum number of UnitEvent entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
45660
|
-
limit?: number;
|
|
45661
|
-
/**
|
|
45662
|
-
* @description Comma-separated list of fields to sort UnitEvent results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
45663
|
-
*
|
|
45664
|
-
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
45665
|
-
*
|
|
45666
|
-
* Supported attributes for ordering UnitEvent: Action, CreatedAt, HiddenReason, OrganizationID, Result, RevisionNum, StartedAt, Status, TerminatedAt, UnitEventID, UnitEventNum, UnitID, UpdatedAt.
|
|
45667
|
-
*
|
|
45668
|
-
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
45669
|
-
*
|
|
45670
|
-
* Results are ordered by the UnitEvent's ID after the fields named, and by the ID alone if none are.
|
|
45671
|
-
*
|
|
45672
|
-
* The whole string must be query-encoded.
|
|
45673
|
-
*/
|
|
45674
|
-
order_by?: string;
|
|
45675
|
-
/**
|
|
45676
|
-
* @description The token from the ConfigHub-Continue header of the previous page, to return the UnitEvent entities after it.
|
|
45677
|
-
*
|
|
45678
|
-
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
45679
|
-
*
|
|
45680
|
-
* Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
|
|
45681
|
-
*/
|
|
45682
|
-
continue?: string;
|
|
45683
|
-
};
|
|
45684
|
-
header?: never;
|
|
45685
|
-
path: {
|
|
45686
|
-
/** @description Unique identifier for a space_id */
|
|
45687
|
-
space_id: string;
|
|
45688
|
-
/** @description Unique identifier for a unit_id */
|
|
45689
|
-
unit_id: string;
|
|
45690
|
-
};
|
|
45691
|
-
cookie?: never;
|
|
45692
|
-
};
|
|
45693
|
-
requestBody?: never;
|
|
45694
|
-
responses: {
|
|
45695
|
-
/** @description OK */
|
|
45696
|
-
200: {
|
|
45697
|
-
headers: {
|
|
45698
|
-
/** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
|
|
45699
|
-
"ConfigHub-Continue"?: string;
|
|
45700
|
-
[name: string]: unknown;
|
|
45701
|
-
};
|
|
45702
|
-
content: {
|
|
45703
|
-
"application/json": components["schemas"]["UnitEvent"][];
|
|
45704
|
-
};
|
|
45705
|
-
};
|
|
45706
|
-
/** @description UnitEvent request is invalid (Bad Request). */
|
|
45707
|
-
400: {
|
|
45708
|
-
headers: {
|
|
45709
|
-
[name: string]: unknown;
|
|
45710
|
-
};
|
|
45711
|
-
content: {
|
|
45712
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45713
|
-
};
|
|
45714
|
-
};
|
|
45715
|
-
/** @description Unauthorized access. */
|
|
45716
|
-
401: {
|
|
45717
|
-
headers: {
|
|
45718
|
-
[name: string]: unknown;
|
|
45719
|
-
};
|
|
45720
|
-
content: {
|
|
45721
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45722
|
-
};
|
|
45723
|
-
};
|
|
45724
|
-
/** @description Forbidden access. */
|
|
45725
|
-
403: {
|
|
45726
|
-
headers: {
|
|
45727
|
-
[name: string]: unknown;
|
|
45728
|
-
};
|
|
45729
|
-
content: {
|
|
45730
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45731
|
-
};
|
|
45732
|
-
};
|
|
45733
|
-
/** @description UnitEvent not found. */
|
|
45734
|
-
404: {
|
|
45735
|
-
headers: {
|
|
45736
|
-
[name: string]: unknown;
|
|
45737
|
-
};
|
|
45738
|
-
content: {
|
|
45739
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45740
|
-
};
|
|
45741
|
-
};
|
|
45742
|
-
/** @description Something went wrong while processing UnitEvent. */
|
|
45743
|
-
500: {
|
|
45744
|
-
headers: {
|
|
45745
|
-
[name: string]: unknown;
|
|
45746
|
-
};
|
|
45747
|
-
content: {
|
|
45748
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45749
|
-
};
|
|
45750
|
-
};
|
|
45751
|
-
/** @description Unexpected error. */
|
|
45752
|
-
default: {
|
|
45753
|
-
headers: {
|
|
45754
|
-
[name: string]: unknown;
|
|
45755
|
-
};
|
|
45756
|
-
content: {
|
|
45757
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45758
|
-
};
|
|
45759
|
-
};
|
|
45760
|
-
};
|
|
45761
|
-
};
|
|
45762
|
-
GetUnitEvent: {
|
|
45763
|
-
parameters: {
|
|
45764
|
-
query?: never;
|
|
45765
|
-
header?: never;
|
|
45766
|
-
path: {
|
|
45767
|
-
/** @description Unique identifier for a space_id */
|
|
45768
|
-
space_id: string;
|
|
45769
|
-
/** @description Unique identifier for a unit_id */
|
|
45770
|
-
unit_id: string;
|
|
45771
|
-
/** @description Unique identifier for a unit_event_id */
|
|
45772
|
-
unit_event_id: string;
|
|
45773
|
-
};
|
|
45774
|
-
cookie?: never;
|
|
45775
|
-
};
|
|
45776
|
-
requestBody?: never;
|
|
45777
|
-
responses: {
|
|
45778
|
-
/**
|
|
45779
|
-
* @description UnitEvent is a historical record of the outcome of an operation on a
|
|
45780
|
-
* Unit, such as a function invocation completing or failing, or a cancellation being acknowledged.
|
|
45781
|
-
* Each event records the action, its result and status, any message, and when the operation started
|
|
45782
|
-
* and ended. UnitEvents are numbered per Unit by UnitEventNum.
|
|
45783
|
-
*
|
|
45784
|
-
* The workers that performed these operations have been removed, so no new UnitEvents are written;
|
|
45785
|
-
* existing ones remain in a Unit's history.
|
|
45786
|
-
*/
|
|
45787
|
-
200: {
|
|
45788
|
-
headers: {
|
|
45789
|
-
[name: string]: unknown;
|
|
45790
|
-
};
|
|
45791
|
-
content: {
|
|
45792
|
-
"application/json": components["schemas"]["UnitEvent"];
|
|
45793
|
-
};
|
|
45794
|
-
};
|
|
45795
|
-
/** @description UnitEvent request is invalid (Bad Request). */
|
|
45796
|
-
400: {
|
|
45797
|
-
headers: {
|
|
45798
|
-
[name: string]: unknown;
|
|
45799
|
-
};
|
|
45800
|
-
content: {
|
|
45801
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45802
|
-
};
|
|
45803
|
-
};
|
|
45804
|
-
/** @description Unauthorized access. */
|
|
45805
|
-
401: {
|
|
45806
|
-
headers: {
|
|
45807
|
-
[name: string]: unknown;
|
|
45808
|
-
};
|
|
45809
|
-
content: {
|
|
45810
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45811
|
-
};
|
|
45812
|
-
};
|
|
45813
|
-
/** @description Forbidden access. */
|
|
45814
|
-
403: {
|
|
45815
|
-
headers: {
|
|
45816
|
-
[name: string]: unknown;
|
|
45817
|
-
};
|
|
45818
|
-
content: {
|
|
45819
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45820
|
-
};
|
|
45821
|
-
};
|
|
45822
|
-
/** @description UnitEvent not found. */
|
|
45823
|
-
404: {
|
|
45824
|
-
headers: {
|
|
45825
|
-
[name: string]: unknown;
|
|
45826
|
-
};
|
|
45827
|
-
content: {
|
|
45828
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45829
|
-
};
|
|
45830
|
-
};
|
|
45831
|
-
/** @description Something went wrong while processing UnitEvent. */
|
|
45832
|
-
500: {
|
|
45833
|
-
headers: {
|
|
45834
|
-
[name: string]: unknown;
|
|
45835
|
-
};
|
|
45836
|
-
content: {
|
|
45837
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45838
|
-
};
|
|
45839
|
-
};
|
|
45840
|
-
/** @description Unexpected error. */
|
|
45841
|
-
default: {
|
|
45842
|
-
headers: {
|
|
45843
|
-
[name: string]: unknown;
|
|
45844
|
-
};
|
|
45845
|
-
content: {
|
|
45846
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
45847
|
-
};
|
|
45848
|
-
};
|
|
45849
|
-
};
|
|
45850
|
-
};
|
|
45851
45399
|
ListViews: {
|
|
45852
45400
|
parameters: {
|
|
45853
45401
|
query?: {
|
|
@@ -48308,7 +47856,7 @@ interface operations {
|
|
|
48308
47856
|
* An example conjunction is:
|
|
48309
47857
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
48310
47858
|
*
|
|
48311
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
47859
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
48312
47860
|
*
|
|
48313
47861
|
* The Units to create entities from, with from_backing_units.
|
|
48314
47862
|
*
|
|
@@ -49521,7 +49069,7 @@ interface operations {
|
|
|
49521
49069
|
* An example conjunction is:
|
|
49522
49070
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
49523
49071
|
*
|
|
49524
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
49072
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
49525
49073
|
*
|
|
49526
49074
|
* The Units to create entities from, with from_backing_units.
|
|
49527
49075
|
*
|
|
@@ -50384,7 +49932,7 @@ interface operations {
|
|
|
50384
49932
|
* An example conjunction is:
|
|
50385
49933
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
50386
49934
|
*
|
|
50387
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
49935
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
50388
49936
|
*
|
|
50389
49937
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
50390
49938
|
*
|
|
@@ -50428,7 +49976,7 @@ interface operations {
|
|
|
50428
49976
|
* The attribute names are case-sensitive, PascalCase, and
|
|
50429
49977
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
50430
49978
|
*
|
|
50431
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
49979
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
50432
49980
|
*
|
|
50433
49981
|
* The whole string must be query-encoded.
|
|
50434
49982
|
*/
|
|
@@ -50479,7 +50027,7 @@ interface operations {
|
|
|
50479
50027
|
*
|
|
50480
50028
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
50481
50029
|
*
|
|
50482
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum,
|
|
50030
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
50483
50031
|
*
|
|
50484
50032
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
50485
50033
|
*
|
|
@@ -50620,7 +50168,7 @@ interface operations {
|
|
|
50620
50168
|
* An example conjunction is:
|
|
50621
50169
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
50622
50170
|
*
|
|
50623
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
50171
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
50624
50172
|
*
|
|
50625
50173
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
50626
50174
|
*
|
|
@@ -50674,11 +50222,11 @@ interface operations {
|
|
|
50674
50222
|
* The attribute names are case-sensitive, PascalCase, and
|
|
50675
50223
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
50676
50224
|
*
|
|
50677
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
50225
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
50678
50226
|
*
|
|
50679
50227
|
* A write also accepts the parts of its result: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
50680
50228
|
*
|
|
50681
|
-
* Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
50229
|
+
* Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
|
|
50682
50230
|
*
|
|
50683
50231
|
* The whole string must be query-encoded.
|
|
50684
50232
|
*/
|
|
@@ -50980,7 +50528,7 @@ interface operations {
|
|
|
50980
50528
|
* An example conjunction is:
|
|
50981
50529
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
50982
50530
|
*
|
|
50983
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
50531
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
50984
50532
|
*
|
|
50985
50533
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
50986
50534
|
*
|
|
@@ -51034,7 +50582,7 @@ interface operations {
|
|
|
51034
50582
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51035
50583
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51036
50584
|
*
|
|
51037
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
50585
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
51038
50586
|
*
|
|
51039
50587
|
* The whole string must be query-encoded.
|
|
51040
50588
|
*/
|
|
@@ -51193,7 +50741,7 @@ interface operations {
|
|
|
51193
50741
|
* An example conjunction is:
|
|
51194
50742
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51195
50743
|
*
|
|
51196
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
50744
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
51197
50745
|
*
|
|
51198
50746
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
51199
50747
|
*
|
|
@@ -51247,11 +50795,11 @@ interface operations {
|
|
|
51247
50795
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51248
50796
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51249
50797
|
*
|
|
51250
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
50798
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
51251
50799
|
*
|
|
51252
50800
|
* A write also accepts the parts of its result: ConfigData for the configuration the operation produced, MutationSources for what set each value in it, and Diff for what the operation changed, path by path with the values on both sides. None is a field of a Unit, and each costs something to return, so they are returned only when named. A dry run stores nothing, so this is the only way to see what it would have produced.
|
|
51253
50801
|
*
|
|
51254
|
-
* Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
50802
|
+
* Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
|
|
51255
50803
|
*
|
|
51256
50804
|
* The whole string must be query-encoded.
|
|
51257
50805
|
*/
|
|
@@ -51542,7 +51090,7 @@ interface operations {
|
|
|
51542
51090
|
* An example conjunction is:
|
|
51543
51091
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51544
51092
|
*
|
|
51545
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
51093
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
51546
51094
|
*
|
|
51547
51095
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
51548
51096
|
*
|
|
@@ -51596,7 +51144,7 @@ interface operations {
|
|
|
51596
51144
|
* The attribute names are case-sensitive, PascalCase, and
|
|
51597
51145
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
51598
51146
|
*
|
|
51599
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
51147
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
51600
51148
|
*
|
|
51601
51149
|
* The whole string must be query-encoded.
|
|
51602
51150
|
*/
|
|
@@ -51697,207 +51245,7 @@ interface operations {
|
|
|
51697
51245
|
};
|
|
51698
51246
|
};
|
|
51699
51247
|
};
|
|
51700
|
-
BulkTagUnits: {
|
|
51701
|
-
parameters: {
|
|
51702
|
-
query?: {
|
|
51703
|
-
/**
|
|
51704
|
-
* @description The specified string is an expression for the purpose of filtering
|
|
51705
|
-
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
51706
|
-
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
51707
|
-
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
51708
|
-
* as in the JSON encoding.
|
|
51709
|
-
* Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `NOT LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `~*`, `!~`, `!~*`, `IN`, `NOT IN`.
|
|
51710
|
-
* String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards,
|
|
51711
|
-
* `ILIKE` for case-insensitive pattern matching, `NOT LIKE` and `!~~` for negated pattern matching.
|
|
51712
|
-
* String regex operators: `~` for regex matching, `~*` for case-insensitive regex,
|
|
51713
|
-
* `!~` and `!~*` for regex not matching (case-sensitive and insensitive).
|
|
51714
|
-
* Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`.
|
|
51715
|
-
* UUIDs and boolean attributes support equality and inequality only.
|
|
51716
|
-
* UUID and time literals must be quoted as string literals.
|
|
51717
|
-
* String literals are quoted with single quotes, such as `'string'`.
|
|
51718
|
-
* Time literals use the same form as when serialized as JSON,
|
|
51719
|
-
* such as: `CreatedAt > '2025-02-18T23:16:34'`.
|
|
51720
|
-
* Integer and boolean literals are also supported for attributes of those types.
|
|
51721
|
-
* Arrays support the `?` operator to to match any element of the array,
|
|
51722
|
-
* as in `FromLinkID ? '7c61626f-ddbe-41af-93f6-b69f4ab6d308'`.
|
|
51723
|
-
* Arrays can perform LEN() to check for length, as in `LEN(FromLinkID) > 0`.
|
|
51724
|
-
* An attribute naming a list of other entities can be filtered on their attributes with a `*` segment,
|
|
51725
|
-
* as in `FromLink.*.Slug = 'upgrade-app'`, which holds when any element satisfies it.
|
|
51726
|
-
* Without the `*` such a reference is an error, since it names no single value to compare.
|
|
51727
|
-
* Map support the dot notation to specify a particular map key, as in `Labels.tier = 'Backend'`.
|
|
51728
|
-
* Maps support `IS NULL` and `IS NOT NULL` with dot notation to check for key absence or presence,
|
|
51729
|
-
* as in `Labels.tier IS NULL` (key doesn't exist) or `Labels.tier IS NOT NULL` (key exists).
|
|
51730
|
-
* Comparison results can be tested with `IS TRUE`, `IS FALSE`, `IS NOT TRUE`, and `IS NOT FALSE`.
|
|
51731
|
-
* These are useful for nullable columns: `MergeSourceID = '<uuid>' IS NOT FALSE` matches rows where MergeSourceID equals the value OR is NULL.
|
|
51732
|
-
* The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses,
|
|
51733
|
-
* such as `Slug IN ('slugone', 'slugtwo')` or `Labels.environment IN ('prod', 'staging')`.
|
|
51734
|
-
* Conjunctions are supported using the `AND` operator.
|
|
51735
|
-
* An example conjunction is:
|
|
51736
|
-
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51737
|
-
*
|
|
51738
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
51739
|
-
*
|
|
51740
|
-
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
51741
|
-
*
|
|
51742
|
-
* The whole string must be query-encoded.
|
|
51743
|
-
*/
|
|
51744
|
-
where?: string;
|
|
51745
|
-
/**
|
|
51746
|
-
* @description UUID of a Filter entity to apply to the Unit list.
|
|
51747
|
-
*
|
|
51748
|
-
* The Filter must be in the same Organization as the user credentials.
|
|
51749
|
-
*
|
|
51750
|
-
* The Filter's From field must match the entity type being filtered (Unit).
|
|
51751
|
-
*
|
|
51752
|
-
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
51753
|
-
*
|
|
51754
|
-
* The Filter's Where clause will be combined with any explicit 'where' parameter using AND logic.
|
|
51755
|
-
*
|
|
51756
|
-
* If both 'filter' and 'where' parameters are specified, they are combined with AND logic.
|
|
51757
|
-
*/
|
|
51758
|
-
filter?: string;
|
|
51759
|
-
/**
|
|
51760
|
-
* @description Free text search that approximately matches the specified string against string fields and map keys/values.
|
|
51761
|
-
*
|
|
51762
|
-
* The search is case-insensitive and uses pattern matching to find entities containing the text.
|
|
51763
|
-
*
|
|
51764
|
-
* Searchable string fields include attributes like Slug, DisplayName, and string-typed custom fields.
|
|
51765
|
-
*
|
|
51766
|
-
* For map fields (like Labels and Annotations), the search matches both map keys and values.
|
|
51767
|
-
*
|
|
51768
|
-
* The search uses OR logic across all searchable fields, so matching any field will return the entity.
|
|
51769
|
-
*
|
|
51770
|
-
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
51771
|
-
*
|
|
51772
|
-
* Searchable fields for Unit include string and map-type attributes from the queryable attributes list.
|
|
51773
|
-
*
|
|
51774
|
-
* The whole string must be query-encoded.
|
|
51775
|
-
*/
|
|
51776
|
-
contains?: string;
|
|
51777
|
-
/**
|
|
51778
|
-
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
51779
|
-
*
|
|
51780
|
-
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
51781
|
-
*
|
|
51782
|
-
* A where clause naming the entities, by their Slug or ID with `=` or `IN`, or naming HiddenReason at all, also returns hidden entities it selects.
|
|
51783
|
-
*
|
|
51784
|
-
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
51785
|
-
*/
|
|
51786
|
-
include_hidden?: string;
|
|
51787
|
-
/**
|
|
51788
|
-
* @description Include clause for expanding related entities in the response for Unit.
|
|
51789
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
51790
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
51791
|
-
*
|
|
51792
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
51793
|
-
*
|
|
51794
|
-
* The whole string must be query-encoded.
|
|
51795
|
-
*/
|
|
51796
|
-
include?: string;
|
|
51797
|
-
};
|
|
51798
|
-
header?: never;
|
|
51799
|
-
path?: never;
|
|
51800
|
-
cookie?: never;
|
|
51801
|
-
};
|
|
51802
|
-
requestBody?: {
|
|
51803
|
-
content: {
|
|
51804
|
-
"application/json": components["schemas"]["UnitTagRequest"];
|
|
51805
|
-
};
|
|
51806
|
-
};
|
|
51807
|
-
responses: {
|
|
51808
|
-
/** @description OK */
|
|
51809
|
-
200: {
|
|
51810
|
-
headers: {
|
|
51811
|
-
[name: string]: unknown;
|
|
51812
|
-
};
|
|
51813
|
-
content: {
|
|
51814
|
-
"application/json": components["schemas"]["UnitTagResponse"][];
|
|
51815
|
-
};
|
|
51816
|
-
};
|
|
51817
|
-
/** @description Multi-Status: Mixed success and failure results */
|
|
51818
|
-
207: {
|
|
51819
|
-
headers: {
|
|
51820
|
-
[name: string]: unknown;
|
|
51821
|
-
};
|
|
51822
|
-
content: {
|
|
51823
|
-
"application/json": components["schemas"]["UnitTagResponse"][];
|
|
51824
|
-
};
|
|
51825
|
-
};
|
|
51826
|
-
/** @description Unit request is invalid (Bad Request). */
|
|
51827
|
-
400: {
|
|
51828
|
-
headers: {
|
|
51829
|
-
[name: string]: unknown;
|
|
51830
|
-
};
|
|
51831
|
-
content: {
|
|
51832
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51833
|
-
};
|
|
51834
|
-
};
|
|
51835
|
-
/** @description Unauthorized access. */
|
|
51836
|
-
401: {
|
|
51837
|
-
headers: {
|
|
51838
|
-
[name: string]: unknown;
|
|
51839
|
-
};
|
|
51840
|
-
content: {
|
|
51841
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51842
|
-
};
|
|
51843
|
-
};
|
|
51844
|
-
/** @description Forbidden access. */
|
|
51845
|
-
403: {
|
|
51846
|
-
headers: {
|
|
51847
|
-
[name: string]: unknown;
|
|
51848
|
-
};
|
|
51849
|
-
content: {
|
|
51850
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51851
|
-
};
|
|
51852
|
-
};
|
|
51853
|
-
/** @description Unit not found. */
|
|
51854
|
-
404: {
|
|
51855
|
-
headers: {
|
|
51856
|
-
[name: string]: unknown;
|
|
51857
|
-
};
|
|
51858
|
-
content: {
|
|
51859
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51860
|
-
};
|
|
51861
|
-
};
|
|
51862
|
-
/** @description Unit data conflict. Data has changed since last read. */
|
|
51863
|
-
409: {
|
|
51864
|
-
headers: {
|
|
51865
|
-
[name: string]: unknown;
|
|
51866
|
-
};
|
|
51867
|
-
content: {
|
|
51868
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51869
|
-
};
|
|
51870
|
-
};
|
|
51871
|
-
/** @description Moving a change order's release tag to a Revision a release of the change could not deliver: before its end tag or the last released Revision, with validation errors, or in a Space where a release has been published at it */
|
|
51872
|
-
422: {
|
|
51873
|
-
headers: {
|
|
51874
|
-
[name: string]: unknown;
|
|
51875
|
-
};
|
|
51876
|
-
content: {
|
|
51877
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51878
|
-
};
|
|
51879
|
-
};
|
|
51880
|
-
/** @description Something went wrong while processing Unit. */
|
|
51881
|
-
500: {
|
|
51882
|
-
headers: {
|
|
51883
|
-
[name: string]: unknown;
|
|
51884
|
-
};
|
|
51885
|
-
content: {
|
|
51886
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51887
|
-
};
|
|
51888
|
-
};
|
|
51889
|
-
/** @description Unexpected error. */
|
|
51890
|
-
default: {
|
|
51891
|
-
headers: {
|
|
51892
|
-
[name: string]: unknown;
|
|
51893
|
-
};
|
|
51894
|
-
content: {
|
|
51895
|
-
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51896
|
-
};
|
|
51897
|
-
};
|
|
51898
|
-
};
|
|
51899
|
-
};
|
|
51900
|
-
SearchUnitBlame: {
|
|
51248
|
+
BulkTagUnits: {
|
|
51901
51249
|
parameters: {
|
|
51902
51250
|
query?: {
|
|
51903
51251
|
/**
|
|
@@ -51935,7 +51283,7 @@ interface operations {
|
|
|
51935
51283
|
* An example conjunction is:
|
|
51936
51284
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
51937
51285
|
*
|
|
51938
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
51286
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
51939
51287
|
*
|
|
51940
51288
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
51941
51289
|
*
|
|
@@ -51974,14 +51322,6 @@ interface operations {
|
|
|
51974
51322
|
* The whole string must be query-encoded.
|
|
51975
51323
|
*/
|
|
51976
51324
|
contains?: string;
|
|
51977
|
-
/**
|
|
51978
|
-
* @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs.
|
|
51979
|
-
*
|
|
51980
|
-
* A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.
|
|
51981
|
-
*
|
|
51982
|
-
* Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView.
|
|
51983
|
-
*/
|
|
51984
|
-
where_permission?: PathsUnit_blameGetParametersQueryWhere_permission;
|
|
51985
51325
|
/**
|
|
51986
51326
|
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
51987
51327
|
*
|
|
@@ -51992,76 +51332,43 @@ interface operations {
|
|
|
51992
51332
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
51993
51333
|
*/
|
|
51994
51334
|
include_hidden?: string;
|
|
51995
|
-
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
51996
|
-
view?: string;
|
|
51997
|
-
/** @description Maximum number of Units to return the blame of; 50 when not given, and larger values are rejected with 400. When there may be more, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
51998
|
-
limit?: number;
|
|
51999
51335
|
/**
|
|
52000
|
-
* @description
|
|
52001
|
-
*
|
|
52002
|
-
*
|
|
52003
|
-
*
|
|
52004
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HeadUnitEventNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
52005
|
-
*
|
|
52006
|
-
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
51336
|
+
* @description Include clause for expanding related entities in the response for Unit.
|
|
51337
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
51338
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
52007
51339
|
*
|
|
52008
|
-
*
|
|
51340
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
52009
51341
|
*
|
|
52010
51342
|
* The whole string must be query-encoded.
|
|
52011
51343
|
*/
|
|
52012
|
-
|
|
52013
|
-
/**
|
|
52014
|
-
* @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it.
|
|
52015
|
-
*
|
|
52016
|
-
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
52017
|
-
*
|
|
52018
|
-
* Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
|
|
52019
|
-
*/
|
|
52020
|
-
continue?: string;
|
|
52021
|
-
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
52022
|
-
resource_type?: string;
|
|
52023
|
-
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
52024
|
-
where_data?: string;
|
|
52025
|
-
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
52026
|
-
where_data_engine?: string;
|
|
52027
|
-
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
52028
|
-
where_trigger?: string;
|
|
52029
|
-
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
52030
|
-
trigger_filter?: string;
|
|
52031
|
-
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52032
|
-
triggers_passed?: boolean;
|
|
52033
|
-
/** @description Only the fields whose path contains this substring. */
|
|
52034
|
-
path?: string;
|
|
52035
|
-
/** @description Only the fields of this resource, named as <type>/<name> or <name>; a substring of either matches. */
|
|
52036
|
-
resource?: string;
|
|
52037
|
-
/**
|
|
52038
|
-
* @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
|
|
52039
|
-
*
|
|
52040
|
-
* Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
|
|
52041
|
-
*/
|
|
52042
|
-
flags?: string;
|
|
52043
|
-
/** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
|
|
52044
|
-
upstream?: boolean;
|
|
52045
|
-
/** @description How many upstream units to follow before stopping. */
|
|
52046
|
-
upstream_depth?: number;
|
|
52047
|
-
/** @description Include the $comment$ pseudo-fields that carry YAML comments. */
|
|
52048
|
-
include_comments?: boolean;
|
|
51344
|
+
include?: string;
|
|
52049
51345
|
};
|
|
52050
51346
|
header?: never;
|
|
52051
51347
|
path?: never;
|
|
52052
51348
|
cookie?: never;
|
|
52053
51349
|
};
|
|
52054
|
-
requestBody?:
|
|
51350
|
+
requestBody?: {
|
|
51351
|
+
content: {
|
|
51352
|
+
"application/json": components["schemas"]["UnitTagRequest"];
|
|
51353
|
+
};
|
|
51354
|
+
};
|
|
52055
51355
|
responses: {
|
|
52056
51356
|
/** @description OK */
|
|
52057
51357
|
200: {
|
|
52058
51358
|
headers: {
|
|
52059
|
-
/** @description The token to pass as the continue parameter of the next request, when there may be more entities after this page. It is absent on the last page. A page can hold fewer entities than the limit, or none, and still have one. */
|
|
52060
|
-
"ConfigHub-Continue"?: string;
|
|
52061
51359
|
[name: string]: unknown;
|
|
52062
51360
|
};
|
|
52063
51361
|
content: {
|
|
52064
|
-
"application/json": components["schemas"]["
|
|
51362
|
+
"application/json": components["schemas"]["UnitTagResponse"][];
|
|
51363
|
+
};
|
|
51364
|
+
};
|
|
51365
|
+
/** @description Multi-Status: Mixed success and failure results */
|
|
51366
|
+
207: {
|
|
51367
|
+
headers: {
|
|
51368
|
+
[name: string]: unknown;
|
|
51369
|
+
};
|
|
51370
|
+
content: {
|
|
51371
|
+
"application/json": components["schemas"]["UnitTagResponse"][];
|
|
52065
51372
|
};
|
|
52066
51373
|
};
|
|
52067
51374
|
/** @description Unit request is invalid (Bad Request). */
|
|
@@ -52100,6 +51407,24 @@ interface operations {
|
|
|
52100
51407
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
52101
51408
|
};
|
|
52102
51409
|
};
|
|
51410
|
+
/** @description Unit data conflict. Data has changed since last read. */
|
|
51411
|
+
409: {
|
|
51412
|
+
headers: {
|
|
51413
|
+
[name: string]: unknown;
|
|
51414
|
+
};
|
|
51415
|
+
content: {
|
|
51416
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51417
|
+
};
|
|
51418
|
+
};
|
|
51419
|
+
/** @description Moving a change order's release tag to a Revision a release of the change could not deliver: before its end tag or the last released Revision, with validation errors, or in a Space where a release has been published at it */
|
|
51420
|
+
422: {
|
|
51421
|
+
headers: {
|
|
51422
|
+
[name: string]: unknown;
|
|
51423
|
+
};
|
|
51424
|
+
content: {
|
|
51425
|
+
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
51426
|
+
};
|
|
51427
|
+
};
|
|
52103
51428
|
/** @description Something went wrong while processing Unit. */
|
|
52104
51429
|
500: {
|
|
52105
51430
|
headers: {
|
|
@@ -52120,7 +51445,7 @@ interface operations {
|
|
|
52120
51445
|
};
|
|
52121
51446
|
};
|
|
52122
51447
|
};
|
|
52123
|
-
|
|
51448
|
+
SearchUnitBlame: {
|
|
52124
51449
|
parameters: {
|
|
52125
51450
|
query?: {
|
|
52126
51451
|
/**
|
|
@@ -52158,7 +51483,7 @@ interface operations {
|
|
|
52158
51483
|
* An example conjunction is:
|
|
52159
51484
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
52160
51485
|
*
|
|
52161
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
51486
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
52162
51487
|
*
|
|
52163
51488
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
52164
51489
|
*
|
|
@@ -52197,27 +51522,6 @@ interface operations {
|
|
|
52197
51522
|
* The whole string must be query-encoded.
|
|
52198
51523
|
*/
|
|
52199
51524
|
contains?: string;
|
|
52200
|
-
/**
|
|
52201
|
-
* @description Include clause for expanding related entities in the response for Unit.
|
|
52202
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
52203
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
52204
|
-
*
|
|
52205
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
52206
|
-
*
|
|
52207
|
-
* The whole string must be query-encoded.
|
|
52208
|
-
*/
|
|
52209
|
-
include?: string;
|
|
52210
|
-
/**
|
|
52211
|
-
* @description Select clause for specifying which fields to include in the response for Unit.
|
|
52212
|
-
* The attribute names are case-sensitive, PascalCase, and
|
|
52213
|
-
* expected in a comma-separated list format as in the JSON encoding.
|
|
52214
|
-
* If not specified, all fields are returned.
|
|
52215
|
-
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
52216
|
-
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
52217
|
-
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
52218
|
-
* The whole string must be query-encoded.
|
|
52219
|
-
*/
|
|
52220
|
-
select?: string;
|
|
52221
51525
|
/**
|
|
52222
51526
|
* @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs.
|
|
52223
51527
|
*
|
|
@@ -52225,7 +51529,7 @@ interface operations {
|
|
|
52225
51529
|
*
|
|
52226
51530
|
* Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView.
|
|
52227
51531
|
*/
|
|
52228
|
-
where_permission?:
|
|
51532
|
+
where_permission?: PathsUnit_blameGetParametersQueryWhere_permission;
|
|
52229
51533
|
/**
|
|
52230
51534
|
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
52231
51535
|
*
|
|
@@ -52238,14 +51542,14 @@ interface operations {
|
|
|
52238
51542
|
include_hidden?: string;
|
|
52239
51543
|
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
52240
51544
|
view?: string;
|
|
52241
|
-
/** @description Maximum number of
|
|
51545
|
+
/** @description Maximum number of Units to return the blame of; 50 when not given, and larger values are rejected with 400. When there may be more, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
52242
51546
|
limit?: number;
|
|
52243
51547
|
/**
|
|
52244
51548
|
* @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
52245
51549
|
*
|
|
52246
51550
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
52247
51551
|
*
|
|
52248
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum,
|
|
51552
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
52249
51553
|
*
|
|
52250
51554
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
52251
51555
|
*
|
|
@@ -52274,6 +51578,22 @@ interface operations {
|
|
|
52274
51578
|
trigger_filter?: string;
|
|
52275
51579
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52276
51580
|
triggers_passed?: boolean;
|
|
51581
|
+
/** @description Only the fields whose path contains this substring. */
|
|
51582
|
+
path?: string;
|
|
51583
|
+
/** @description Only the fields of this resource, named as <type>/<name> or <name>; a substring of either matches. */
|
|
51584
|
+
resource?: string;
|
|
51585
|
+
/**
|
|
51586
|
+
* @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
|
|
51587
|
+
*
|
|
51588
|
+
* Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
|
|
51589
|
+
*/
|
|
51590
|
+
flags?: string;
|
|
51591
|
+
/** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
|
|
51592
|
+
upstream?: boolean;
|
|
51593
|
+
/** @description How many upstream units to follow before stopping. */
|
|
51594
|
+
upstream_depth?: number;
|
|
51595
|
+
/** @description Include the $comment$ pseudo-fields that carry YAML comments. */
|
|
51596
|
+
include_comments?: boolean;
|
|
52277
51597
|
};
|
|
52278
51598
|
header?: never;
|
|
52279
51599
|
path?: never;
|
|
@@ -52289,7 +51609,7 @@ interface operations {
|
|
|
52289
51609
|
[name: string]: unknown;
|
|
52290
51610
|
};
|
|
52291
51611
|
content: {
|
|
52292
|
-
"application/json": components["schemas"]["
|
|
51612
|
+
"application/json": components["schemas"]["UnitBlame"][];
|
|
52293
51613
|
};
|
|
52294
51614
|
};
|
|
52295
51615
|
/** @description Unit request is invalid (Bad Request). */
|
|
@@ -52348,7 +51668,7 @@ interface operations {
|
|
|
52348
51668
|
};
|
|
52349
51669
|
};
|
|
52350
51670
|
};
|
|
52351
|
-
|
|
51671
|
+
SearchUnitData: {
|
|
52352
51672
|
parameters: {
|
|
52353
51673
|
query?: {
|
|
52354
51674
|
/**
|
|
@@ -52386,7 +51706,7 @@ interface operations {
|
|
|
52386
51706
|
* An example conjunction is:
|
|
52387
51707
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
52388
51708
|
*
|
|
52389
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
51709
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
52390
51710
|
*
|
|
52391
51711
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
52392
51712
|
*
|
|
@@ -52425,6 +51745,27 @@ interface operations {
|
|
|
52425
51745
|
* The whole string must be query-encoded.
|
|
52426
51746
|
*/
|
|
52427
51747
|
contains?: string;
|
|
51748
|
+
/**
|
|
51749
|
+
* @description Include clause for expanding related entities in the response for Unit.
|
|
51750
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
51751
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
51752
|
+
*
|
|
51753
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
51754
|
+
*
|
|
51755
|
+
* The whole string must be query-encoded.
|
|
51756
|
+
*/
|
|
51757
|
+
include?: string;
|
|
51758
|
+
/**
|
|
51759
|
+
* @description Select clause for specifying which fields to include in the response for Unit.
|
|
51760
|
+
* The attribute names are case-sensitive, PascalCase, and
|
|
51761
|
+
* expected in a comma-separated list format as in the JSON encoding.
|
|
51762
|
+
* If not specified, all fields are returned.
|
|
51763
|
+
* Entity and parent IDs (like OrganizationID, SpaceID, UnitID) and Slug are always returned regardless of the select parameter.
|
|
51764
|
+
* Fields used in where and contains filters, fields named by order_by, and fields read by the columns of the View named by view are also automatically included.
|
|
51765
|
+
* Example: 'DisplayName,CreatedAt,Labels' will return only those fields plus the required ID and Slug fields.
|
|
51766
|
+
* The whole string must be query-encoded.
|
|
51767
|
+
*/
|
|
51768
|
+
select?: string;
|
|
52428
51769
|
/**
|
|
52429
51770
|
* @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs.
|
|
52430
51771
|
*
|
|
@@ -52432,7 +51773,7 @@ interface operations {
|
|
|
52432
51773
|
*
|
|
52433
51774
|
* Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView.
|
|
52434
51775
|
*/
|
|
52435
|
-
where_permission?:
|
|
51776
|
+
where_permission?: PathsUnit_dataGetParametersQueryWhere_permission;
|
|
52436
51777
|
/**
|
|
52437
51778
|
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
52438
51779
|
*
|
|
@@ -52452,7 +51793,7 @@ interface operations {
|
|
|
52452
51793
|
*
|
|
52453
51794
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
52454
51795
|
*
|
|
52455
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum,
|
|
51796
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
52456
51797
|
*
|
|
52457
51798
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
52458
51799
|
*
|
|
@@ -52481,18 +51822,6 @@ interface operations {
|
|
|
52481
51822
|
trigger_filter?: string;
|
|
52482
51823
|
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52483
51824
|
triggers_passed?: boolean;
|
|
52484
|
-
/** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:<id>, ChangeSet:<id>, ChangeOrder:<id>, or Release:<id> (the Revision the Release bundled), any of them optionally prefixed with Before:. */
|
|
52485
|
-
from?: string;
|
|
52486
|
-
/** @description The Revision on the To side, in the same syntax as from. */
|
|
52487
|
-
to?: string;
|
|
52488
|
-
/**
|
|
52489
|
-
* @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, Unchanged to also list resources with no changes, and Context to also list, within each changed resource, the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None.
|
|
52490
|
-
*
|
|
52491
|
-
* Supported values: Attribution, Unchanged, Context.
|
|
52492
|
-
*/
|
|
52493
|
-
include?: string;
|
|
52494
|
-
/** @description Limit the diff to the resources this where expression selects on either side. */
|
|
52495
|
-
where_resource?: string;
|
|
52496
51825
|
};
|
|
52497
51826
|
header?: never;
|
|
52498
51827
|
path?: never;
|
|
@@ -52508,7 +51837,7 @@ interface operations {
|
|
|
52508
51837
|
[name: string]: unknown;
|
|
52509
51838
|
};
|
|
52510
51839
|
content: {
|
|
52511
|
-
"application/json": components["schemas"]["
|
|
51840
|
+
"application/json": components["schemas"]["UnitData"][];
|
|
52512
51841
|
};
|
|
52513
51842
|
};
|
|
52514
51843
|
/** @description Unit request is invalid (Bad Request). */
|
|
@@ -52567,12 +51896,12 @@ interface operations {
|
|
|
52567
51896
|
};
|
|
52568
51897
|
};
|
|
52569
51898
|
};
|
|
52570
|
-
|
|
51899
|
+
SearchUnitDiff: {
|
|
52571
51900
|
parameters: {
|
|
52572
51901
|
query?: {
|
|
52573
51902
|
/**
|
|
52574
51903
|
* @description The specified string is an expression for the purpose of filtering
|
|
52575
|
-
* the list of
|
|
51904
|
+
* the list of Units returned. The expression syntax was inspired by SQL.
|
|
52576
51905
|
* It supports conjunctions using `AND` of relational expressions of the form *attribute*
|
|
52577
51906
|
* *operator* *attribute_or_literal*. The attribute names are case-sensitive and PascalCase,
|
|
52578
51907
|
* as in the JSON encoding.
|
|
@@ -52605,17 +51934,19 @@ interface operations {
|
|
|
52605
51934
|
* An example conjunction is:
|
|
52606
51935
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
52607
51936
|
*
|
|
52608
|
-
* Supported attributes for filtering on
|
|
51937
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
51938
|
+
*
|
|
51939
|
+
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
52609
51940
|
*
|
|
52610
51941
|
* The whole string must be query-encoded.
|
|
52611
51942
|
*/
|
|
52612
51943
|
where?: string;
|
|
52613
51944
|
/**
|
|
52614
|
-
* @description UUID of a Filter entity to apply to the
|
|
51945
|
+
* @description UUID of a Filter entity to apply to the Unit list.
|
|
52615
51946
|
*
|
|
52616
51947
|
* The Filter must be in the same Organization as the user credentials.
|
|
52617
51948
|
*
|
|
52618
|
-
* The Filter's From field must match the entity type being filtered (
|
|
51949
|
+
* The Filter's From field must match the entity type being filtered (Unit).
|
|
52619
51950
|
*
|
|
52620
51951
|
* For Space-resident entities, if the Filter has a FromSpaceID, it must match the operation's SpaceID.
|
|
52621
51952
|
*
|
|
@@ -52637,21 +51968,21 @@ interface operations {
|
|
|
52637
51968
|
*
|
|
52638
51969
|
* If both 'where' and 'contains' parameters are specified, they are combined with AND logic.
|
|
52639
51970
|
*
|
|
52640
|
-
* Searchable fields for
|
|
51971
|
+
* Searchable fields for Unit include string and map-type attributes from the queryable attributes list.
|
|
52641
51972
|
*
|
|
52642
51973
|
* The whole string must be query-encoded.
|
|
52643
51974
|
*/
|
|
52644
51975
|
contains?: string;
|
|
52645
51976
|
/**
|
|
52646
|
-
* @description Only return
|
|
51977
|
+
* @description Only return Unit entities on which the caller has this permission, as well as View, which every entity listed needs.
|
|
52647
51978
|
*
|
|
52648
51979
|
* A list made to choose an entity to act on can name the permission the action needs, such as Edit to change it or Use to refer to it from another entity, so that it leaves out the entities the action would be refused on.
|
|
52649
51980
|
*
|
|
52650
|
-
* Supported values: Manage, Edit, Use, View.
|
|
51981
|
+
* Supported values: Manage, Edit, Use, View, Approve, TargetEdit, TargetView.
|
|
52651
51982
|
*/
|
|
52652
|
-
where_permission?:
|
|
51983
|
+
where_permission?: PathsUnit_diffGetParametersQueryWhere_permission;
|
|
52653
51984
|
/**
|
|
52654
|
-
* @description Hidden
|
|
51985
|
+
* @description Hidden Unit entities, those with a HiddenReason, are left out of the results, or of what a bulk operation acts on, unless this names their HiddenReason.
|
|
52655
51986
|
*
|
|
52656
51987
|
* It is a comma-separated list of HiddenReasons, or `*` for all of them.
|
|
52657
51988
|
*
|
|
@@ -52660,45 +51991,56 @@ interface operations {
|
|
|
52660
51991
|
* ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
|
|
52661
51992
|
*/
|
|
52662
51993
|
include_hidden?: string;
|
|
52663
|
-
/**
|
|
52664
|
-
|
|
52665
|
-
|
|
52666
|
-
*/
|
|
52667
|
-
offset?: number;
|
|
52668
|
-
/** @description Maximum number of UnitEvent entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
51994
|
+
/** @description UUID of a View of Unit. Its Filter selects the Units as the filter parameter does, so the two may not both be specified. */
|
|
51995
|
+
view?: string;
|
|
51996
|
+
/** @description Maximum number of Unit entities to return. If not specified, all matching entities are returned. Values greater than 1000 are rejected with 400. When there may be more entities, the response has a ConfigHub-Continue header to pass as the continue parameter of the next request. */
|
|
52669
51997
|
limit?: number;
|
|
52670
51998
|
/**
|
|
52671
|
-
* @description Comma-separated list of fields to sort
|
|
51999
|
+
* @description Comma-separated list of fields to sort Unit results by, each in the form 'ASC|DESC:FieldName' or just 'FieldName'.
|
|
52672
52000
|
*
|
|
52673
52001
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
52674
52002
|
*
|
|
52675
|
-
* Supported attributes for ordering
|
|
52003
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
52676
52004
|
*
|
|
52677
52005
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
52678
52006
|
*
|
|
52679
|
-
* Results are ordered by the
|
|
52007
|
+
* Results are ordered by the Unit's ID after the fields named, and by the ID alone if none are.
|
|
52680
52008
|
*
|
|
52681
52009
|
* The whole string must be query-encoded.
|
|
52682
52010
|
*/
|
|
52683
52011
|
order_by?: string;
|
|
52684
52012
|
/**
|
|
52685
|
-
* @description The token from the ConfigHub-Continue header of the previous page, to return the
|
|
52013
|
+
* @description The token from the ConfigHub-Continue header of the previous page, to return the Unit entities after it.
|
|
52686
52014
|
*
|
|
52687
52015
|
* The request's other parameters, except limit, must be the same as those of the request that returned the token.
|
|
52688
52016
|
*
|
|
52689
52017
|
* Keep reading until a response has no such header: a page can hold fewer entities than the limit, or none, and still be followed by more.
|
|
52690
52018
|
*/
|
|
52691
52019
|
continue?: string;
|
|
52020
|
+
/** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
52021
|
+
resource_type?: string;
|
|
52022
|
+
/** @description Where data: The specified string is an expression for the purpose of evaluating whether the configuration data matches the filter. It supports conjunctions using `AND` of relational expressions of the form *path* *operator* *literal*. The path specifications are dot-separated, for both map fields and array indices, as in `spec.template.spec.containers.0.image = 'ghcr.io/headlamp-k8s/headlamp:latest' AND spec.replicas > 1`. Path expressions support `*` for wildcard array or map segments and `?key=value` syntax for associative matches of array elements containing objects with a `key` attribute. Strings support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `LIKE`, `ILIKE`, `~~`, `!~~`, `~`, `!~`, `~*`, `!~*`, `IN`, `NOT IN`. String pattern operators: `LIKE` and `~~` for pattern matching with `%` and `_` wildcards, `ILIKE` for case-insensitive pattern matching, `!~~` for NOT LIKE. String regex operators: `~` for regex matching, `~*` for case-insensitive regex, `!~` and `!~*` for regex not matching (case-sensitive and insensitive). Integers support the following operators: `<`, `>`, `<=`, `>=`, `=`, `!=`, `IN`, `NOT IN`. Boolean values support equality and inequality only. The `IN` and `NOT IN` operators accept a comma-separated list of values in parentheses, such as `spec.template.spec.containers.0.image#reference IN (':latest', ':arm64-latest')`. The syntax `.|` splits the path: the left side selects, and the right side is a property of what was selected. On the right side of a `.|`, and only there, `!=` is true when the property is absent: `spec.containers.*.|image != 'nginx'` selects the containers and asks that none of their images be nginx, which a container with no image satisfies. Everywhere else a path that is not present is not a match, `!=` included. String literals are quoted with single quotes, such as `'string'`. Integer and boolean literals are also supported for attributes of those types. The whole string must be query-encoded. */
|
|
52023
|
+
where_data?: string;
|
|
52024
|
+
/** @description Which engine answers where_data and resource_type: `sql` (the default) evaluates the expression against the stored resource projection in a single query, falling back to the function engine for the expressions it cannot translate; `function` invokes the where-filter function on each candidate Unit, reading every one's configuration; `shadow` runs both, answers with `function`, and logs any disagreement. Temporary: `function` is the escape hatch for one release, after which this parameter goes away. */
|
|
52025
|
+
where_data_engine?: string;
|
|
52026
|
+
/** @description Where expression to match Triggers. Matched triggers are invoked on each unit to filter by validation results. Use with triggers_passed to control whether passing or failing units are returned (default: failing). */
|
|
52027
|
+
where_trigger?: string;
|
|
52028
|
+
/** @description Filter UUID (with From=Trigger). The filter's matching triggers are invoked on units to filter by validation results. Can be combined with where_trigger. */
|
|
52029
|
+
trigger_filter?: string;
|
|
52030
|
+
/** @description When true, return units that pass trigger validation; when false (default), return units that fail. Only applies when where_trigger or trigger_filter is specified. */
|
|
52031
|
+
triggers_passed?: boolean;
|
|
52032
|
+
/** @description The Revision on the From side: a number, a Revision ID, HeadRevisionNum, LastReleasedRevisionNum, Tag:<id>, ChangeSet:<id>, ChangeOrder:<id>, or Release:<id> (the Revision the Release bundled), any of them optionally prefixed with Before:. */
|
|
52033
|
+
from?: string;
|
|
52034
|
+
/** @description The Revision on the To side, in the same syntax as from. */
|
|
52035
|
+
to?: string;
|
|
52692
52036
|
/**
|
|
52693
|
-
* @description
|
|
52694
|
-
*
|
|
52695
|
-
* Supported values: Unit, Off.
|
|
52696
|
-
*
|
|
52697
|
-
* If not specified, results are restricted to at most one row per Unit.
|
|
52037
|
+
* @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, Unchanged to also list resources with no changes, and Context to also list, within each changed resource, the unchanged paths around the changes: every unchanged child of each map or array that holds a change, up to the resource, as ChangeType None.
|
|
52698
52038
|
*
|
|
52699
|
-
*
|
|
52039
|
+
* Supported values: Attribution, Unchanged, Context.
|
|
52700
52040
|
*/
|
|
52701
|
-
|
|
52041
|
+
include?: string;
|
|
52042
|
+
/** @description Limit the diff to the resources this where expression selects on either side. */
|
|
52043
|
+
where_resource?: string;
|
|
52702
52044
|
};
|
|
52703
52045
|
header?: never;
|
|
52704
52046
|
path?: never;
|
|
@@ -52714,10 +52056,10 @@ interface operations {
|
|
|
52714
52056
|
[name: string]: unknown;
|
|
52715
52057
|
};
|
|
52716
52058
|
content: {
|
|
52717
|
-
"application/json": components["schemas"]["
|
|
52059
|
+
"application/json": components["schemas"]["UnitDiff"][];
|
|
52718
52060
|
};
|
|
52719
52061
|
};
|
|
52720
|
-
/** @description
|
|
52062
|
+
/** @description Unit request is invalid (Bad Request). */
|
|
52721
52063
|
400: {
|
|
52722
52064
|
headers: {
|
|
52723
52065
|
[name: string]: unknown;
|
|
@@ -52744,7 +52086,7 @@ interface operations {
|
|
|
52744
52086
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
52745
52087
|
};
|
|
52746
52088
|
};
|
|
52747
|
-
/** @description
|
|
52089
|
+
/** @description Unit not found. */
|
|
52748
52090
|
404: {
|
|
52749
52091
|
headers: {
|
|
52750
52092
|
[name: string]: unknown;
|
|
@@ -52753,7 +52095,7 @@ interface operations {
|
|
|
52753
52095
|
"application/json": components["schemas"]["StandardErrorResponse"];
|
|
52754
52096
|
};
|
|
52755
52097
|
};
|
|
52756
|
-
/** @description Something went wrong while processing
|
|
52098
|
+
/** @description Something went wrong while processing Unit. */
|
|
52757
52099
|
500: {
|
|
52758
52100
|
headers: {
|
|
52759
52101
|
[name: string]: unknown;
|
|
@@ -52811,7 +52153,7 @@ interface operations {
|
|
|
52811
52153
|
* An example conjunction is:
|
|
52812
52154
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
52813
52155
|
*
|
|
52814
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
52156
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
52815
52157
|
*
|
|
52816
52158
|
* Finding all units created by cloning can be done using the expression `UpstreamRevisionNum > 0`. Clones of a specific unit can be found by additionally filtering based on `UpstreamUnitID`. Units never released can be found using `LastReleasedRevisionNum = 0`. Units with unreleased changes can be found with `HeadRevisionNum > LastReleasedRevisionNum AND ReleaseTargetID IS NOT NULL AND Unreleasable = false`.
|
|
52817
52159
|
*
|
|
@@ -52855,7 +52197,7 @@ interface operations {
|
|
|
52855
52197
|
* The attribute names are case-sensitive, PascalCase, and
|
|
52856
52198
|
* expected in a comma-separated list format as in the JSON encoding.
|
|
52857
52199
|
*
|
|
52858
|
-
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID,
|
|
52200
|
+
* Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, Permissions, SpaceID, TargetID, UpstreamSpaceID, UpstreamUnitID.
|
|
52859
52201
|
*
|
|
52860
52202
|
* The whole string must be query-encoded.
|
|
52861
52203
|
*/
|
|
@@ -52898,7 +52240,7 @@ interface operations {
|
|
|
52898
52240
|
*
|
|
52899
52241
|
* Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
52900
52242
|
*
|
|
52901
|
-
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum,
|
|
52243
|
+
* Supported attributes for ordering Unit: ChangeSetID, CreatedAt, DataHash, DisplayName, HeadRevisionID, HeadRevisionNum, HiddenReason, LastChangeDescription, LastReleasedRevisionNum, OrganizationID, Slug, SpaceID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamUnitID.
|
|
52902
52244
|
*
|
|
52903
52245
|
* Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
52904
52246
|
*
|
|
@@ -53852,7 +53194,7 @@ interface operations {
|
|
|
53852
53194
|
* An example conjunction is:
|
|
53853
53195
|
* `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
53854
53196
|
*
|
|
53855
|
-
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum,
|
|
53197
|
+
* Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, MutationSources, NeededPaths, OrganizationID, PathAnnotations, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationSkipped, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
53856
53198
|
*
|
|
53857
53199
|
* The Units to create entities from, with from_backing_units.
|
|
53858
53200
|
*
|
|
@@ -54925,12 +54267,6 @@ declare enum PathsSpaceSpace_idUnitUnit_idRevisionGetParametersQueryWhere_permis
|
|
|
54925
54267
|
Use = "Use",
|
|
54926
54268
|
View = "View"
|
|
54927
54269
|
}
|
|
54928
|
-
declare enum PathsSpaceSpace_idUnitUnit_idUnit_eventGetParametersQueryWhere_permission {
|
|
54929
|
-
Manage = "Manage",
|
|
54930
|
-
Edit = "Edit",
|
|
54931
|
-
Use = "Use",
|
|
54932
|
-
View = "View"
|
|
54933
|
-
}
|
|
54934
54270
|
declare enum PathsSpaceSpace_idViewGetParametersQueryWhere_permission {
|
|
54935
54271
|
Manage = "Manage",
|
|
54936
54272
|
Edit = "Edit",
|
|
@@ -54999,16 +54335,6 @@ declare enum PathsUnit_diffGetParametersQueryWhere_permission {
|
|
|
54999
54335
|
TargetEdit = "TargetEdit",
|
|
55000
54336
|
TargetView = "TargetView"
|
|
55001
54337
|
}
|
|
55002
|
-
declare enum PathsUnit_eventGetParametersQueryWhere_permission {
|
|
55003
|
-
Manage = "Manage",
|
|
55004
|
-
Edit = "Edit",
|
|
55005
|
-
Use = "Use",
|
|
55006
|
-
View = "View"
|
|
55007
|
-
}
|
|
55008
|
-
declare enum PathsUnit_eventGetParametersQueryDistinct_on {
|
|
55009
|
-
Unit = "Unit",
|
|
55010
|
-
Off = "Off"
|
|
55011
|
-
}
|
|
55012
54338
|
declare enum PathsUnit_mutation_sourcesGetParametersQueryWhere_permission {
|
|
55013
54339
|
Manage = "Manage",
|
|
55014
54340
|
Edit = "Edit",
|
|
@@ -55030,28 +54356,6 @@ declare enum PathsViewGetParametersQueryWhere_permission {
|
|
|
55030
54356
|
Use = "Use",
|
|
55031
54357
|
View = "View"
|
|
55032
54358
|
}
|
|
55033
|
-
declare enum ActionResultType {
|
|
55034
|
-
None = "None",
|
|
55035
|
-
FunctionInvocationCompleted = "FunctionInvocationCompleted",
|
|
55036
|
-
FunctionInvocationFailed = "FunctionInvocationFailed"
|
|
55037
|
-
}
|
|
55038
|
-
declare enum ActionStatusType {
|
|
55039
|
-
None = "None",
|
|
55040
|
-
Pending = "Pending",
|
|
55041
|
-
Submitted = "Submitted",
|
|
55042
|
-
Progressing = "Progressing",
|
|
55043
|
-
Completed = "Completed",
|
|
55044
|
-
Failed = "Failed",
|
|
55045
|
-
Canceled = "Canceled",
|
|
55046
|
-
Aborted = "Aborted"
|
|
55047
|
-
}
|
|
55048
|
-
declare enum ActionType {
|
|
55049
|
-
N_A = "N/A",
|
|
55050
|
-
Cancel = "Cancel",
|
|
55051
|
-
InvokeFunctions = "InvokeFunctions",
|
|
55052
|
-
ListFunctions = "ListFunctions",
|
|
55053
|
-
Apply = "Apply"
|
|
55054
|
-
}
|
|
55055
54359
|
declare enum AttestationResult {
|
|
55056
54360
|
Pass = "Pass",
|
|
55057
54361
|
Fail = "Fail"
|