@confighub/api 0.10.6 → 0.10.8

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
@@ -4072,9 +4072,11 @@ interface components {
4072
4072
  Chain?: components["schemas"]["BlameOrigin"][];
4073
4073
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4074
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
+ /** @description True for a field, or a resource, that the unit does not have because a change deleted it: the unit's record still names the deletion. It has no value; its chain is the change that deleted it, and Protected says whether a merge from upstream leaves it deleted. */
4076
+ Deleted?: boolean;
4075
4077
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4076
4078
  Findings?: components["schemas"]["LinkFinding"][];
4077
- /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4079
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4078
4080
  Flags?: string[];
4079
4081
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4080
4082
  Guards?: {
@@ -4082,9 +4084,9 @@ interface components {
4082
4084
  };
4083
4085
  /** @description The unit's needed paths that are the field: a value it is to take from an upstream unit through a NeedsProvides Link. */
4084
4086
  Needed?: components["schemas"]["BlameNeededPath"][];
4085
- /** @description The field's path, in the syntax functions and Links take. */
4087
+ /** @description The field's path, in the syntax functions and Links take. Empty on the row about the resource as a whole, which comes first among the resource's fields and carries what is recorded about the resource rather than one of its fields: the change that added or deleted it, whether it is protected as a whole, its guards, and its conflicts, findings and failed checks that name no path. */
4086
4088
  Path?: string;
4087
- /** @description True for a local override, which a merge from upstream leaves alone. */
4089
+ /** @description True for a local override, which a merge from upstream leaves alone. On the row about a resource as a whole, true when the resource is protected as a whole. */
4088
4090
  Protected?: boolean;
4089
4091
  /** @description The unit's provided paths that are the field: a value it offers downstream units through NeedsProvides Links. */
4090
4092
  Provided?: components["schemas"]["AttributeInfo"][];
@@ -4094,7 +4096,7 @@ interface components {
4094
4096
  ResourceName?: string;
4095
4097
  /** @description The name of the resource without its scope, such as its namespace, which is how a resource a variant renamed is matched. */
4096
4098
  ResourceNameWithoutScope?: string;
4097
- /** @description True when the field is protected because its resource is protected as a whole. */
4099
+ /** @description True when the field is protected because its resource is protected as a whole, and on the row about that resource. */
4098
4100
  ResourceProtected?: boolean;
4099
4101
  /** @description The type of the resource the field is in. */
4100
4102
  ResourceType?: string;
@@ -6714,6 +6716,8 @@ interface components {
6714
6716
  Guard?: components["schemas"]["WithheldGuard"];
6715
6717
  /** @description For GuardWithheld: the guard change that did not propagate */
6716
6718
  GuardChange?: components["schemas"]["GuardDelta"];
6719
+ /** @description For Guarded and GuardWithheld: every guard the operation's clearance did not cover, those it forbade with DoesNotExist first and then in key order. Guard is the first of them. */
6720
+ Guards?: components["schemas"]["WithheldGuard"][];
6717
6721
  /** @description Path of the mutation; empty for resource-level conflicts */
6718
6722
  Path?: string;
6719
6723
  /** @description Why the mutation was dropped */
@@ -8695,21 +8699,27 @@ interface components {
8695
8699
  UnitID?: string;
8696
8700
  };
8697
8701
  UnitConflictSelector: {
8698
- /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts */
8702
+ /** @description Match Guarded and GuardWithheld conflicts every one of whose guards is named here, as key or key=value; empty matches any conflict, guarded or not */
8703
+ Guards?: string[];
8704
+ /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). */
8699
8705
  Path?: string;
8700
- /** @description Match conflicts dropped for this reason: Subtracted, DeleteShadowed, ProtectedPath, or UnresolvedPath; empty matches any reason */
8706
+ /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8701
8707
  Reason?: string;
8702
- /** @description Match conflicts on this resource; empty matches any resource */
8708
+ /** @description Match conflicts on this resource, by its whole name (namespace/name, or /name for a cluster-scoped Kubernetes resource) or a name it had before a rename; empty matches any resource */
8703
8709
  ResourceName?: string;
8710
+ /** @description Match conflicts on every resource with this name without its namespace, now or before a rename; empty matches any. With Permanent or Undismiss it has to match only one resource. */
8711
+ ResourceNameWithoutScope?: string;
8704
8712
  /** @description Match conflicts on resources of this type, in any API version; empty matches any type. With ResourceName, it picks out one of several resources of that name. */
8705
8713
  ResourceType?: string;
8706
8714
  };
8707
8715
  UnitConflictsRequest: {
8708
- /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data */
8716
+ /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */
8709
8717
  Action?: string;
8710
8718
  /** @description Report what the request would do without writing anything. The response carries the Unit as it would be. */
8711
8719
  DryRun?: boolean;
8712
- /** @description Which outstanding conflicts to act on. Empty acts on all of them. */
8720
+ /** @description With Dismiss, also dismiss the conflicts each selector matches whenever a later merge reports them. Each selector names one resource, by ResourceName or ResourceNameWithoutScope, and a Reason, and Guards for a guard-caused reason; an empty Path covers every path of the resource. */
8721
+ Permanent?: boolean;
8722
+ /** @description Which outstanding conflicts to act on. Empty acts on all of them. Permanent and Undismiss need at least one, each naming a ResourceName or ResourceNameWithoutScope, and for Permanent a Reason. */
8713
8723
  Select?: components["schemas"]["UnitConflictSelector"][];
8714
8724
  };
8715
8725
  UnitConflictsResponse: {
@@ -8722,6 +8732,10 @@ interface components {
8722
8732
  /** @description Number of conflicts dropped without changing the configuration data */
8723
8733
  Dismissed?: number;
8724
8734
  Error?: components["schemas"]["ResponseError"];
8735
+ /** @description Number of permanent dismissals recorded, each a reason (or a reason and a guard) at one path of one resource */
8736
+ Recorded?: number;
8737
+ /** @description Number of permanent dismissals removed by Undismiss */
8738
+ Removed?: number;
8725
8739
  /** @description The Unit as the request left it, or would have left it for a dry run */
8726
8740
  Unit?: components["schemas"]["Unit"];
8727
8741
  };
@@ -8883,6 +8897,8 @@ interface components {
8883
8897
  Version?: number;
8884
8898
  };
8885
8899
  UnitGuardRequest: {
8900
+ /** @description Recorded on the Revision the edit creates. Defaults to "Set path guards". */
8901
+ ChangeDescription?: string;
8886
8902
  /** @description The classes of reason this edit is cleared for; required to edit a path that already carries guards */
8887
8903
  Clearance?: components["schemas"]["Clearance"];
8888
8904
  /** @description Per-resource guard edits to apply to the Unit's PathAnnotations */
@@ -8961,6 +8977,8 @@ interface components {
8961
8977
  ReleaseState?: string;
8962
8978
  };
8963
8979
  UnitProtectionRequest: {
8980
+ /** @description Recorded on the Revision the edit creates. Defaults to "Set path protection". */
8981
+ ChangeDescription?: string;
8964
8982
  /** @description Per-resource Protected edits to apply to the Unit's MutationSources */
8965
8983
  ResourceProtection?: components["schemas"]["ResourceProtection"][] | null;
8966
8984
  /** @description Clear every Protected value on the Unit's MutationSources before applying ResourceProtection */
@@ -42644,7 +42662,7 @@ interface operations {
42644
42662
  /**
42645
42663
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42646
42664
  *
42647
- * Supported values: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42665
+ * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42648
42666
  */
42649
42667
  flags?: string;
42650
42668
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
@@ -51849,7 +51867,7 @@ interface operations {
51849
51867
  /**
51850
51868
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51851
51869
  *
51852
- * Supported values: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51870
+ * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51853
51871
  */
51854
51872
  flags?: string;
51855
51873
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
package/dist/index.d.ts CHANGED
@@ -4072,9 +4072,11 @@ interface components {
4072
4072
  Chain?: components["schemas"]["BlameOrigin"][];
4073
4073
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4074
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
+ /** @description True for a field, or a resource, that the unit does not have because a change deleted it: the unit's record still names the deletion. It has no value; its chain is the change that deleted it, and Protected says whether a merge from upstream leaves it deleted. */
4076
+ Deleted?: boolean;
4075
4077
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4076
4078
  Findings?: components["schemas"]["LinkFinding"][];
4077
- /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4079
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4078
4080
  Flags?: string[];
4079
4081
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4080
4082
  Guards?: {
@@ -4082,9 +4084,9 @@ interface components {
4082
4084
  };
4083
4085
  /** @description The unit's needed paths that are the field: a value it is to take from an upstream unit through a NeedsProvides Link. */
4084
4086
  Needed?: components["schemas"]["BlameNeededPath"][];
4085
- /** @description The field's path, in the syntax functions and Links take. */
4087
+ /** @description The field's path, in the syntax functions and Links take. Empty on the row about the resource as a whole, which comes first among the resource's fields and carries what is recorded about the resource rather than one of its fields: the change that added or deleted it, whether it is protected as a whole, its guards, and its conflicts, findings and failed checks that name no path. */
4086
4088
  Path?: string;
4087
- /** @description True for a local override, which a merge from upstream leaves alone. */
4089
+ /** @description True for a local override, which a merge from upstream leaves alone. On the row about a resource as a whole, true when the resource is protected as a whole. */
4088
4090
  Protected?: boolean;
4089
4091
  /** @description The unit's provided paths that are the field: a value it offers downstream units through NeedsProvides Links. */
4090
4092
  Provided?: components["schemas"]["AttributeInfo"][];
@@ -4094,7 +4096,7 @@ interface components {
4094
4096
  ResourceName?: string;
4095
4097
  /** @description The name of the resource without its scope, such as its namespace, which is how a resource a variant renamed is matched. */
4096
4098
  ResourceNameWithoutScope?: string;
4097
- /** @description True when the field is protected because its resource is protected as a whole. */
4099
+ /** @description True when the field is protected because its resource is protected as a whole, and on the row about that resource. */
4098
4100
  ResourceProtected?: boolean;
4099
4101
  /** @description The type of the resource the field is in. */
4100
4102
  ResourceType?: string;
@@ -6714,6 +6716,8 @@ interface components {
6714
6716
  Guard?: components["schemas"]["WithheldGuard"];
6715
6717
  /** @description For GuardWithheld: the guard change that did not propagate */
6716
6718
  GuardChange?: components["schemas"]["GuardDelta"];
6719
+ /** @description For Guarded and GuardWithheld: every guard the operation's clearance did not cover, those it forbade with DoesNotExist first and then in key order. Guard is the first of them. */
6720
+ Guards?: components["schemas"]["WithheldGuard"][];
6717
6721
  /** @description Path of the mutation; empty for resource-level conflicts */
6718
6722
  Path?: string;
6719
6723
  /** @description Why the mutation was dropped */
@@ -8695,21 +8699,27 @@ interface components {
8695
8699
  UnitID?: string;
8696
8700
  };
8697
8701
  UnitConflictSelector: {
8698
- /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts */
8702
+ /** @description Match Guarded and GuardWithheld conflicts every one of whose guards is named here, as key or key=value; empty matches any conflict, guarded or not */
8703
+ Guards?: string[];
8704
+ /** @description Match conflicts at this path; empty matches any path, including resource-level conflicts. An element of a list may be named by position (spec.data.0.secretKey), by merge key (containers.?name=main.image), or as the conflict records it, and * matches any one list element or map key (spec.data.*.secretKey). */
8699
8705
  Path?: string;
8700
- /** @description Match conflicts dropped for this reason: Subtracted, DeleteShadowed, ProtectedPath, or UnresolvedPath; empty matches any reason */
8706
+ /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8701
8707
  Reason?: string;
8702
- /** @description Match conflicts on this resource; empty matches any resource */
8708
+ /** @description Match conflicts on this resource, by its whole name (namespace/name, or /name for a cluster-scoped Kubernetes resource) or a name it had before a rename; empty matches any resource */
8703
8709
  ResourceName?: string;
8710
+ /** @description Match conflicts on every resource with this name without its namespace, now or before a rename; empty matches any. With Permanent or Undismiss it has to match only one resource. */
8711
+ ResourceNameWithoutScope?: string;
8704
8712
  /** @description Match conflicts on resources of this type, in any API version; empty matches any type. With ResourceName, it picks out one of several resources of that name. */
8705
8713
  ResourceType?: string;
8706
8714
  };
8707
8715
  UnitConflictsRequest: {
8708
- /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data */
8716
+ /** @description Apply re-applies the withheld change; Dismiss drops the conflict without changing the configuration data; Undismiss removes dismissals recorded with Permanent */
8709
8717
  Action?: string;
8710
8718
  /** @description Report what the request would do without writing anything. The response carries the Unit as it would be. */
8711
8719
  DryRun?: boolean;
8712
- /** @description Which outstanding conflicts to act on. Empty acts on all of them. */
8720
+ /** @description With Dismiss, also dismiss the conflicts each selector matches whenever a later merge reports them. Each selector names one resource, by ResourceName or ResourceNameWithoutScope, and a Reason, and Guards for a guard-caused reason; an empty Path covers every path of the resource. */
8721
+ Permanent?: boolean;
8722
+ /** @description Which outstanding conflicts to act on. Empty acts on all of them. Permanent and Undismiss need at least one, each naming a ResourceName or ResourceNameWithoutScope, and for Permanent a Reason. */
8713
8723
  Select?: components["schemas"]["UnitConflictSelector"][];
8714
8724
  };
8715
8725
  UnitConflictsResponse: {
@@ -8722,6 +8732,10 @@ interface components {
8722
8732
  /** @description Number of conflicts dropped without changing the configuration data */
8723
8733
  Dismissed?: number;
8724
8734
  Error?: components["schemas"]["ResponseError"];
8735
+ /** @description Number of permanent dismissals recorded, each a reason (or a reason and a guard) at one path of one resource */
8736
+ Recorded?: number;
8737
+ /** @description Number of permanent dismissals removed by Undismiss */
8738
+ Removed?: number;
8725
8739
  /** @description The Unit as the request left it, or would have left it for a dry run */
8726
8740
  Unit?: components["schemas"]["Unit"];
8727
8741
  };
@@ -8883,6 +8897,8 @@ interface components {
8883
8897
  Version?: number;
8884
8898
  };
8885
8899
  UnitGuardRequest: {
8900
+ /** @description Recorded on the Revision the edit creates. Defaults to "Set path guards". */
8901
+ ChangeDescription?: string;
8886
8902
  /** @description The classes of reason this edit is cleared for; required to edit a path that already carries guards */
8887
8903
  Clearance?: components["schemas"]["Clearance"];
8888
8904
  /** @description Per-resource guard edits to apply to the Unit's PathAnnotations */
@@ -8961,6 +8977,8 @@ interface components {
8961
8977
  ReleaseState?: string;
8962
8978
  };
8963
8979
  UnitProtectionRequest: {
8980
+ /** @description Recorded on the Revision the edit creates. Defaults to "Set path protection". */
8981
+ ChangeDescription?: string;
8964
8982
  /** @description Per-resource Protected edits to apply to the Unit's MutationSources */
8965
8983
  ResourceProtection?: components["schemas"]["ResourceProtection"][] | null;
8966
8984
  /** @description Clear every Protected value on the Unit's MutationSources before applying ResourceProtection */
@@ -42644,7 +42662,7 @@ interface operations {
42644
42662
  /**
42645
42663
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42646
42664
  *
42647
- * Supported values: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42665
+ * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42648
42666
  */
42649
42667
  flags?: string;
42650
42668
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
@@ -51849,7 +51867,7 @@ interface operations {
51849
51867
  /**
51850
51868
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51851
51869
  *
51852
- * Supported values: Protected, Guarded, Conflict, Absent, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51870
+ * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51853
51871
  */
51854
51872
  flags?: string;
51855
51873
  /** @description Follow each merge and Link resolve into the unit it took the value from, to where the value was set. Default true; false reports each unit's own record, which names the upstream unit without reading it. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.10.6",
3
+ "version": "0.10.8",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {