@confighub/api 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.d.cts CHANGED
@@ -783,7 +783,7 @@ interface paths {
783
783
  put?: never;
784
784
  /**
785
785
  * Bulk create (copy) multiple links
786
- * @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters.
786
+ * @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters. With from_refs, create the NeedsProvides links the configuration of the Kubernetes/YAML units where_unit and filter_unit select calls for instead; with from_backing_units, create links from the ConfigHub/YAML units they select.
787
787
  */
788
788
  post: operations["BulkCreateLinks"];
789
789
  /**
@@ -5698,6 +5698,7 @@ interface components {
5698
5698
  ViewColumns?: components["schemas"]["ViewColumn"][];
5699
5699
  };
5700
5700
  ExtendedComponent: {
5701
+ AllowedChangeWorkflows?: components["schemas"]["ChangeWorkflow"][];
5701
5702
  Component?: components["schemas"]["Component"];
5702
5703
  Error?: components["schemas"]["ResponseError"];
5703
5704
  Organization?: components["schemas"]["Organization"];
@@ -6117,10 +6118,6 @@ interface components {
6117
6118
  */
6118
6119
  ChannelID?: string;
6119
6120
  FunctionInvocations?: components["schemas"]["FunctionInvocationList"];
6120
- /** @description Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them. A request that runs Triggers gets them regardless */
6121
- IncludeConflicts?: boolean;
6122
- /** @description 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 */
6123
- IncludeLinkFindings?: boolean;
6124
6121
  /** @description 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. */
6125
6122
  Invocations?: components["schemas"]["UUID"][];
6126
6123
  /** @description 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. */
@@ -6247,6 +6244,8 @@ interface components {
6247
6244
  Hermetic?: boolean;
6248
6245
  /** @description Will return the same result if invoked again */
6249
6246
  Idempotent?: boolean;
6247
+ /** @description 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 */
6248
+ Include?: string[];
6250
6249
  /** @description May change the configuration data */
6251
6250
  Mutating?: boolean;
6252
6251
  /** @description 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 '_'. */
@@ -6261,7 +6260,7 @@ interface components {
6261
6260
  RequiredParameters?: number;
6262
6261
  /** @description Toolchain under which the function is registered */
6263
6262
  ToolchainType?: string;
6264
- /** @description Returns ValidationResult */
6263
+ /** @description Returns a ValidationResult judging the resources selected, passing when none is selected unless it judges something it declares in Include */
6265
6264
  Validating?: boolean;
6266
6265
  /** @description Last parameter may be repeated */
6267
6266
  VarArgs?: boolean;
@@ -9758,7 +9757,7 @@ interface operations {
9758
9757
  * The attribute names are case-sensitive, PascalCase, and
9759
9758
  * expected in a comma-separated list format as in the JSON encoding.
9760
9759
  *
9761
- * Supported attributes for Component are OrganizationID, Permissions.
9760
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
9762
9761
  *
9763
9762
  * The whole string must be query-encoded.
9764
9763
  */
@@ -9960,7 +9959,7 @@ interface operations {
9960
9959
  * The attribute names are case-sensitive, PascalCase, and
9961
9960
  * expected in a comma-separated list format as in the JSON encoding.
9962
9961
  *
9963
- * Supported attributes for Component are OrganizationID, Permissions.
9962
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
9964
9963
  *
9965
9964
  * The whole string must be query-encoded.
9966
9965
  */
@@ -17894,7 +17893,7 @@ interface operations {
17894
17893
  * The attribute names are case-sensitive, PascalCase, and
17895
17894
  * expected in a comma-separated list format as in the JSON encoding.
17896
17895
  *
17897
- * Supported attributes for Component are OrganizationID, Permissions.
17896
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
17898
17897
  *
17899
17898
  * The whole string must be query-encoded.
17900
17899
  */
@@ -18140,7 +18139,7 @@ interface operations {
18140
18139
  * The attribute names are case-sensitive, PascalCase, and
18141
18140
  * expected in a comma-separated list format as in the JSON encoding.
18142
18141
  *
18143
- * Supported attributes for Component are OrganizationID, Permissions.
18142
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
18144
18143
  *
18145
18144
  * The whole string must be query-encoded.
18146
18145
  */
@@ -22651,6 +22650,8 @@ interface operations {
22651
22650
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
22652
22651
  */
22653
22652
  include_hidden?: string;
22653
+ /** @description 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. */
22654
+ from_refs?: boolean;
22654
22655
  /** @description 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. */
22655
22656
  with_backing_units?: boolean;
22656
22657
  /** @description 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. */
@@ -22692,12 +22693,12 @@ interface operations {
22692
22693
  *
22693
22694
  * 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.
22694
22695
  *
22695
- * The Units to create entities from, with from_backing_units.
22696
+ * The Units to create entities from, with from_backing_units, or to create links between, with from_refs.
22696
22697
  *
22697
22698
  * The whole string must be query-encoded.
22698
22699
  */
22699
22700
  where_unit?: string;
22700
- /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
22701
+ /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units, or to create links between, with from_refs. */
22701
22702
  filter_unit?: string;
22702
22703
  /** @description 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. */
22703
22704
  patch_existing?: boolean;
package/dist/index.d.ts CHANGED
@@ -783,7 +783,7 @@ interface paths {
783
783
  put?: never;
784
784
  /**
785
785
  * Bulk create (copy) multiple links
786
- * @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters.
786
+ * @description Copy existing links with retargeted From and/or To units. Select source links via where/filter, then retarget using reverse, from_downstream_where (optionally with to_downstream_where), or where_space/filter_space parameters. With from_refs, create the NeedsProvides links the configuration of the Kubernetes/YAML units where_unit and filter_unit select calls for instead; with from_backing_units, create links from the ConfigHub/YAML units they select.
787
787
  */
788
788
  post: operations["BulkCreateLinks"];
789
789
  /**
@@ -5698,6 +5698,7 @@ interface components {
5698
5698
  ViewColumns?: components["schemas"]["ViewColumn"][];
5699
5699
  };
5700
5700
  ExtendedComponent: {
5701
+ AllowedChangeWorkflows?: components["schemas"]["ChangeWorkflow"][];
5701
5702
  Component?: components["schemas"]["Component"];
5702
5703
  Error?: components["schemas"]["ResponseError"];
5703
5704
  Organization?: components["schemas"]["Organization"];
@@ -6117,10 +6118,6 @@ interface components {
6117
6118
  */
6118
6119
  ChannelID?: string;
6119
6120
  FunctionInvocations?: components["schemas"]["FunctionInvocationList"];
6120
- /** @description Put the Unit's outstanding merge conflicts in the FunctionContext, for functions that reason about them. A request that runs Triggers gets them regardless */
6121
- IncludeConflicts?: boolean;
6122
- /** @description 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 */
6123
- IncludeLinkFindings?: boolean;
6124
6121
  /** @description 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. */
6125
6122
  Invocations?: components["schemas"]["UUID"][];
6126
6123
  /** @description 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. */
@@ -6247,6 +6244,8 @@ interface components {
6247
6244
  Hermetic?: boolean;
6248
6245
  /** @description Will return the same result if invoked again */
6249
6246
  Idempotent?: boolean;
6247
+ /** @description 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 */
6248
+ Include?: string[];
6250
6249
  /** @description May change the configuration data */
6251
6250
  Mutating?: boolean;
6252
6251
  /** @description 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 '_'. */
@@ -6261,7 +6260,7 @@ interface components {
6261
6260
  RequiredParameters?: number;
6262
6261
  /** @description Toolchain under which the function is registered */
6263
6262
  ToolchainType?: string;
6264
- /** @description Returns ValidationResult */
6263
+ /** @description Returns a ValidationResult judging the resources selected, passing when none is selected unless it judges something it declares in Include */
6265
6264
  Validating?: boolean;
6266
6265
  /** @description Last parameter may be repeated */
6267
6266
  VarArgs?: boolean;
@@ -9758,7 +9757,7 @@ interface operations {
9758
9757
  * The attribute names are case-sensitive, PascalCase, and
9759
9758
  * expected in a comma-separated list format as in the JSON encoding.
9760
9759
  *
9761
- * Supported attributes for Component are OrganizationID, Permissions.
9760
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
9762
9761
  *
9763
9762
  * The whole string must be query-encoded.
9764
9763
  */
@@ -9960,7 +9959,7 @@ interface operations {
9960
9959
  * The attribute names are case-sensitive, PascalCase, and
9961
9960
  * expected in a comma-separated list format as in the JSON encoding.
9962
9961
  *
9963
- * Supported attributes for Component are OrganizationID, Permissions.
9962
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
9964
9963
  *
9965
9964
  * The whole string must be query-encoded.
9966
9965
  */
@@ -17894,7 +17893,7 @@ interface operations {
17894
17893
  * The attribute names are case-sensitive, PascalCase, and
17895
17894
  * expected in a comma-separated list format as in the JSON encoding.
17896
17895
  *
17897
- * Supported attributes for Component are OrganizationID, Permissions.
17896
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
17898
17897
  *
17899
17898
  * The whole string must be query-encoded.
17900
17899
  */
@@ -18140,7 +18139,7 @@ interface operations {
18140
18139
  * The attribute names are case-sensitive, PascalCase, and
18141
18140
  * expected in a comma-separated list format as in the JSON encoding.
18142
18141
  *
18143
- * Supported attributes for Component are OrganizationID, Permissions.
18142
+ * Supported attributes for Component are AllowedChangeWorkflowIDs, OrganizationID, Permissions.
18144
18143
  *
18145
18144
  * The whole string must be query-encoded.
18146
18145
  */
@@ -22651,6 +22650,8 @@ interface operations {
22651
22650
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
22652
22651
  */
22653
22652
  include_hidden?: string;
22653
+ /** @description 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. */
22654
+ from_refs?: boolean;
22654
22655
  /** @description 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. */
22655
22656
  with_backing_units?: boolean;
22656
22657
  /** @description 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. */
@@ -22692,12 +22693,12 @@ interface operations {
22692
22693
  *
22693
22694
  * 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.
22694
22695
  *
22695
- * The Units to create entities from, with from_backing_units.
22696
+ * The Units to create entities from, with from_backing_units, or to create links between, with from_refs.
22696
22697
  *
22697
22698
  * The whole string must be query-encoded.
22698
22699
  */
22699
22700
  where_unit?: string;
22700
- /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units. */
22701
+ /** @description A Filter, by ID, over the Units to create entities from, with from_backing_units, or to create links between, with from_refs. */
22701
22702
  filter_unit?: string;
22702
22703
  /** @description 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. */
22703
22704
  patch_existing?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.11.1",
3
+ "version": "0.11.3",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {