@confighub/api 0.10.8 → 0.10.9

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
@@ -4065,18 +4065,30 @@ interface components {
4065
4065
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4066
4066
  };
4067
4067
  BindingList: components["schemas"]["Binding"][];
4068
+ BlameConflictDismissal: {
4069
+ /** @description For a dismissal of what one guard withheld, the guard's key. */
4070
+ Guard?: string;
4071
+ /** @description The guard's value; empty for any value. */
4072
+ GuardValue?: string;
4073
+ /** @description Where the dismissal is recorded: a path, which may name any list element or map key with *, or empty for the resource as a whole. */
4074
+ Path?: string;
4075
+ /** @description The reason of the conflicts dismissed. */
4076
+ Reason?: string;
4077
+ };
4068
4078
  BlameField: {
4069
4079
  /** @description True for a field the unit does not have, listed because a conflict names it: a merge could not find the path, or the resource, to make an upstream change to. It has no value and no history. */
4070
4080
  Absent?: boolean;
4071
4081
  /** @description The changes that put the value here, from this unit out to where it was set, following each merge and Link resolve upstream. The last is the answer. */
4072
4082
  Chain?: components["schemas"]["BlameOrigin"][];
4083
+ /** @description The conflict dismissals recorded for this row: at the field's path or by a pattern naming it, or, on the row about a resource as a whole, on the resource. The unit's path report lists every dismissal covering the field, its resource's included. */
4084
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
4073
4085
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4086
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
4087
  /** @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
4088
  Deleted?: boolean;
4077
4089
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4078
4090
  Findings?: components["schemas"]["LinkFinding"][];
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. */
4091
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4080
4092
  Flags?: string[];
4081
4093
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4082
4094
  Guards?: {
@@ -4324,7 +4336,7 @@ interface components {
4324
4336
  readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
4325
4337
  /**
4326
4338
  * Format: uuid
4327
- * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key.
4339
+ * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key. Every Space the ChangeOrder is headed for has to be selected by one of the workflow's Stages, since a Space in none of them cannot be promoted into; the ChangeOrder's own Space is exempt when the change is already there, as it is for UpgradeUnit and MergeUnits. Creating a ChangeOrder, or an update adding a Space to InScopeSpaceIDs, is refused otherwise.
4328
4340
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4329
4341
  */
4330
4342
  ChangeWorkflowID?: string;
@@ -7432,13 +7444,13 @@ interface components {
7432
7444
  ToValue?: string;
7433
7445
  };
7434
7446
  ResourceGuards: {
7435
- /** @description Guard keys to remove, by path. Removing a key that is not there is not an error */
7447
+ /** @description Guard keys to remove, by path, named as in Set; * also matches the paths guarded that the data no longer has. Removing a key that is not there is not an error */
7436
7448
  Remove?: {
7437
7449
  [key: string]: string[];
7438
7450
  };
7439
- /** @description Identifies the resource within the Unit whose guards are being edited */
7451
+ /** @description The resource whose guards are being edited: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional. A resource the unit does not have yet is named by ResourceType and ResourceName. */
7440
7452
  Resource?: components["schemas"]["ResourceInfo"];
7441
- /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole */
7453
+ /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole. A list element is named by merge key or by position, and * stands for every element or key there is; a path that does not exist yet is kept as written */
7442
7454
  Set?: {
7443
7455
  [key: string]: {
7444
7456
  [key: string]: string;
@@ -7507,11 +7519,11 @@ interface components {
7507
7519
  ResourceAnnotations?: components["schemas"]["PathAnnotations"];
7508
7520
  };
7509
7521
  ResourceProtection: {
7510
- /** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7522
+ /** @description Map of path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. A list element is named by merge key or by position, and * stands for every element or key there is; a path naming a field the unit deleted is set on the record of that deletion. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7511
7523
  Protected?: {
7512
7524
  [key: string]: boolean;
7513
7525
  } | null;
7514
- /** @description Identifies the resource within the unit whose protection is being set */
7526
+ /** @description The resource whose protection is being set: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional */
7515
7527
  Resource?: components["schemas"]["ResourceInfo"];
7516
7528
  };
7517
7529
  ResourceTypePathsEntry: {
@@ -8701,7 +8713,7 @@ interface components {
8701
8713
  UnitConflictSelector: {
8702
8714
  /** @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
8715
  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). */
8716
+ /** @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). With Undismiss, the path names dismissals as Permanent recorded them: empty, the one on the resource as a whole; *, every one; a path, the one recorded at that path, a pattern included. */
8705
8717
  Path?: string;
8706
8718
  /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8707
8719
  Reason?: string;
@@ -8955,7 +8967,7 @@ interface components {
8955
8967
  UnitID?: string;
8956
8968
  };
8957
8969
  UnitPathReport: {
8958
- /** @description The path's own annotations other than guards, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8970
+ /** @description The path's own annotations other than guards and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8959
8971
  Annotations?: {
8960
8972
  [key: string]: {
8961
8973
  [key: string]: string;
@@ -8963,6 +8975,8 @@ interface components {
8963
8975
  };
8964
8976
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
8965
8977
  Changes?: components["schemas"]["BlamePathChange"][];
8978
+ /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
8979
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
8966
8980
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
8967
8981
  Field?: components["schemas"]["BlameField"];
8968
8982
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
@@ -42662,7 +42676,7 @@ interface operations {
42662
42676
  /**
42663
42677
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42664
42678
  *
42665
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42679
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42666
42680
  */
42667
42681
  flags?: string;
42668
42682
  /** @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. */
@@ -51867,7 +51881,7 @@ interface operations {
51867
51881
  /**
51868
51882
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51869
51883
  *
51870
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51884
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51871
51885
  */
51872
51886
  flags?: string;
51873
51887
  /** @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
@@ -4065,18 +4065,30 @@ interface components {
4065
4065
  ProvidedResource?: components["schemas"]["ResourceInfo"];
4066
4066
  };
4067
4067
  BindingList: components["schemas"]["Binding"][];
4068
+ BlameConflictDismissal: {
4069
+ /** @description For a dismissal of what one guard withheld, the guard's key. */
4070
+ Guard?: string;
4071
+ /** @description The guard's value; empty for any value. */
4072
+ GuardValue?: string;
4073
+ /** @description Where the dismissal is recorded: a path, which may name any list element or map key with *, or empty for the resource as a whole. */
4074
+ Path?: string;
4075
+ /** @description The reason of the conflicts dismissed. */
4076
+ Reason?: string;
4077
+ };
4068
4078
  BlameField: {
4069
4079
  /** @description True for a field the unit does not have, listed because a conflict names it: a merge could not find the path, or the resource, to make an upstream change to. It has no value and no history. */
4070
4080
  Absent?: boolean;
4071
4081
  /** @description The changes that put the value here, from this unit out to where it was set, following each merge and Link resolve upstream. The last is the answer. */
4072
4082
  Chain?: components["schemas"]["BlameOrigin"][];
4083
+ /** @description The conflict dismissals recorded for this row: at the field's path or by a pattern naming it, or, on the row about a resource as a whole, on the resource. The unit's path report lists every dismissal covering the field, its resource's included. */
4084
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
4073
4085
  /** @description The unit's outstanding conflicts about the field: upstream changes to it a merge or resolve dropped. */
4074
4086
  Conflicts?: components["schemas"]["MutationConflict"][];
4075
4087
  /** @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
4088
  Deleted?: boolean;
4077
4089
  /** @description The unit's Link findings about the field: what a Link's resolve could not do here. */
4078
4090
  Findings?: components["schemas"]["LinkFinding"][];
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. */
4091
+ /** @description What there is to know about the field, one code each: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed and Provided. */
4080
4092
  Flags?: string[];
4081
4093
  /** @description The guards on the field: its own, its ancestors' and its resource's, which an operation writing here has to be cleared for. */
4082
4094
  Guards?: {
@@ -4324,7 +4336,7 @@ interface components {
4324
4336
  readonly ChangeWorkflow?: components["schemas"]["ChangeWorkflowSpec"];
4325
4337
  /**
4326
4338
  * Format: uuid
4327
- * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key.
4339
+ * @description ChangeWorkflowID is the ChangeWorkflow this ChangeOrder is promoted under. It says which workflow the stored copy was taken from, and keeps saying so after that workflow has been edited or deleted, which is why it is not a foreign key. Every Space the ChangeOrder is headed for has to be selected by one of the workflow's Stages, since a Space in none of them cannot be promoted into; the ChangeOrder's own Space is exempt when the change is already there, as it is for UpgradeUnit and MergeUnits. Creating a ChangeOrder, or an update adding a Space to InScopeSpaceIDs, is refused otherwise.
4328
4340
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4329
4341
  */
4330
4342
  ChangeWorkflowID?: string;
@@ -7432,13 +7444,13 @@ interface components {
7432
7444
  ToValue?: string;
7433
7445
  };
7434
7446
  ResourceGuards: {
7435
- /** @description Guard keys to remove, by path. Removing a key that is not there is not an error */
7447
+ /** @description Guard keys to remove, by path, named as in Set; * also matches the paths guarded that the data no longer has. Removing a key that is not there is not an error */
7436
7448
  Remove?: {
7437
7449
  [key: string]: string[];
7438
7450
  };
7439
- /** @description Identifies the resource within the Unit whose guards are being edited */
7451
+ /** @description The resource whose guards are being edited: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional. A resource the unit does not have yet is named by ResourceType and ResourceName. */
7440
7452
  Resource?: components["schemas"]["ResourceInfo"];
7441
- /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole */
7453
+ /** @description Guard key/value pairs to add or overwrite, by path. The empty path addresses the resource as a whole. A list element is named by merge key or by position, and * stands for every element or key there is; a path that does not exist yet is kept as written */
7442
7454
  Set?: {
7443
7455
  [key: string]: {
7444
7456
  [key: string]: string;
@@ -7507,11 +7519,11 @@ interface components {
7507
7519
  ResourceAnnotations?: components["schemas"]["PathAnnotations"];
7508
7520
  };
7509
7521
  ResourceProtection: {
7510
- /** @description Map of resolved path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7522
+ /** @description Map of path to its new Protected value: true = a local override a merge must not overwrite, false = the merge's to update. A list element is named by merge key or by position, and * stands for every element or key there is; a path naming a field the unit deleted is set on the record of that deletion. The empty path addresses the resource as a whole: a merge withholds every change to a resource protected as a whole, including its deletion and replacement, whatever its paths' values are */
7511
7523
  Protected?: {
7512
7524
  [key: string]: boolean;
7513
7525
  } | null;
7514
- /** @description Identifies the resource within the unit whose protection is being set */
7526
+ /** @description The resource whose protection is being set: ResourceName, its whole name (namespace/name) or a name it had before a rename, or ResourceNameWithoutScope, a name without its namespace that has to match one resource; ResourceType, in any API version, is optional */
7515
7527
  Resource?: components["schemas"]["ResourceInfo"];
7516
7528
  };
7517
7529
  ResourceTypePathsEntry: {
@@ -8701,7 +8713,7 @@ interface components {
8701
8713
  UnitConflictSelector: {
8702
8714
  /** @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
8715
  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). */
8716
+ /** @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). With Undismiss, the path names dismissals as Permanent recorded them: empty, the one on the resource as a whole; *, every one; a path, the one recorded at that path, a pattern included. */
8705
8717
  Path?: string;
8706
8718
  /** @description Match conflicts dropped for this reason, as their Reason names it; empty matches any reason */
8707
8719
  Reason?: string;
@@ -8955,7 +8967,7 @@ interface components {
8955
8967
  UnitID?: string;
8956
8968
  };
8957
8969
  UnitPathReport: {
8958
- /** @description The path's own annotations other than guards, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8970
+ /** @description The path's own annotations other than guards and conflict dismissals, by kind. The field's Guards are those that apply to it, its ancestors' and its resource's included. */
8959
8971
  Annotations?: {
8960
8972
  [key: string]: {
8961
8973
  [key: string]: string;
@@ -8963,6 +8975,8 @@ interface components {
8963
8975
  };
8964
8976
  /** @description The field's chain: the changes that put the value here, from this unit out to where it was set, each with the Mutation and Revision it was read from. */
8965
8977
  Changes?: components["schemas"]["BlamePathChange"][];
8978
+ /** @description Every conflict dismissal covering the field, each with the Path it is recorded at: the field's, a pattern naming it, or empty for one on its resource as a whole. */
8979
+ ConflictDismissals?: components["schemas"]["BlameConflictDismissal"][];
8966
8980
  /** @description The field, as the unit's blame reports it, without its Chain: Changes carries the chain with its records. */
8967
8981
  Field?: components["schemas"]["BlameField"];
8968
8982
  /** @description Every change this unit recorded to the field, oldest first; returned when history is requested. */
@@ -42662,7 +42676,7 @@ interface operations {
42662
42676
  /**
42663
42677
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
42664
42678
  *
42665
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42679
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
42666
42680
  */
42667
42681
  flags?: string;
42668
42682
  /** @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. */
@@ -51867,7 +51881,7 @@ interface operations {
51867
51881
  /**
51868
51882
  * @description Only the fields with at least one of these flags, comma-separated. Conflict,Absent,Finding,ValidationError,ValidationWarning selects the fields that need attention.
51869
51883
  *
51870
- * Supported values: Protected, Guarded, Conflict, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51884
+ * Supported values: Protected, Guarded, Conflict, ConflictDismissed, Absent, Deleted, Finding, ValidationError, ValidationWarning, Upgraded, SetByLink, SetByTrigger, ChangeOrder, Unreleased, Needed, Provided.
51871
51885
  */
51872
51886
  flags?: string;
51873
51887
  /** @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.8",
3
+ "version": "0.10.9",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {