@confighub/rtk-query 0.8.22 → 0.8.24
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 +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +75 -29
- package/dist/index.d.ts +75 -29
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4796,13 +4796,17 @@ type DemoteApiResponse = /** status 200 OK */ DemoteResult | /** status 207 Mult
|
|
|
4796
4796
|
type DemoteApiArg = {
|
|
4797
4797
|
/** Plan the demotion and return the same response without writing anything. */
|
|
4798
4798
|
dryRun?: boolean;
|
|
4799
|
-
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each restore changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides.
|
|
4799
|
+
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each restore changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides.
|
|
4800
|
+
|
|
4801
|
+
Supported values: Mutations, Diff. */
|
|
4800
4802
|
include?: string;
|
|
4801
4803
|
demoteRequest: DemoteRequest;
|
|
4802
4804
|
};
|
|
4803
4805
|
type DiffConfigurationsApiResponse = DiffResult;
|
|
4804
4806
|
type DiffConfigurationsApiArg = {
|
|
4805
|
-
/** Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value,
|
|
4807
|
+
/** 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.
|
|
4808
|
+
|
|
4809
|
+
Supported values: Attribution, Unchanged, Context. */
|
|
4806
4810
|
include?: string;
|
|
4807
4811
|
/** Limit the diff to the resources this where expression selects on either side. */
|
|
4808
4812
|
whereResource?: string;
|
|
@@ -5565,7 +5569,7 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
5565
5569
|
|
|
5566
5570
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
5567
5571
|
|
|
5568
|
-
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`.
|
|
5572
|
+
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 TargetID IS NOT NULL`.
|
|
5569
5573
|
|
|
5570
5574
|
The whole string must be query-encoded. */
|
|
5571
5575
|
where?: string;
|
|
@@ -5589,7 +5593,9 @@ type InvokeFunctionsOnOrgApiArg = {
|
|
|
5589
5593
|
|
|
5590
5594
|
ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */
|
|
5591
5595
|
includeHidden?: string;
|
|
5592
|
-
/** Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides.
|
|
5596
|
+
/** Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides.
|
|
5597
|
+
|
|
5598
|
+
Supported values: ConfigData, Diff. */
|
|
5593
5599
|
include?: string;
|
|
5594
5600
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
5595
5601
|
resourceType?: string;
|
|
@@ -7262,7 +7268,9 @@ type PromoteApiResponse = /** status 200 OK */ PromoteResult | /** status 207 Mu
|
|
|
7262
7268
|
type PromoteApiArg = {
|
|
7263
7269
|
/** Deprecated: use DryRun in the request body. Plan the promotion, evaluate its gates, and return the same response without writing anything. Either one asks for a dry run. */
|
|
7264
7270
|
dryRun?: boolean;
|
|
7265
|
-
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named.
|
|
7271
|
+
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides, and ConfigData for the configuration each Unit write produced, or on a dry run would produce. On a dry run any of them runs the merges a plan otherwise skips, so they are returned only when named.
|
|
7272
|
+
|
|
7273
|
+
Supported values: Mutations, Diff, ConfigData. */
|
|
7266
7274
|
include?: string;
|
|
7267
7275
|
promoteRequest: PromoteRequest;
|
|
7268
7276
|
};
|
|
@@ -7380,6 +7388,14 @@ type ListAllReleasesApiArg = {
|
|
|
7380
7388
|
|
|
7381
7389
|
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. */
|
|
7382
7390
|
continue?: string;
|
|
7391
|
+
/** Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
|
|
7392
|
+
|
|
7393
|
+
Supported values: Space, Off.
|
|
7394
|
+
|
|
7395
|
+
If not specified, results are restricted to at most one row per Space.
|
|
7396
|
+
|
|
7397
|
+
Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one. */
|
|
7398
|
+
distinctOn?: "Space" | "Off";
|
|
7383
7399
|
};
|
|
7384
7400
|
type ListAllResourcesApiResponse =
|
|
7385
7401
|
/** status 200 OK */ ExtendedResourceRead[];
|
|
@@ -10741,7 +10757,7 @@ type InvokeFunctionsApiArg = {
|
|
|
10741
10757
|
|
|
10742
10758
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
10743
10759
|
|
|
10744
|
-
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`.
|
|
10760
|
+
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 TargetID IS NOT NULL`.
|
|
10745
10761
|
|
|
10746
10762
|
The whole string must be query-encoded. */
|
|
10747
10763
|
where?: string;
|
|
@@ -10765,7 +10781,9 @@ type InvokeFunctionsApiArg = {
|
|
|
10765
10781
|
|
|
10766
10782
|
ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */
|
|
10767
10783
|
includeHidden?: string;
|
|
10768
|
-
/** Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides.
|
|
10784
|
+
/** Comma-separated parts of the result to return in addition to the default: ConfigData for the configuration the invocation produced, carried whether or not the invocation changed it. Without it, the configuration is present only when the invocation changed it, and an unchanged result is reported by DataHash alone. Diff for what the invocation changed in each Unit, path by path with the values on both sides.
|
|
10785
|
+
|
|
10786
|
+
Supported values: ConfigData, Diff. */
|
|
10769
10787
|
include?: string;
|
|
10770
10788
|
/** Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
|
|
10771
10789
|
resourceType?: string;
|
|
@@ -12262,7 +12280,7 @@ type ListUnitsApiArg = {
|
|
|
12262
12280
|
|
|
12263
12281
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
12264
12282
|
|
|
12265
|
-
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`.
|
|
12283
|
+
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 TargetID IS NOT NULL`.
|
|
12266
12284
|
|
|
12267
12285
|
The whole string must be query-encoded. */
|
|
12268
12286
|
where?: string;
|
|
@@ -12371,7 +12389,9 @@ type CreateUnitApiArg = {
|
|
|
12371
12389
|
mergeExternalSource?: string;
|
|
12372
12390
|
/** Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
|
|
12373
12391
|
allowExists?: string;
|
|
12374
|
-
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12392
|
+
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12393
|
+
|
|
12394
|
+
Supported values: ConfigData, MutationSources, Diff. */
|
|
12375
12395
|
include?: string;
|
|
12376
12396
|
/** If true, report what the write would do without doing it: the write runs, including every check it makes, and is then rolled back. The response is the one the write would return, with the entities as they would be written. An entity a dry run creates is given an ID that the real create will not reuse. */
|
|
12377
12397
|
dryRun?: boolean;
|
|
@@ -12509,7 +12529,9 @@ type PatchUnitApiArg = {
|
|
|
12509
12529
|
priorRevisions?: string;
|
|
12510
12530
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
12511
12531
|
subgroup?: string;
|
|
12512
|
-
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12532
|
+
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12533
|
+
|
|
12534
|
+
Supported values: ConfigData, MutationSources, Diff. */
|
|
12513
12535
|
include?: string;
|
|
12514
12536
|
body: {
|
|
12515
12537
|
/** An optional map of Annotation key/value pairs for tools to attach information to entities. */
|
|
@@ -12647,7 +12669,9 @@ type UpdateUnitApiArg = {
|
|
|
12647
12669
|
priorRevisions?: string;
|
|
12648
12670
|
/** User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
|
|
12649
12671
|
subgroup?: string;
|
|
12650
|
-
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12672
|
+
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12673
|
+
|
|
12674
|
+
Supported values: ConfigData, MutationSources, Diff. */
|
|
12651
12675
|
include?: string;
|
|
12652
12676
|
unit: Unit;
|
|
12653
12677
|
};
|
|
@@ -12676,7 +12700,9 @@ type UploadUnitDataApiArg = {
|
|
|
12676
12700
|
unitId: string;
|
|
12677
12701
|
/** Human-readable description of this change, copied to the Revision it creates. */
|
|
12678
12702
|
lastChangeDescription?: string;
|
|
12679
|
-
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12703
|
+
/** Comma-separated parts of the result to return in addition to the Unit: 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.
|
|
12704
|
+
|
|
12705
|
+
Supported values: ConfigData, MutationSources, Diff. */
|
|
12680
12706
|
include?: string;
|
|
12681
12707
|
/** The DataHash of the configuration this write replaces, as the ETag a read of the Unit's data served it (quoted) or bare. The write is refused with 409 Conflict when the Unit's configuration is not that one, so an edit made from one Unit's configuration, or before somebody else's write, cannot land over another. Omitted, the write is unconditional. */
|
|
12682
12708
|
"If-Match"?: string;
|
|
@@ -12712,7 +12738,9 @@ type GetUnitDiffApiArg = {
|
|
|
12712
12738
|
from?: string;
|
|
12713
12739
|
/** The Revision on the To side, in the same syntax as from. */
|
|
12714
12740
|
to?: string;
|
|
12715
|
-
/** Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value,
|
|
12741
|
+
/** 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.
|
|
12742
|
+
|
|
12743
|
+
Supported values: Attribution, Unchanged, Context. */
|
|
12716
12744
|
include?: string;
|
|
12717
12745
|
/** Limit the diff to the resources this where expression selects on either side. */
|
|
12718
12746
|
whereResource?: string;
|
|
@@ -15843,7 +15871,7 @@ type BulkDeleteUnitsApiArg = {
|
|
|
15843
15871
|
|
|
15844
15872
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
15845
15873
|
|
|
15846
|
-
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`.
|
|
15874
|
+
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 TargetID IS NOT NULL`.
|
|
15847
15875
|
|
|
15848
15876
|
The whole string must be query-encoded. */
|
|
15849
15877
|
where?: string;
|
|
@@ -15936,7 +15964,7 @@ type ListAllUnitsApiArg = {
|
|
|
15936
15964
|
|
|
15937
15965
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
15938
15966
|
|
|
15939
|
-
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`.
|
|
15967
|
+
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 TargetID IS NOT NULL`.
|
|
15940
15968
|
|
|
15941
15969
|
The whole string must be query-encoded. */
|
|
15942
15970
|
where?: string;
|
|
@@ -16066,7 +16094,7 @@ type BulkPatchUnitsApiArg = {
|
|
|
16066
16094
|
|
|
16067
16095
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16068
16096
|
|
|
16069
|
-
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`.
|
|
16097
|
+
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 TargetID IS NOT NULL`.
|
|
16070
16098
|
|
|
16071
16099
|
The whole string must be query-encoded. */
|
|
16072
16100
|
where?: string;
|
|
@@ -16112,6 +16140,10 @@ type BulkPatchUnitsApiArg = {
|
|
|
16112
16140
|
|
|
16113
16141
|
Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
16114
16142
|
|
|
16143
|
+
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.
|
|
16144
|
+
|
|
16145
|
+
Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
|
|
16146
|
+
|
|
16115
16147
|
The whole string must be query-encoded. */
|
|
16116
16148
|
include?: string;
|
|
16117
16149
|
/** Maximum number of Unit entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
@@ -16283,7 +16315,7 @@ type BulkCreateUnitsApiArg = {
|
|
|
16283
16315
|
|
|
16284
16316
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16285
16317
|
|
|
16286
|
-
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`.
|
|
16318
|
+
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 TargetID IS NOT NULL`.
|
|
16287
16319
|
|
|
16288
16320
|
The whole string must be query-encoded. */
|
|
16289
16321
|
where?: string;
|
|
@@ -16329,6 +16361,10 @@ type BulkCreateUnitsApiArg = {
|
|
|
16329
16361
|
|
|
16330
16362
|
Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
|
|
16331
16363
|
|
|
16364
|
+
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.
|
|
16365
|
+
|
|
16366
|
+
Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
|
|
16367
|
+
|
|
16332
16368
|
The whole string must be query-encoded. */
|
|
16333
16369
|
include?: string;
|
|
16334
16370
|
/** Maximum number of Unit entities to act on, in ID order. A request that names limit or continue also stops when it runs short of time, and returns a ConfigHub-Continue header to pass as the continue parameter of the next request; keep sending requests until a response has none. If neither is specified, the request acts on every selected entity. */
|
|
@@ -16518,7 +16554,7 @@ type BulkCancelUnitsApiArg = {
|
|
|
16518
16554
|
|
|
16519
16555
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16520
16556
|
|
|
16521
|
-
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`.
|
|
16557
|
+
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 TargetID IS NOT NULL`.
|
|
16522
16558
|
|
|
16523
16559
|
The whole string must be query-encoded. */
|
|
16524
16560
|
where?: string;
|
|
@@ -16605,7 +16641,7 @@ type BulkMoveUnitsApiArg = {
|
|
|
16605
16641
|
|
|
16606
16642
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16607
16643
|
|
|
16608
|
-
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`.
|
|
16644
|
+
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 TargetID IS NOT NULL`.
|
|
16609
16645
|
|
|
16610
16646
|
The whole string must be query-encoded. */
|
|
16611
16647
|
where?: string;
|
|
@@ -16695,7 +16731,7 @@ type BulkTagUnitsApiArg = {
|
|
|
16695
16731
|
|
|
16696
16732
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16697
16733
|
|
|
16698
|
-
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`.
|
|
16734
|
+
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 TargetID IS NOT NULL`.
|
|
16699
16735
|
|
|
16700
16736
|
The whole string must be query-encoded. */
|
|
16701
16737
|
where?: string;
|
|
@@ -16872,7 +16908,7 @@ type SearchUnitDataApiArg = {
|
|
|
16872
16908
|
|
|
16873
16909
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
16874
16910
|
|
|
16875
|
-
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`.
|
|
16911
|
+
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 TargetID IS NOT NULL`.
|
|
16876
16912
|
|
|
16877
16913
|
The whole string must be query-encoded. */
|
|
16878
16914
|
where?: string;
|
|
@@ -17002,7 +17038,7 @@ type SearchUnitDiffApiArg = {
|
|
|
17002
17038
|
|
|
17003
17039
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
17004
17040
|
|
|
17005
|
-
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`.
|
|
17041
|
+
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 TargetID IS NOT NULL`.
|
|
17006
17042
|
|
|
17007
17043
|
The whole string must be query-encoded. */
|
|
17008
17044
|
where?: string;
|
|
@@ -17080,7 +17116,9 @@ type SearchUnitDiffApiArg = {
|
|
|
17080
17116
|
from?: string;
|
|
17081
17117
|
/** The Revision on the To side, in the same syntax as from. */
|
|
17082
17118
|
to?: string;
|
|
17083
|
-
/** Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value,
|
|
17119
|
+
/** 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.
|
|
17120
|
+
|
|
17121
|
+
Supported values: Attribution, Unchanged, Context. */
|
|
17084
17122
|
include?: string;
|
|
17085
17123
|
/** Limit the diff to the resources this where expression selects on either side. */
|
|
17086
17124
|
whereResource?: string;
|
|
@@ -17231,7 +17269,7 @@ type SearchUnitMutationSourcesApiArg = {
|
|
|
17231
17269
|
|
|
17232
17270
|
Supported attributes for filtering on Unit: Annotations, ApplyGates, ApplyWarnings, ChangeSetID, Conflicts, CreatedAt, DataHash, DeleteGates, DestroyGates, DisplayName, FromLinkID, HeadRevisionID, HeadRevisionNum, HeadUnitActionNum, HeadUnitEventNum, HiddenReason, Labels, LastChangeDescription, LastReleasedRevisionNum, LinkFindings, NeededPaths, OrganizationID, Permissions, ProvidedPaths, ProviderType, Slug, SpaceID, TargetID, ToolchainType, UnitID, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
17233
17271
|
|
|
17234
|
-
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`.
|
|
17272
|
+
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 TargetID IS NOT NULL`.
|
|
17235
17273
|
|
|
17236
17274
|
The whole string must be query-encoded. */
|
|
17237
17275
|
where?: string;
|
|
@@ -17327,7 +17365,9 @@ type UploadApiResponse = /** status 200 OK */ UploadResult | /** status 207 Mult
|
|
|
17327
17365
|
type UploadApiArg = {
|
|
17328
17366
|
/** Deprecated: use DryRun in the request body. Plan the upload and return the same response without writing anything. Either one asks for a dry run. */
|
|
17329
17367
|
dryRun?: boolean;
|
|
17330
|
-
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named.
|
|
17368
|
+
/** Comma-separated parts of the result to return in addition to the actions: Mutations for what each Unit write changed, or on a dry run would change, as entries of its MutationSources, and Diff for the same change path by path with the values on both sides. They cost something to return, and on a dry run either one runs the merges a plan otherwise skips, so they are returned only when named.
|
|
17369
|
+
|
|
17370
|
+
Supported values: Mutations, Diff. */
|
|
17331
17371
|
include?: string;
|
|
17332
17372
|
uploadRequest: UploadRequest;
|
|
17333
17373
|
};
|
|
@@ -20445,19 +20485,23 @@ type PathSegment = {
|
|
|
20445
20485
|
/** The map key, for a map segment */
|
|
20446
20486
|
Field?: string;
|
|
20447
20487
|
/** The element's index on the From side; -1 for a map key or an element absent there */
|
|
20448
|
-
FromIndex
|
|
20488
|
+
FromIndex: number;
|
|
20449
20489
|
/** The merge keys that identify the element, for an element of a merge-keyed array */
|
|
20450
20490
|
MergeKeys?: MergeKeyValue[];
|
|
20451
20491
|
/** The element's index on the To side; -1 for a map key or an element absent there */
|
|
20452
|
-
ToIndex
|
|
20492
|
+
ToIndex: number;
|
|
20453
20493
|
};
|
|
20454
20494
|
type PathChange = {
|
|
20455
20495
|
/** The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
|
|
20456
20496
|
Attribution?: MutationInfo;
|
|
20457
|
-
/** Add, Delete, Update, Replace, Reorder, or Rename */
|
|
20497
|
+
/** Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */
|
|
20458
20498
|
ChangeType?: string;
|
|
20499
|
+
/** Head, Line, or Foot when the change is to a comment on the node at the path rather than to its value: the comment above the node, at the end of its line, or below it. The path of a comment on a whole resource is empty */
|
|
20500
|
+
Comment?: string;
|
|
20459
20501
|
/** The path in configuration path syntax, as --path arguments and where filters take it, with each unkeyed array element named by its index */
|
|
20460
20502
|
DisplayPath?: string;
|
|
20503
|
+
/** How to read FromValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the From side has no value */
|
|
20504
|
+
FromDataType?: string;
|
|
20461
20505
|
/** The value on the From side: a scalar's text, or a YAML block for a map or array */
|
|
20462
20506
|
FromValue?: string;
|
|
20463
20507
|
/** A unified line diff, for multi-line string values */
|
|
@@ -20466,7 +20510,9 @@ type PathChange = {
|
|
|
20466
20510
|
Path?: string;
|
|
20467
20511
|
/** The path split into its segments, for rendering without parsing the path syntax */
|
|
20468
20512
|
Segments?: PathSegment[] | null;
|
|
20469
|
-
/**
|
|
20513
|
+
/** How to read ToValue: string, int, or bool for a scalar, YAML for a map or array, and empty for a scalar of another type, such as a float or null, or when the To side has no value */
|
|
20514
|
+
ToDataType?: string;
|
|
20515
|
+
/** The value on the To side: a scalar's text, or a YAML block for a map or array. For an unchanged path, the value on both sides */
|
|
20470
20516
|
ToValue?: string;
|
|
20471
20517
|
};
|
|
20472
20518
|
type ResourceInfo = {
|
package/dist/index.js
CHANGED
|
@@ -1408,7 +1408,8 @@ var injectedRtkApi = confighubApi.enhanceEndpoints({
|
|
|
1408
1408
|
include_hidden: queryArg.includeHidden,
|
|
1409
1409
|
limit: queryArg.limit,
|
|
1410
1410
|
order_by: queryArg.orderBy,
|
|
1411
|
-
continue: queryArg["continue"]
|
|
1411
|
+
continue: queryArg["continue"],
|
|
1412
|
+
distinct_on: queryArg.distinctOn
|
|
1412
1413
|
}
|
|
1413
1414
|
}),
|
|
1414
1415
|
providesTags: ["Release"]
|