@confighub/rtk-query 0.10.14 → 0.11.0
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.cjs.map +1 -1
- package/dist/index.d.cts +89 -42
- package/dist/index.d.ts +89 -42
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -369,7 +369,7 @@ type BulkDeleteComponentsApiArg = {
|
|
|
369
369
|
An example conjunction is:
|
|
370
370
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
371
371
|
|
|
372
|
-
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID,
|
|
372
|
+
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID.
|
|
373
373
|
|
|
374
374
|
The whole string must be query-encoded. */
|
|
375
375
|
where?: string;
|
|
@@ -460,7 +460,7 @@ type BulkPatchComponentsApiArg = {
|
|
|
460
460
|
An example conjunction is:
|
|
461
461
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
462
462
|
|
|
463
|
-
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID,
|
|
463
|
+
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID.
|
|
464
464
|
|
|
465
465
|
The whole string must be query-encoded. */
|
|
466
466
|
where?: string;
|
|
@@ -526,7 +526,6 @@ type BulkPatchComponentsApiArg = {
|
|
|
526
526
|
Annotations?: {
|
|
527
527
|
[key: string]: string | null;
|
|
528
528
|
} | null;
|
|
529
|
-
ChangeWorkflowRequired?: boolean | null;
|
|
530
529
|
/** An optional set of gates that, if any is present, will block deletion */
|
|
531
530
|
DeleteGates?: {
|
|
532
531
|
[key: string]: boolean | null;
|
|
@@ -542,6 +541,8 @@ type BulkPatchComponentsApiArg = {
|
|
|
542
541
|
Permissions?: {
|
|
543
542
|
[key: string]: object | null;
|
|
544
543
|
} | null;
|
|
544
|
+
RequireChangeTracking?: boolean | null;
|
|
545
|
+
RequireChangeWorkflow?: boolean | null;
|
|
545
546
|
/** Unique URL-safe identifier for the entity. */
|
|
546
547
|
Slug?: string | null;
|
|
547
548
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -4696,7 +4697,7 @@ type ListComponentsApiArg = {
|
|
|
4696
4697
|
An example conjunction is:
|
|
4697
4698
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
4698
4699
|
|
|
4699
|
-
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID,
|
|
4700
|
+
Supported attributes for filtering on Component: AllowedChangeWorkflowIDs, Annotations, BackingUnitID, ComponentID, CreatedAt, DeleteGates, DisplayName, HiddenReason, Labels, OrganizationID, Permissions, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID.
|
|
4700
4701
|
|
|
4701
4702
|
The whole string must be query-encoded. */
|
|
4702
4703
|
where?: string;
|
|
@@ -4773,7 +4774,7 @@ type ListComponentsApiArg = {
|
|
|
4773
4774
|
|
|
4774
4775
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
4775
4776
|
|
|
4776
|
-
Supported attributes for ordering Component: BackingUnitID,
|
|
4777
|
+
Supported attributes for ordering Component: BackingUnitID, ComponentID, CreatedAt, DisplayName, HiddenReason, OrganizationID, RequireChangeTracking, RequireChangeWorkflow, Slug, UpdatedAt, UpstreamComponentID.
|
|
4777
4778
|
|
|
4778
4779
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
4779
4780
|
|
|
@@ -4789,7 +4790,7 @@ type ListComponentsApiArg = {
|
|
|
4789
4790
|
continue?: string;
|
|
4790
4791
|
};
|
|
4791
4792
|
type CreateComponentApiResponse =
|
|
4792
|
-
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use,
|
|
4793
|
+
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ ComponentRead;
|
|
4793
4794
|
type CreateComponentApiArg = {
|
|
4794
4795
|
/** Give each Component written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Component's configuration, which is then kept in step with it. */
|
|
4795
4796
|
withBackingUnits?: boolean;
|
|
@@ -4831,7 +4832,7 @@ type GetComponentApiArg = {
|
|
|
4831
4832
|
componentId: string;
|
|
4832
4833
|
};
|
|
4833
4834
|
type PatchComponentApiResponse =
|
|
4834
|
-
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use,
|
|
4835
|
+
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ ComponentRead;
|
|
4835
4836
|
type PatchComponentApiArg = {
|
|
4836
4837
|
/** Unique identifier for a component_id */
|
|
4837
4838
|
componentId: string;
|
|
@@ -4843,7 +4844,6 @@ type PatchComponentApiArg = {
|
|
|
4843
4844
|
Annotations?: {
|
|
4844
4845
|
[key: string]: string | null;
|
|
4845
4846
|
} | null;
|
|
4846
|
-
ChangeWorkflowRequired?: boolean | null;
|
|
4847
4847
|
/** An optional set of gates that, if any is present, will block deletion */
|
|
4848
4848
|
DeleteGates?: {
|
|
4849
4849
|
[key: string]: boolean | null;
|
|
@@ -4859,6 +4859,8 @@ type PatchComponentApiArg = {
|
|
|
4859
4859
|
Permissions?: {
|
|
4860
4860
|
[key: string]: object | null;
|
|
4861
4861
|
} | null;
|
|
4862
|
+
RequireChangeTracking?: boolean | null;
|
|
4863
|
+
RequireChangeWorkflow?: boolean | null;
|
|
4862
4864
|
/** Unique URL-safe identifier for the entity. */
|
|
4863
4865
|
Slug?: string | null;
|
|
4864
4866
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -4866,7 +4868,7 @@ type PatchComponentApiArg = {
|
|
|
4866
4868
|
};
|
|
4867
4869
|
};
|
|
4868
4870
|
type UpdateComponentApiResponse =
|
|
4869
|
-
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use,
|
|
4871
|
+
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ ComponentRead;
|
|
4870
4872
|
type UpdateComponentApiArg = {
|
|
4871
4873
|
/** Unique identifier for a component_id */
|
|
4872
4874
|
componentId: string;
|
|
@@ -4881,7 +4883,7 @@ type GetComponentDocumentApiArg = {
|
|
|
4881
4883
|
componentId: string;
|
|
4882
4884
|
};
|
|
4883
4885
|
type UpdateComponentDocumentApiResponse =
|
|
4884
|
-
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use,
|
|
4886
|
+
/** status 200 The Component a set of Variants make up. Each Variant is a Space naming the Component with ComponentID. The Component decides which ChangeWorkflows promotions and releases of its Variants, and ChangeSets opened on their Units, may use, whether one is required, and whether changes to the configuration of their Units have to be made in a ChangeSet or under a ChangeOrder. */ ComponentRead;
|
|
4885
4887
|
type UpdateComponentDocumentApiArg = {
|
|
4886
4888
|
/** Unique identifier for a component_id */
|
|
4887
4889
|
componentId: string;
|
|
@@ -5644,7 +5646,7 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
5644
5646
|
changeOrder?: string;
|
|
5645
5647
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
5646
5648
|
subgroup?: string;
|
|
5647
|
-
/**
|
|
5649
|
+
/** Additional configuration data to pass as OtherData to the functions the request names, and to the invocations that name none of their own; triggers pass what they name. Either a revision of each Unit, named LastReleasedRevisionNum or HeadRevisionNum, optionally prefixed with 'Before:' (e.g., Before:HeadRevisionNum), which the functions read under that name, or another Unit, as Unit:<key>:<unit-id>, whose head data the functions read under <key> (e.g., Unit:policy:<unit-id> for vet-validating-admission-policy); the caller needs View permission on it. May be repeated or comma-separated. A function passed no revision is passed the revisions its signature lists in OtherDataExpected. */
|
|
5648
5650
|
otherDataSource?: string;
|
|
5649
5651
|
/** The specified string is an expression for the purpose of filtering
|
|
5650
5652
|
the list of Units returned. The expression syntax was inspired by SQL.
|
|
@@ -5916,7 +5918,7 @@ type BulkDeleteInvocationsApiArg = {
|
|
|
5916
5918
|
An example conjunction is:
|
|
5917
5919
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
5918
5920
|
|
|
5919
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
5921
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
5920
5922
|
|
|
5921
5923
|
The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
5922
5924
|
|
|
@@ -6010,7 +6012,7 @@ type ListAllInvocationsApiArg = {
|
|
|
6010
6012
|
An example conjunction is:
|
|
6011
6013
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6012
6014
|
|
|
6013
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6015
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6014
6016
|
|
|
6015
6017
|
The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
6016
6018
|
|
|
@@ -6140,7 +6142,7 @@ type BulkPatchInvocationsApiArg = {
|
|
|
6140
6142
|
An example conjunction is:
|
|
6141
6143
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6142
6144
|
|
|
6143
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6145
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6144
6146
|
|
|
6145
6147
|
The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
6146
6148
|
|
|
@@ -6225,6 +6227,9 @@ type BulkPatchInvocationsApiArg = {
|
|
|
6225
6227
|
Labels?: {
|
|
6226
6228
|
[key: string]: string | null;
|
|
6227
6229
|
} | null;
|
|
6230
|
+
OtherUnitIDs?: {
|
|
6231
|
+
[key: string]: string | null;
|
|
6232
|
+
} | null;
|
|
6228
6233
|
Parameters?: (object | null)[] | null;
|
|
6229
6234
|
Permissions?: {
|
|
6230
6235
|
[key: string]: object | null;
|
|
@@ -6272,7 +6277,7 @@ type BulkCreateInvocationsApiArg = {
|
|
|
6272
6277
|
An example conjunction is:
|
|
6273
6278
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6274
6279
|
|
|
6275
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6280
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6276
6281
|
|
|
6277
6282
|
The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
6278
6283
|
|
|
@@ -6461,6 +6466,9 @@ type BulkCreateInvocationsApiArg = {
|
|
|
6461
6466
|
Labels?: {
|
|
6462
6467
|
[key: string]: string | null;
|
|
6463
6468
|
} | null;
|
|
6469
|
+
OtherUnitIDs?: {
|
|
6470
|
+
[key: string]: string | null;
|
|
6471
|
+
} | null;
|
|
6464
6472
|
Parameters?: (object | null)[] | null;
|
|
6465
6473
|
Permissions?: {
|
|
6466
6474
|
[key: string]: object | null;
|
|
@@ -6508,7 +6516,7 @@ type BulkMoveInvocationsApiArg = {
|
|
|
6508
6516
|
An example conjunction is:
|
|
6509
6517
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
6510
6518
|
|
|
6511
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6519
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
6512
6520
|
|
|
6513
6521
|
The whole string must be query-encoded. */
|
|
6514
6522
|
where?: string;
|
|
@@ -11209,7 +11217,7 @@ type InvokeFunctionsApiArg = {
|
|
|
11209
11217
|
changeOrder?: string;
|
|
11210
11218
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
11211
11219
|
subgroup?: string;
|
|
11212
|
-
/**
|
|
11220
|
+
/** Additional configuration data to pass as OtherData to the functions the request names, and to the invocations that name none of their own; triggers pass what they name. Either a revision of each Unit, named LastReleasedRevisionNum or HeadRevisionNum, optionally prefixed with 'Before:' (e.g., Before:HeadRevisionNum), which the functions read under that name, or another Unit, as Unit:<key>:<unit-id>, whose head data the functions read under <key> (e.g., Unit:policy:<unit-id> for vet-validating-admission-policy); the caller needs View permission on it. May be repeated or comma-separated. A function passed no revision is passed the revisions its signature lists in OtherDataExpected. */
|
|
11213
11221
|
otherDataSource?: string;
|
|
11214
11222
|
/** The specified string is an expression for the purpose of filtering
|
|
11215
11223
|
the list of Units returned. The expression syntax was inspired by SQL.
|
|
@@ -11330,7 +11338,7 @@ type ListInvocationsApiArg = {
|
|
|
11330
11338
|
An example conjunction is:
|
|
11331
11339
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
11332
11340
|
|
|
11333
|
-
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
11341
|
+
Supported attributes for filtering on Invocation: Annotations, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, DisplayName, FunctionInvocations, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Parameters, Permissions, Slug, SpaceID, ToolchainType, UpdatedAt, UpstreamInvocationID.
|
|
11334
11342
|
|
|
11335
11343
|
The functions an Invocation calls are addressed with dot notation into `FunctionInvocations`: `FunctionInvocations.*.FunctionName = 'set-image'` matches an Invocation that calls set-image anywhere in its list, and `FunctionInvocations.0.FunctionName` addresses the first function it calls.
|
|
11336
11344
|
|
|
@@ -11504,6 +11512,9 @@ type PatchInvocationApiArg = {
|
|
|
11504
11512
|
Labels?: {
|
|
11505
11513
|
[key: string]: string | null;
|
|
11506
11514
|
} | null;
|
|
11515
|
+
OtherUnitIDs?: {
|
|
11516
|
+
[key: string]: string | null;
|
|
11517
|
+
} | null;
|
|
11507
11518
|
Parameters?: (object | null)[] | null;
|
|
11508
11519
|
Permissions?: {
|
|
11509
11520
|
[key: string]: object | null;
|
|
@@ -12562,7 +12573,7 @@ type ListTriggersApiArg = {
|
|
|
12562
12573
|
An example conjunction is:
|
|
12563
12574
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
12564
12575
|
|
|
12565
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
12576
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
12566
12577
|
|
|
12567
12578
|
A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
12568
12579
|
|
|
@@ -12641,7 +12652,7 @@ type ListTriggersApiArg = {
|
|
|
12641
12652
|
|
|
12642
12653
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
12643
12654
|
|
|
12644
|
-
Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID,
|
|
12655
|
+
Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
12645
12656
|
|
|
12646
12657
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
12647
12658
|
|
|
@@ -12757,7 +12768,9 @@ type PatchTriggerApiArg = {
|
|
|
12757
12768
|
Labels?: {
|
|
12758
12769
|
[key: string]: string | null;
|
|
12759
12770
|
} | null;
|
|
12760
|
-
|
|
12771
|
+
OtherUnitIDs?: {
|
|
12772
|
+
[key: string]: string | null;
|
|
12773
|
+
} | null;
|
|
12761
12774
|
Permissions?: {
|
|
12762
12775
|
[key: string]: object | null;
|
|
12763
12776
|
} | null;
|
|
@@ -15816,7 +15829,7 @@ type BulkDeleteTriggersApiArg = {
|
|
|
15816
15829
|
An example conjunction is:
|
|
15817
15830
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15818
15831
|
|
|
15819
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
15832
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
15820
15833
|
|
|
15821
15834
|
A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
15822
15835
|
|
|
@@ -15910,7 +15923,7 @@ type ListAllTriggersApiArg = {
|
|
|
15910
15923
|
An example conjunction is:
|
|
15911
15924
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
15912
15925
|
|
|
15913
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
15926
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
15914
15927
|
|
|
15915
15928
|
A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
15916
15929
|
|
|
@@ -15989,7 +16002,7 @@ type ListAllTriggersApiArg = {
|
|
|
15989
16002
|
|
|
15990
16003
|
Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
|
|
15991
16004
|
|
|
15992
|
-
Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID,
|
|
16005
|
+
Supported attributes for ordering Trigger: BackingUnitID, ChannelID, CreatedAt, Description, Disabled, DisplayName, Event, FunctionName, Hash, HiddenReason, InvocationID, OrganizationID, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
15993
16006
|
|
|
15994
16007
|
Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
|
|
15995
16008
|
|
|
@@ -16040,7 +16053,7 @@ type BulkPatchTriggersApiArg = {
|
|
|
16040
16053
|
An example conjunction is:
|
|
16041
16054
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16042
16055
|
|
|
16043
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
16056
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
16044
16057
|
|
|
16045
16058
|
A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
16046
16059
|
|
|
@@ -16131,7 +16144,9 @@ type BulkPatchTriggersApiArg = {
|
|
|
16131
16144
|
Labels?: {
|
|
16132
16145
|
[key: string]: string | null;
|
|
16133
16146
|
} | null;
|
|
16134
|
-
|
|
16147
|
+
OtherUnitIDs?: {
|
|
16148
|
+
[key: string]: string | null;
|
|
16149
|
+
} | null;
|
|
16135
16150
|
Permissions?: {
|
|
16136
16151
|
[key: string]: object | null;
|
|
16137
16152
|
} | null;
|
|
@@ -16184,7 +16199,7 @@ type BulkCreateTriggersApiArg = {
|
|
|
16184
16199
|
An example conjunction is:
|
|
16185
16200
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16186
16201
|
|
|
16187
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
16202
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
16188
16203
|
|
|
16189
16204
|
A Trigger returns the function it invokes inline rather than in a FunctionInvocation object, so `where` names FunctionName and Arguments directly. The arguments are addressed with dot notation into `Arguments`, which is a list: `Arguments.?ParameterName=attribute-name.Value = 'owner'` reads the argument bound to a named parameter, `Arguments.*.Value` matches any argument's value, and `Arguments.0.Value` addresses the first argument. Arguments passed positionally have no ParameterName.
|
|
16190
16205
|
|
|
@@ -16379,7 +16394,9 @@ type BulkCreateTriggersApiArg = {
|
|
|
16379
16394
|
Labels?: {
|
|
16380
16395
|
[key: string]: string | null;
|
|
16381
16396
|
} | null;
|
|
16382
|
-
|
|
16397
|
+
OtherUnitIDs?: {
|
|
16398
|
+
[key: string]: string | null;
|
|
16399
|
+
} | null;
|
|
16383
16400
|
Permissions?: {
|
|
16384
16401
|
[key: string]: object | null;
|
|
16385
16402
|
} | null;
|
|
@@ -16432,7 +16449,7 @@ type BulkMoveTriggersApiArg = {
|
|
|
16432
16449
|
An example conjunction is:
|
|
16433
16450
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
16434
16451
|
|
|
16435
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
16452
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
16436
16453
|
|
|
16437
16454
|
The whole string must be query-encoded. */
|
|
16438
16455
|
where?: string;
|
|
@@ -18873,8 +18890,6 @@ type Component = {
|
|
|
18873
18890
|
Annotations?: {
|
|
18874
18891
|
[key: string]: string;
|
|
18875
18892
|
};
|
|
18876
|
-
/** Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
18877
|
-
ChangeWorkflowRequired?: boolean;
|
|
18878
18893
|
/** Unique identifier for a component. */
|
|
18879
18894
|
ComponentID?: string;
|
|
18880
18895
|
/** An optional set of gates that, if any is present, will block deletion. */
|
|
@@ -18893,6 +18908,10 @@ type Component = {
|
|
|
18893
18908
|
OrganizationID?: string;
|
|
18894
18909
|
/** Permissions to access this component. */
|
|
18895
18910
|
Permissions?: Permissions;
|
|
18911
|
+
/** Whether a change to the configuration of a Unit in one of this component's Variants has to be made in a ChangeSet open on the Unit, or under a ChangeOrder: creating a Unit, writing its data, updating it with a restore, upgrade, merge or resolve, invoking functions on it, uploading, promoting and demoting. A write under a ChangeOrder is one that names it: a promotion or demotion of it, an upgrade, resolve or restore with change_order, or an invocation with change_order. A backing Unit refreshed from its entity and a resolve made by the resolve queue are exempt, and their Revisions belong to the ChangeSet open on the Unit, if any. Changing it requires Manage permission on the component. (optional) */
|
|
18912
|
+
RequireChangeTracking?: boolean;
|
|
18913
|
+
/** Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
18914
|
+
RequireChangeWorkflow?: boolean;
|
|
18896
18915
|
/** Unique URL-safe identifier for the entity. */
|
|
18897
18916
|
Slug: string;
|
|
18898
18917
|
/** An entity-specific sequence number used for optimistic concurrency control. The value read must be sent in calls to Update. */
|
|
@@ -18906,8 +18925,6 @@ type ComponentRead = {
|
|
|
18906
18925
|
[key: string]: string;
|
|
18907
18926
|
};
|
|
18908
18927
|
BackingUnitID?: string;
|
|
18909
|
-
/** Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
18910
|
-
ChangeWorkflowRequired?: boolean;
|
|
18911
18928
|
/** Unique identifier for a component. */
|
|
18912
18929
|
ComponentID?: string;
|
|
18913
18930
|
/** The timestamp when the entity was created in "2023-01-01T12:00:00Z" format. */
|
|
@@ -18930,6 +18947,10 @@ type ComponentRead = {
|
|
|
18930
18947
|
OrganizationID?: string;
|
|
18931
18948
|
/** Permissions to access this component. */
|
|
18932
18949
|
Permissions?: Permissions;
|
|
18950
|
+
/** Whether a change to the configuration of a Unit in one of this component's Variants has to be made in a ChangeSet open on the Unit, or under a ChangeOrder: creating a Unit, writing its data, updating it with a restore, upgrade, merge or resolve, invoking functions on it, uploading, promoting and demoting. A write under a ChangeOrder is one that names it: a promotion or demotion of it, an upgrade, resolve or restore with change_order, or an invocation with change_order. A backing Unit refreshed from its entity and a resolve made by the resolve queue are exempt, and their Revisions belong to the ChangeSet open on the Unit, if any. Changing it requires Manage permission on the component. (optional) */
|
|
18951
|
+
RequireChangeTracking?: boolean;
|
|
18952
|
+
/** Whether a ChangeWorkflow must be used for promotions and releases of this component's Variants, and by ChangeSets opened on their Units. Changing it requires Manage permission on the component. (optional) */
|
|
18953
|
+
RequireChangeWorkflow?: boolean;
|
|
18933
18954
|
/** Unique URL-safe identifier for the entity. */
|
|
18934
18955
|
Slug: string;
|
|
18935
18956
|
/** The timestamp when the entity was last updated in "2023-01-01T12:00:00Z" format. */
|
|
@@ -19131,7 +19152,7 @@ type Space = {
|
|
|
19131
19152
|
An example conjunction is:
|
|
19132
19153
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
19133
19154
|
|
|
19134
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
19155
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
19135
19156
|
|
|
19136
19157
|
The whole string must be query-encoded. */
|
|
19137
19158
|
WhereTrigger?: string;
|
|
@@ -19261,7 +19282,7 @@ type SpaceRead = {
|
|
|
19261
19282
|
An example conjunction is:
|
|
19262
19283
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
19263
19284
|
|
|
19264
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
19285
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
19265
19286
|
|
|
19266
19287
|
The whole string must be query-encoded. */
|
|
19267
19288
|
WhereTrigger?: string;
|
|
@@ -20322,6 +20343,10 @@ type Invocation = {
|
|
|
20322
20343
|
};
|
|
20323
20344
|
/** Unique identifier for an organization. */
|
|
20324
20345
|
OrganizationID?: string;
|
|
20346
|
+
/** Other Units to pass to the invocation's functions as OtherData, by the key the functions read each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a Unit named here cannot be deleted while the invocation names it. Naming a Unit requires Use permission on it. A trigger that runs the invocation takes them from here. */
|
|
20347
|
+
OtherUnitIDs?: {
|
|
20348
|
+
[key: string]: Uuid;
|
|
20349
|
+
};
|
|
20325
20350
|
Parameters?: FunctionParameter[];
|
|
20326
20351
|
/** Permissions to access this invocation. */
|
|
20327
20352
|
Permissions?: Permissions;
|
|
@@ -20370,6 +20395,10 @@ type InvocationRead = {
|
|
|
20370
20395
|
};
|
|
20371
20396
|
/** Unique identifier for an organization. */
|
|
20372
20397
|
OrganizationID?: string;
|
|
20398
|
+
/** Other Units to pass to the invocation's functions as OtherData, by the key the functions read each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a Unit named here cannot be deleted while the invocation names it. Naming a Unit requires Use permission on it. A trigger that runs the invocation takes them from here. */
|
|
20399
|
+
OtherUnitIDs?: {
|
|
20400
|
+
[key: string]: Uuid;
|
|
20401
|
+
};
|
|
20373
20402
|
Parameters?: FunctionParameter[];
|
|
20374
20403
|
/** Permissions to access this invocation. */
|
|
20375
20404
|
Permissions?: Permissions;
|
|
@@ -21316,7 +21345,7 @@ type FunctionSignature = {
|
|
|
21316
21345
|
Idempotent?: boolean;
|
|
21317
21346
|
/** May change the configuration data */
|
|
21318
21347
|
Mutating?: boolean;
|
|
21319
|
-
/**
|
|
21348
|
+
/** The keys of the OtherData the function reads, if any: a revision specifier such as LastReleasedRevisionNum, which a caller that names no revision is passed, or a key such as schema under which the caller passes another Unit. Letters, digits, '-' and '_'. */
|
|
21320
21349
|
OtherDataExpected?: string[];
|
|
21321
21350
|
/** Output description */
|
|
21322
21351
|
OutputInfo?: FunctionOutput;
|
|
@@ -22108,6 +22137,10 @@ type AttestationGateEntry = {
|
|
|
22108
22137
|
AttestationID?: string;
|
|
22109
22138
|
/** How many of the Revisions evaluated it counts on. A Fail that counts rejects them. */
|
|
22110
22139
|
CountedOn?: number;
|
|
22140
|
+
/** How many of the Revisions it counts on have the content the Space's latest Release already bundles for their Unit. */
|
|
22141
|
+
CountedOnPreviouslyReleased?: number;
|
|
22142
|
+
/** It covers a Revision evaluated whose content the Space's latest Release does not already bundle, so it is a decision on what is being promoted or released. Every Attestation an entry or Final gate finds covers one. */
|
|
22143
|
+
CoversNew?: boolean;
|
|
22111
22144
|
CreatedAt?: string;
|
|
22112
22145
|
/** Why it counts on none of the Revisions it covers: Revoked, Expired, TooOld (older than MaxAge), NotEligible, Author, or FailIgnored (a Fail, under IgnoreFail). */
|
|
22113
22146
|
Reason?: string;
|
|
@@ -22130,6 +22163,8 @@ type AttestationGateRevision = {
|
|
|
22130
22163
|
AuthorUserIDs?: Uuid[];
|
|
22131
22164
|
/** Distinct attesters counted on this Revision. */
|
|
22132
22165
|
Counted?: number;
|
|
22166
|
+
/** The Space's latest Release already bundles this content for the Unit: it was released without what the prerequisite asks for. */
|
|
22167
|
+
PreviouslyReleased?: boolean;
|
|
22133
22168
|
/** AttestationsMissing or AttestationRejected. */
|
|
22134
22169
|
Reason?: string;
|
|
22135
22170
|
RevisionNum?: number;
|
|
@@ -22145,6 +22180,8 @@ type AttestationGateResult = {
|
|
|
22145
22180
|
Caller?: AttestationGateCaller;
|
|
22146
22181
|
/** The fewest attesters counted on any Revision evaluated: the gate's progress toward Required. */
|
|
22147
22182
|
Counted?: number;
|
|
22183
|
+
/** For a release gate, how many of the Revisions evaluated have the content the Space's latest Release already bundles for their Unit. */
|
|
22184
|
+
PreviouslyReleased?: number;
|
|
22148
22185
|
/** How many distinct attesters each Revision needs: Count, or the number of FromGroupIDs with DistinctGroups. */
|
|
22149
22186
|
Required?: number;
|
|
22150
22187
|
/** How many Revisions were evaluated: one of each Unit the change changed in the Space, or each Revision a Release bundles. */
|
|
@@ -22470,7 +22507,7 @@ type Target = {
|
|
|
22470
22507
|
An example conjunction is:
|
|
22471
22508
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22472
22509
|
|
|
22473
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
22510
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
22474
22511
|
|
|
22475
22512
|
The whole string must be query-encoded. */
|
|
22476
22513
|
WhereTrigger?: string;
|
|
@@ -22557,7 +22594,7 @@ type TargetRead = {
|
|
|
22557
22594
|
An example conjunction is:
|
|
22558
22595
|
`CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
|
|
22559
22596
|
|
|
22560
|
-
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID,
|
|
22597
|
+
Supported attributes for filtering on Trigger: Annotations, Arguments, BackingUnitID, ChannelID, Clearance, CreatedAt, DeleteGates, Description, Disabled, DisplayName, Event, FunctionName, Guards, Hash, HiddenReason, InvocationID, Labels, OrganizationID, OtherUnitIDs, Permissions, Protect, Slug, SpaceID, ToolchainType, TriggerID, UnitFilterID, UpdatedAt, UpstreamTriggerID, Validating, Warn, WhereResource, WhereUnit.
|
|
22561
22598
|
|
|
22562
22599
|
The whole string must be query-encoded. */
|
|
22563
22600
|
WhereTrigger?: string;
|
|
@@ -23202,8 +23239,10 @@ type Trigger = {
|
|
|
23202
23239
|
};
|
|
23203
23240
|
/** Unique identifier for an organization. */
|
|
23204
23241
|
OrganizationID?: string;
|
|
23205
|
-
/**
|
|
23206
|
-
|
|
23242
|
+
/** Other Units to pass to the trigger's function as OtherData, by the key the function reads each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a Unit named here cannot be deleted while the trigger names it. Naming a Unit requires Use permission on it. Empty on a trigger that references an Invocation, which takes the Invocation's. */
|
|
23243
|
+
OtherUnitIDs?: {
|
|
23244
|
+
[key: string]: Uuid;
|
|
23245
|
+
};
|
|
23207
23246
|
/** Permissions to access this trigger. */
|
|
23208
23247
|
Permissions?: Permissions;
|
|
23209
23248
|
/** Protect indicates whether the paths this trigger's function writes are recorded as protected local overrides, so a later merge from upstream does not overwrite them. A change claims nothing by default and so does a trigger; set this for a trigger that decides a value on the Unit's behalf and will not be back to decide it again, such as a PostClone trigger customizing a variant. Only meaningful for a mutating trigger. */
|
|
@@ -23272,8 +23311,10 @@ type TriggerRead = {
|
|
|
23272
23311
|
};
|
|
23273
23312
|
/** Unique identifier for an organization. */
|
|
23274
23313
|
OrganizationID?: string;
|
|
23275
|
-
/**
|
|
23276
|
-
|
|
23314
|
+
/** Other Units to pass to the trigger's function as OtherData, by the key the function reads each under, such as policy for vet-validating-admission-policy. Each Unit's head data is passed, and a Unit named here cannot be deleted while the trigger names it. Naming a Unit requires Use permission on it. Empty on a trigger that references an Invocation, which takes the Invocation's. */
|
|
23315
|
+
OtherUnitIDs?: {
|
|
23316
|
+
[key: string]: Uuid;
|
|
23317
|
+
};
|
|
23277
23318
|
/** Permissions to access this trigger. */
|
|
23278
23319
|
Permissions?: Permissions;
|
|
23279
23320
|
/** Protect indicates whether the paths this trigger's function writes are recorded as protected local overrides, so a later merge from upstream does not overwrite them. A change claims nothing by default and so does a trigger; set this for a trigger that decides a value on the Unit's behalf and will not be back to decide it again, such as a PostClone trigger customizing a variant. Only meaningful for a mutating trigger. */
|
|
@@ -24112,6 +24153,8 @@ type UnitConflictSelector = {
|
|
|
24112
24153
|
type UnitConflictsRequest = {
|
|
24113
24154
|
/** Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */
|
|
24114
24155
|
Action?: string;
|
|
24156
|
+
/** The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. */
|
|
24157
|
+
ChangeSetID?: string;
|
|
24115
24158
|
/** With Apply, the classes of guarded reason the applied changes are cleared for, as a list of {Key, Operator, Values} requirements. A withheld value is written only where the guards at its path admit this clearance, and a withheld guard change only where the guards already at its path do; the request is refused otherwise. Not taken by Dismiss or Undismiss, which write no configuration data and no guards. */
|
|
24116
24159
|
Clearance?: Clearance;
|
|
24117
24160
|
/** Report what the request would do without writing anything. The response carries the Unit as it would be. */
|
|
@@ -24161,6 +24204,8 @@ type ResourceGuards = {
|
|
|
24161
24204
|
type UnitGuardRequest = {
|
|
24162
24205
|
/** Recorded on the Revision the edit creates. Defaults to "Set path guards". */
|
|
24163
24206
|
ChangeDescription?: string;
|
|
24207
|
+
/** The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. */
|
|
24208
|
+
ChangeSetID?: string;
|
|
24164
24209
|
/** The classes of reason this edit is cleared for; required to edit a path that already carries guards */
|
|
24165
24210
|
Clearance?: Clearance;
|
|
24166
24211
|
/** Per-resource guard edits to apply to the Unit's PathAnnotations */
|
|
@@ -24286,6 +24331,8 @@ type ResourceProtection = {
|
|
|
24286
24331
|
type UnitProtectionRequest = {
|
|
24287
24332
|
/** Recorded on the Revision the edit creates. Defaults to "Set path protection". */
|
|
24288
24333
|
ChangeDescription?: string;
|
|
24334
|
+
/** The ChangeSet open on the Unit, which a request that creates a Revision of a Unit in a ChangeSet has to name: a ChangeSet locks the Units it is open on. */
|
|
24335
|
+
ChangeSetID?: string;
|
|
24289
24336
|
/** Per-resource Protected edits to apply to the Unit's MutationSources */
|
|
24290
24337
|
ResourceProtection?: ResourceProtection[] | null;
|
|
24291
24338
|
/** Clear every Protected value on the Unit's MutationSources before applying ResourceProtection */
|