@confighub/rtk-query 0.11.1 → 0.11.3
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 +1 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +13 -11
- package/dist/index.d.ts +13 -11
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -413,7 +413,7 @@ type BulkDeleteComponentsApiArg = {
|
|
|
413
413
|
The attribute names are case-sensitive, PascalCase, and
|
|
414
414
|
expected in a comma-separated list format as in the JSON encoding.
|
|
415
415
|
|
|
416
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
416
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
417
417
|
|
|
418
418
|
The whole string must be query-encoded. */
|
|
419
419
|
include?: string;
|
|
@@ -504,7 +504,7 @@ type BulkPatchComponentsApiArg = {
|
|
|
504
504
|
The attribute names are case-sensitive, PascalCase, and
|
|
505
505
|
expected in a comma-separated list format as in the JSON encoding.
|
|
506
506
|
|
|
507
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
507
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
508
508
|
|
|
509
509
|
The whole string must be query-encoded. */
|
|
510
510
|
include?: string;
|
|
@@ -4733,7 +4733,7 @@ type ListComponentsApiArg = {
|
|
|
4733
4733
|
The attribute names are case-sensitive, PascalCase, and
|
|
4734
4734
|
expected in a comma-separated list format as in the JSON encoding.
|
|
4735
4735
|
|
|
4736
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
4736
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
4737
4737
|
|
|
4738
4738
|
The whole string must be query-encoded. */
|
|
4739
4739
|
include?: string;
|
|
@@ -4815,7 +4815,7 @@ type GetComponentApiArg = {
|
|
|
4815
4815
|
The attribute names are case-sensitive, PascalCase, and
|
|
4816
4816
|
expected in a comma-separated list format as in the JSON encoding.
|
|
4817
4817
|
|
|
4818
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
4818
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
4819
4819
|
|
|
4820
4820
|
The whole string must be query-encoded. */
|
|
4821
4821
|
include?: string;
|
|
@@ -7131,6 +7131,8 @@ type BulkCreateLinksApiArg = {
|
|
|
7131
7131
|
|
|
7132
7132
|
ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */
|
|
7133
7133
|
includeHidden?: string;
|
|
7134
|
+
/** Create the NeedsProvides links between the Kubernetes/YAML units where_unit and filter_unit select that their configuration calls for, as upload infers them: from the references a resource makes to another, the Namespace a resource is in, the CRD that defines its type, and the label selectors that select a workload's pods. Links are inferred among the units of one space, and among those of spaces with the same ReleaseTargetID. A resource that names no namespace, or names the placeholder, is in its space's Namespace label, and in a namespace of the space's own if it has none. Each link is created in its from unit's space, with AutoUpdate, and the request body is applied to it, which can set its labels, annotations, delete gates and AutoUpdate but not its UpdateType. No link is created between two units that have a NeedsProvides link between them already, in either direction, and none that would close a cycle among the links created. Units of other toolchains are passed over. Takes none of the parameters that select links to copy or where the copies go. */
|
|
7135
|
+
fromRefs?: boolean;
|
|
7134
7136
|
/** Give each Link written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Link's configuration, which is then kept in step with it. */
|
|
7135
7137
|
withBackingUnits?: boolean;
|
|
7136
7138
|
/** Create Links from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
|
|
@@ -7171,11 +7173,11 @@ type BulkCreateLinksApiArg = {
|
|
|
7171
7173
|
|
|
7172
7174
|
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, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
7173
7175
|
|
|
7174
|
-
The Units to create entities from, with from_backing_units.
|
|
7176
|
+
The Units to create entities from, with from_backing_units, or to create links between, with from_refs.
|
|
7175
7177
|
|
|
7176
7178
|
The whole string must be query-encoded. */
|
|
7177
7179
|
whereUnit?: string;
|
|
7178
|
-
/** A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
7180
|
+
/** A Filter, by ID, over the Units to create entities from, with from_backing_units, or to create links between, with from_refs. */
|
|
7179
7181
|
filterUnit?: string;
|
|
7180
7182
|
/** With from_backing_units, patch a Link a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Link is returned as it is. */
|
|
7181
7183
|
patchExisting?: boolean;
|
|
@@ -21054,6 +21056,7 @@ type ExtendedCommandRunRead = {
|
|
|
21054
21056
|
ViewColumns?: ViewColumn[];
|
|
21055
21057
|
};
|
|
21056
21058
|
type ExtendedComponent = {
|
|
21059
|
+
AllowedChangeWorkflows?: ChangeWorkflow[];
|
|
21057
21060
|
Component?: Component;
|
|
21058
21061
|
Error?: ResponseError;
|
|
21059
21062
|
Organization?: Organization;
|
|
@@ -21062,6 +21065,7 @@ type ExtendedComponent = {
|
|
|
21062
21065
|
ViewColumns?: ViewColumn[];
|
|
21063
21066
|
};
|
|
21064
21067
|
type ExtendedComponentRead = {
|
|
21068
|
+
AllowedChangeWorkflows?: ChangeWorkflowRead[];
|
|
21065
21069
|
Component?: ComponentRead;
|
|
21066
21070
|
Error?: ResponseError;
|
|
21067
21071
|
Organization?: OrganizationRead;
|
|
@@ -21343,6 +21347,8 @@ type FunctionSignature = {
|
|
|
21343
21347
|
Hermetic?: boolean;
|
|
21344
21348
|
/** Will return the same result if invoked again */
|
|
21345
21349
|
Idempotent?: boolean;
|
|
21350
|
+
/** Parts of the FunctionContext passed only to the functions that read them: Conflicts, the Unit's outstanding merge conflicts, and LinkFindings, what the resolves of its Links could not do */
|
|
21351
|
+
Include?: string[];
|
|
21346
21352
|
/** May change the configuration data */
|
|
21347
21353
|
Mutating?: boolean;
|
|
21348
21354
|
/** 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 '_'. */
|
|
@@ -21357,7 +21363,7 @@ type FunctionSignature = {
|
|
|
21357
21363
|
RequiredParameters?: number;
|
|
21358
21364
|
/** Toolchain under which the function is registered */
|
|
21359
21365
|
ToolchainType?: string;
|
|
21360
|
-
/** Returns ValidationResult */
|
|
21366
|
+
/** Returns a ValidationResult judging the resources selected, passing when none is selected unless it judges something it declares in Include */
|
|
21361
21367
|
Validating?: boolean;
|
|
21362
21368
|
/** Last parameter may be repeated */
|
|
21363
21369
|
VarArgs?: boolean;
|
|
@@ -21458,10 +21464,6 @@ type FunctionInvocationsRequest = {
|
|
|
21458
21464
|
ChangeDescription?: string;
|
|
21459
21465
|
ChannelID?: string;
|
|
21460
21466
|
FunctionInvocations?: FunctionInvocationList;
|
|
21461
|
-
/** Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them. A request that runs Triggers gets them regardless */
|
|
21462
|
-
IncludeConflicts?: boolean;
|
|
21463
|
-
/** Put what the resolves of the Unit's Links could not do in the FunctionContext, for functions that reason about it. A request that runs Triggers gets them regardless */
|
|
21464
|
-
IncludeLinkFindings?: boolean;
|
|
21465
21467
|
/** Invocations is a list of Invocation IDs to execute. The invocations must be within the same Organization. Invocations will be executed after the FunctionInvocations list. Functions are grouped by executor (built-in or Channel) and executed in phases: general mutating functions first, then final mutating functions (like ensure-context), then validating functions. Functions that don't match the unit's toolchain type are ignored. */
|
|
21466
21468
|
Invocations?: Uuid[];
|
|
21467
21469
|
/** NumFilters is the number of validating functions from the FunctionInvocations to treat as filters for the remaining functions in the list. In the case that the validation function does not pass, stop and don't execute the remaining functions, but don't report an error. */
|
package/dist/index.d.ts
CHANGED
|
@@ -413,7 +413,7 @@ type BulkDeleteComponentsApiArg = {
|
|
|
413
413
|
The attribute names are case-sensitive, PascalCase, and
|
|
414
414
|
expected in a comma-separated list format as in the JSON encoding.
|
|
415
415
|
|
|
416
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
416
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
417
417
|
|
|
418
418
|
The whole string must be query-encoded. */
|
|
419
419
|
include?: string;
|
|
@@ -504,7 +504,7 @@ type BulkPatchComponentsApiArg = {
|
|
|
504
504
|
The attribute names are case-sensitive, PascalCase, and
|
|
505
505
|
expected in a comma-separated list format as in the JSON encoding.
|
|
506
506
|
|
|
507
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
507
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
508
508
|
|
|
509
509
|
The whole string must be query-encoded. */
|
|
510
510
|
include?: string;
|
|
@@ -4733,7 +4733,7 @@ type ListComponentsApiArg = {
|
|
|
4733
4733
|
The attribute names are case-sensitive, PascalCase, and
|
|
4734
4734
|
expected in a comma-separated list format as in the JSON encoding.
|
|
4735
4735
|
|
|
4736
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
4736
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
4737
4737
|
|
|
4738
4738
|
The whole string must be query-encoded. */
|
|
4739
4739
|
include?: string;
|
|
@@ -4815,7 +4815,7 @@ type GetComponentApiArg = {
|
|
|
4815
4815
|
The attribute names are case-sensitive, PascalCase, and
|
|
4816
4816
|
expected in a comma-separated list format as in the JSON encoding.
|
|
4817
4817
|
|
|
4818
|
-
Supported attributes for Component are OrganizationID, Permissions.
|
|
4818
|
+
Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
|
|
4819
4819
|
|
|
4820
4820
|
The whole string must be query-encoded. */
|
|
4821
4821
|
include?: string;
|
|
@@ -7131,6 +7131,8 @@ type BulkCreateLinksApiArg = {
|
|
|
7131
7131
|
|
|
7132
7132
|
ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`. */
|
|
7133
7133
|
includeHidden?: string;
|
|
7134
|
+
/** Create the NeedsProvides links between the Kubernetes/YAML units where_unit and filter_unit select that their configuration calls for, as upload infers them: from the references a resource makes to another, the Namespace a resource is in, the CRD that defines its type, and the label selectors that select a workload's pods. Links are inferred among the units of one space, and among those of spaces with the same ReleaseTargetID. A resource that names no namespace, or names the placeholder, is in its space's Namespace label, and in a namespace of the space's own if it has none. Each link is created in its from unit's space, with AutoUpdate, and the request body is applied to it, which can set its labels, annotations, delete gates and AutoUpdate but not its UpdateType. No link is created between two units that have a NeedsProvides link between them already, in either direction, and none that would close a cycle among the links created. Units of other toolchains are passed over. Takes none of the parameters that select links to copy or where the copies go. */
|
|
7135
|
+
fromRefs?: boolean;
|
|
7134
7136
|
/** Give each Link written a backing Unit if it has none: a ConfigHub/YAML Unit holding the Link's configuration, which is then kept in step with it. */
|
|
7135
7137
|
withBackingUnits?: boolean;
|
|
7136
7138
|
/** Create Links from the ConfigHub/YAML Units where_unit and filter_unit select, each in its Unit's Space, and each with its Unit as its backing Unit. The request body is applied after the Unit's document. Units of other toolchains or describing other entity types are passed over; outstanding ValidationErrors on a Unit are an error. Takes none of the parameters that select entities to clone, name the clones or choose their Spaces. */
|
|
@@ -7171,11 +7173,11 @@ type BulkCreateLinksApiArg = {
|
|
|
7171
7173
|
|
|
7172
7174
|
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, Permissions, ProvidedPaths, Slug, SpaceID, TargetID, ToolchainType, UnitID, Unreleasable, UpdatedAt, UpstreamRevisionNum, UpstreamSpaceID, UpstreamUnitID, ValidationErrors, ValidationPassed, ValidationResults, ValidationTriggerIDs, ValidationWarnings, ValueTriggerIDs, Values.
|
|
7173
7175
|
|
|
7174
|
-
The Units to create entities from, with from_backing_units.
|
|
7176
|
+
The Units to create entities from, with from_backing_units, or to create links between, with from_refs.
|
|
7175
7177
|
|
|
7176
7178
|
The whole string must be query-encoded. */
|
|
7177
7179
|
whereUnit?: string;
|
|
7178
|
-
/** A Filter, by ID, over the Units to create entities from, with from_backing_units. */
|
|
7180
|
+
/** A Filter, by ID, over the Units to create entities from, with from_backing_units, or to create links between, with from_refs. */
|
|
7179
7181
|
filterUnit?: string;
|
|
7180
7182
|
/** With from_backing_units, patch a Link a selected Unit already backs with what the Unit holds that it has not taken yet, as a bulk patch with from_backing_units does, rather than report that the Unit backs it. The request body is applied after it. Without it, such a Unit is an error, or with allow_exists the Link is returned as it is. */
|
|
7181
7183
|
patchExisting?: boolean;
|
|
@@ -21054,6 +21056,7 @@ type ExtendedCommandRunRead = {
|
|
|
21054
21056
|
ViewColumns?: ViewColumn[];
|
|
21055
21057
|
};
|
|
21056
21058
|
type ExtendedComponent = {
|
|
21059
|
+
AllowedChangeWorkflows?: ChangeWorkflow[];
|
|
21057
21060
|
Component?: Component;
|
|
21058
21061
|
Error?: ResponseError;
|
|
21059
21062
|
Organization?: Organization;
|
|
@@ -21062,6 +21065,7 @@ type ExtendedComponent = {
|
|
|
21062
21065
|
ViewColumns?: ViewColumn[];
|
|
21063
21066
|
};
|
|
21064
21067
|
type ExtendedComponentRead = {
|
|
21068
|
+
AllowedChangeWorkflows?: ChangeWorkflowRead[];
|
|
21065
21069
|
Component?: ComponentRead;
|
|
21066
21070
|
Error?: ResponseError;
|
|
21067
21071
|
Organization?: OrganizationRead;
|
|
@@ -21343,6 +21347,8 @@ type FunctionSignature = {
|
|
|
21343
21347
|
Hermetic?: boolean;
|
|
21344
21348
|
/** Will return the same result if invoked again */
|
|
21345
21349
|
Idempotent?: boolean;
|
|
21350
|
+
/** Parts of the FunctionContext passed only to the functions that read them: Conflicts, the Unit's outstanding merge conflicts, and LinkFindings, what the resolves of its Links could not do */
|
|
21351
|
+
Include?: string[];
|
|
21346
21352
|
/** May change the configuration data */
|
|
21347
21353
|
Mutating?: boolean;
|
|
21348
21354
|
/** 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 '_'. */
|
|
@@ -21357,7 +21363,7 @@ type FunctionSignature = {
|
|
|
21357
21363
|
RequiredParameters?: number;
|
|
21358
21364
|
/** Toolchain under which the function is registered */
|
|
21359
21365
|
ToolchainType?: string;
|
|
21360
|
-
/** Returns ValidationResult */
|
|
21366
|
+
/** Returns a ValidationResult judging the resources selected, passing when none is selected unless it judges something it declares in Include */
|
|
21361
21367
|
Validating?: boolean;
|
|
21362
21368
|
/** Last parameter may be repeated */
|
|
21363
21369
|
VarArgs?: boolean;
|
|
@@ -21458,10 +21464,6 @@ type FunctionInvocationsRequest = {
|
|
|
21458
21464
|
ChangeDescription?: string;
|
|
21459
21465
|
ChannelID?: string;
|
|
21460
21466
|
FunctionInvocations?: FunctionInvocationList;
|
|
21461
|
-
/** Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them. A request that runs Triggers gets them regardless */
|
|
21462
|
-
IncludeConflicts?: boolean;
|
|
21463
|
-
/** Put what the resolves of the Unit's Links could not do in the FunctionContext, for functions that reason about it. A request that runs Triggers gets them regardless */
|
|
21464
|
-
IncludeLinkFindings?: boolean;
|
|
21465
21467
|
/** Invocations is a list of Invocation IDs to execute. The invocations must be within the same Organization. Invocations will be executed after the FunctionInvocations list. Functions are grouped by executor (built-in or Channel) and executed in phases: general mutating functions first, then final mutating functions (like ensure-context), then validating functions. Functions that don't match the unit's toolchain type are ignored. */
|
|
21466
21468
|
Invocations?: Uuid[];
|
|
21467
21469
|
/** NumFilters is the number of validating functions from the FunctionInvocations to treat as filters for the remaining functions in the list. In the case that the validation function does not pass, stop and don't execute the remaining functions, but don't report an error. */
|
package/dist/index.js
CHANGED
|
@@ -1266,6 +1266,7 @@ var injectedRtkApi = confighubApi.enhanceEndpoints({
|
|
|
1266
1266
|
filter_space: queryArg.filterSpace,
|
|
1267
1267
|
allow_exists: queryArg.allowExists,
|
|
1268
1268
|
include_hidden: queryArg.includeHidden,
|
|
1269
|
+
from_refs: queryArg.fromRefs,
|
|
1269
1270
|
with_backing_units: queryArg.withBackingUnits,
|
|
1270
1271
|
from_backing_units: queryArg.fromBackingUnits,
|
|
1271
1272
|
where_unit: queryArg.whereUnit,
|