@confighub/api 0.8.23 → 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.d.cts CHANGED
@@ -1061,7 +1061,7 @@ interface paths {
1061
1061
  };
1062
1062
  /**
1063
1063
  * List of Releases across spaces
1064
- * @description Retrieves a list of Releases across spaces in the Organization
1064
+ * @description Retrieves a list of Releases across spaces in the Organization. By default, returns at most one Release per space: the highest-numbered one that matches. Set `distinct_on=Off` to receive every matching Release instead -- paginate with `limit` and the continue token to walk the full result set (`distinct_on=Off` requires an explicit `limit` and a non-empty `where` or `filter`, since without deduplication or a filter there is nothing bounding the result set)
1065
1065
  */
1066
1066
  get: operations["ListAllReleases"];
1067
1067
  put?: never;
@@ -6876,10 +6876,14 @@ interface components {
6876
6876
  PathChange: {
6877
6877
  /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
6878
6878
  Attribution?: components["schemas"]["MutationInfo"];
6879
- /** @description Add, Delete, Update, Replace, Reorder, or Rename */
6879
+ /** @description Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */
6880
6880
  ChangeType?: string;
6881
+ /** @description 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 */
6882
+ Comment?: string;
6881
6883
  /** @description The path in configuration path syntax, as --path arguments and where filters take it, with each unkeyed array element named by its index */
6882
6884
  DisplayPath?: string;
6885
+ /** @description 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 */
6886
+ FromDataType?: string;
6883
6887
  /** @description The value on the From side: a scalar's text, or a YAML block for a map or array */
6884
6888
  FromValue?: string;
6885
6889
  /** @description A unified line diff, for multi-line string values */
@@ -6888,7 +6892,9 @@ interface components {
6888
6892
  Path?: string;
6889
6893
  /** @description The path split into its segments, for rendering without parsing the path syntax */
6890
6894
  Segments?: components["schemas"]["PathSegment"][] | null;
6891
- /** @description The value on the To side: a scalar's text, or a YAML block for a map or array */
6895
+ /** @description 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 */
6896
+ ToDataType?: string;
6897
+ /** @description 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 */
6892
6898
  ToValue?: string;
6893
6899
  };
6894
6900
  PathExpression: {
@@ -6911,11 +6917,11 @@ interface components {
6911
6917
  /** @description The map key, for a map segment */
6912
6918
  Field?: string;
6913
6919
  /** @description The element's index on the From side; -1 for a map key or an element absent there */
6914
- FromIndex?: number;
6920
+ FromIndex: number;
6915
6921
  /** @description The merge keys that identify the element, for an element of a merge-keyed array */
6916
6922
  MergeKeys?: components["schemas"]["MergeKeyValue"][];
6917
6923
  /** @description The element's index on the To side; -1 for a map key or an element absent there */
6918
- ToIndex?: number;
6924
+ ToIndex: number;
6919
6925
  };
6920
6926
  PathToVisitorInfoType: {
6921
6927
  [key: string]: components["schemas"]["PathVisitorInfo"];
@@ -18710,7 +18716,11 @@ interface operations {
18710
18716
  query?: {
18711
18717
  /** @description Plan the demotion and return the same response without writing anything. */
18712
18718
  dry_run?: boolean;
18713
- /** @description 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. */
18719
+ /**
18720
+ * @description 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.
18721
+ *
18722
+ * Supported values: Mutations, Diff.
18723
+ */
18714
18724
  include?: string;
18715
18725
  };
18716
18726
  header?: never;
@@ -18818,7 +18828,11 @@ interface operations {
18818
18828
  DiffConfigurations: {
18819
18829
  parameters: {
18820
18830
  query?: {
18821
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
18831
+ /**
18832
+ * @description 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.
18833
+ *
18834
+ * Supported values: Attribution, Unchanged, Context.
18835
+ */
18822
18836
  include?: string;
18823
18837
  /** @description Limit the diff to the resources this where expression selects on either side. */
18824
18838
  where_resource?: string;
@@ -20308,7 +20322,11 @@ interface operations {
20308
20322
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
20309
20323
  */
20310
20324
  include_hidden?: string;
20311
- /** @description 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. */
20325
+ /**
20326
+ * @description 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.
20327
+ *
20328
+ * Supported values: ConfigData, Diff.
20329
+ */
20312
20330
  include?: string;
20313
20331
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
20314
20332
  resource_type?: string;
@@ -24636,7 +24654,11 @@ interface operations {
24636
24654
  * @description 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.
24637
24655
  */
24638
24656
  dry_run?: boolean;
24639
- /** @description 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. */
24657
+ /**
24658
+ * @description 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.
24659
+ *
24660
+ * Supported values: Mutations, Diff, ConfigData.
24661
+ */
24640
24662
  include?: string;
24641
24663
  };
24642
24664
  header?: never;
@@ -24871,6 +24893,16 @@ interface operations {
24871
24893
  * 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.
24872
24894
  */
24873
24895
  continue?: string;
24896
+ /**
24897
+ * @description Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
24898
+ *
24899
+ * Supported values: Space, Off.
24900
+ *
24901
+ * If not specified, results are restricted to at most one row per Space.
24902
+ *
24903
+ * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
24904
+ */
24905
+ distinct_on?: PathsReleaseGetParametersQueryDistinct_on;
24874
24906
  };
24875
24907
  header?: never;
24876
24908
  path?: never;
@@ -35943,7 +35975,11 @@ interface operations {
35943
35975
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
35944
35976
  */
35945
35977
  include_hidden?: string;
35946
- /** @description 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. */
35978
+ /**
35979
+ * @description 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.
35980
+ *
35981
+ * Supported values: ConfigData, Diff.
35982
+ */
35947
35983
  include?: string;
35948
35984
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
35949
35985
  resource_type?: string;
@@ -41638,7 +41674,11 @@ interface operations {
41638
41674
  merge_external_source?: string;
41639
41675
  /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
41640
41676
  allow_exists?: string;
41641
- /** @description 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. */
41677
+ /**
41678
+ * @description 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.
41679
+ *
41680
+ * Supported values: ConfigData, MutationSources, Diff.
41681
+ */
41642
41682
  include?: string;
41643
41683
  /** @description 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. */
41644
41684
  dry_run?: boolean;
@@ -41937,7 +41977,11 @@ interface operations {
41937
41977
  prior_revisions?: string;
41938
41978
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
41939
41979
  subgroup?: string;
41940
- /** @description 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. */
41980
+ /**
41981
+ * @description 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.
41982
+ *
41983
+ * Supported values: ConfigData, MutationSources, Diff.
41984
+ */
41941
41985
  include?: string;
41942
41986
  };
41943
41987
  header?: never;
@@ -42244,7 +42288,11 @@ interface operations {
42244
42288
  prior_revisions?: string;
42245
42289
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
42246
42290
  subgroup?: string;
42247
- /** @description 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. */
42291
+ /**
42292
+ * @description 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.
42293
+ *
42294
+ * Supported values: ConfigData, MutationSources, Diff.
42295
+ */
42248
42296
  include?: string;
42249
42297
  };
42250
42298
  header?: never;
@@ -42564,7 +42612,11 @@ interface operations {
42564
42612
  query?: {
42565
42613
  /** @description Human-readable description of this change, copied to the Revision it creates. */
42566
42614
  last_change_description?: string;
42567
- /** @description 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. */
42615
+ /**
42616
+ * @description 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.
42617
+ *
42618
+ * Supported values: ConfigData, MutationSources, Diff.
42619
+ */
42568
42620
  include?: string;
42569
42621
  /** @description Dry run mode: return changed unit(s) but don't update configuration data */
42570
42622
  dry_run?: boolean;
@@ -42686,7 +42738,11 @@ interface operations {
42686
42738
  from?: string;
42687
42739
  /** @description The Revision on the To side, in the same syntax as from. */
42688
42740
  to?: string;
42689
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
42741
+ /**
42742
+ * @description 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.
42743
+ *
42744
+ * Supported values: Attribution, Unchanged, Context.
42745
+ */
42690
42746
  include?: string;
42691
42747
  /** @description Limit the diff to the resources this where expression selects on either side. */
42692
42748
  where_resource?: string;
@@ -50148,6 +50204,10 @@ interface operations {
50148
50204
  *
50149
50205
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50150
50206
  *
50207
+ * 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.
50208
+ *
50209
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50210
+ *
50151
50211
  * The whole string must be query-encoded.
50152
50212
  */
50153
50213
  include?: string;
@@ -50722,6 +50782,10 @@ interface operations {
50722
50782
  *
50723
50783
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50724
50784
  *
50785
+ * 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.
50786
+ *
50787
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50788
+ *
50725
50789
  * The whole string must be query-encoded.
50726
50790
  */
50727
50791
  include?: string;
@@ -52080,7 +52144,11 @@ interface operations {
52080
52144
  from?: string;
52081
52145
  /** @description The Revision on the To side, in the same syntax as from. */
52082
52146
  to?: string;
52083
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
52147
+ /**
52148
+ * @description 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.
52149
+ *
52150
+ * Supported values: Attribution, Unchanged, Context.
52151
+ */
52084
52152
  include?: string;
52085
52153
  /** @description Limit the diff to the resources this where expression selects on either side. */
52086
52154
  where_resource?: string;
@@ -52584,7 +52652,11 @@ interface operations {
52584
52652
  * @description 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.
52585
52653
  */
52586
52654
  dry_run?: boolean;
52587
- /** @description 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. */
52655
+ /**
52656
+ * @description 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.
52657
+ *
52658
+ * Supported values: Mutations, Diff.
52659
+ */
52588
52660
  include?: string;
52589
52661
  };
52590
52662
  header?: never;
@@ -54438,6 +54510,10 @@ interface operations {
54438
54510
  };
54439
54511
  };
54440
54512
  }
54513
+ declare enum PathsReleaseGetParametersQueryDistinct_on {
54514
+ Space = "Space",
54515
+ Off = "Off"
54516
+ }
54441
54517
  declare enum PathsRevisionGetParametersQueryDistinct_on {
54442
54518
  Unit = "Unit",
54443
54519
  Off = "Off"
package/dist/index.d.ts CHANGED
@@ -1061,7 +1061,7 @@ interface paths {
1061
1061
  };
1062
1062
  /**
1063
1063
  * List of Releases across spaces
1064
- * @description Retrieves a list of Releases across spaces in the Organization
1064
+ * @description Retrieves a list of Releases across spaces in the Organization. By default, returns at most one Release per space: the highest-numbered one that matches. Set `distinct_on=Off` to receive every matching Release instead -- paginate with `limit` and the continue token to walk the full result set (`distinct_on=Off` requires an explicit `limit` and a non-empty `where` or `filter`, since without deduplication or a filter there is nothing bounding the result set)
1065
1065
  */
1066
1066
  get: operations["ListAllReleases"];
1067
1067
  put?: never;
@@ -6876,10 +6876,14 @@ interface components {
6876
6876
  PathChange: {
6877
6877
  /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
6878
6878
  Attribution?: components["schemas"]["MutationInfo"];
6879
- /** @description Add, Delete, Update, Replace, Reorder, or Rename */
6879
+ /** @description Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */
6880
6880
  ChangeType?: string;
6881
+ /** @description 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 */
6882
+ Comment?: string;
6881
6883
  /** @description The path in configuration path syntax, as --path arguments and where filters take it, with each unkeyed array element named by its index */
6882
6884
  DisplayPath?: string;
6885
+ /** @description 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 */
6886
+ FromDataType?: string;
6883
6887
  /** @description The value on the From side: a scalar's text, or a YAML block for a map or array */
6884
6888
  FromValue?: string;
6885
6889
  /** @description A unified line diff, for multi-line string values */
@@ -6888,7 +6892,9 @@ interface components {
6888
6892
  Path?: string;
6889
6893
  /** @description The path split into its segments, for rendering without parsing the path syntax */
6890
6894
  Segments?: components["schemas"]["PathSegment"][] | null;
6891
- /** @description The value on the To side: a scalar's text, or a YAML block for a map or array */
6895
+ /** @description 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 */
6896
+ ToDataType?: string;
6897
+ /** @description 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 */
6892
6898
  ToValue?: string;
6893
6899
  };
6894
6900
  PathExpression: {
@@ -6911,11 +6917,11 @@ interface components {
6911
6917
  /** @description The map key, for a map segment */
6912
6918
  Field?: string;
6913
6919
  /** @description The element's index on the From side; -1 for a map key or an element absent there */
6914
- FromIndex?: number;
6920
+ FromIndex: number;
6915
6921
  /** @description The merge keys that identify the element, for an element of a merge-keyed array */
6916
6922
  MergeKeys?: components["schemas"]["MergeKeyValue"][];
6917
6923
  /** @description The element's index on the To side; -1 for a map key or an element absent there */
6918
- ToIndex?: number;
6924
+ ToIndex: number;
6919
6925
  };
6920
6926
  PathToVisitorInfoType: {
6921
6927
  [key: string]: components["schemas"]["PathVisitorInfo"];
@@ -18710,7 +18716,11 @@ interface operations {
18710
18716
  query?: {
18711
18717
  /** @description Plan the demotion and return the same response without writing anything. */
18712
18718
  dry_run?: boolean;
18713
- /** @description 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. */
18719
+ /**
18720
+ * @description 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.
18721
+ *
18722
+ * Supported values: Mutations, Diff.
18723
+ */
18714
18724
  include?: string;
18715
18725
  };
18716
18726
  header?: never;
@@ -18818,7 +18828,11 @@ interface operations {
18818
18828
  DiffConfigurations: {
18819
18829
  parameters: {
18820
18830
  query?: {
18821
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
18831
+ /**
18832
+ * @description 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.
18833
+ *
18834
+ * Supported values: Attribution, Unchanged, Context.
18835
+ */
18822
18836
  include?: string;
18823
18837
  /** @description Limit the diff to the resources this where expression selects on either side. */
18824
18838
  where_resource?: string;
@@ -20308,7 +20322,11 @@ interface operations {
20308
20322
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
20309
20323
  */
20310
20324
  include_hidden?: string;
20311
- /** @description 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. */
20325
+ /**
20326
+ * @description 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.
20327
+ *
20328
+ * Supported values: ConfigData, Diff.
20329
+ */
20312
20330
  include?: string;
20313
20331
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
20314
20332
  resource_type?: string;
@@ -24636,7 +24654,11 @@ interface operations {
24636
24654
  * @description 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.
24637
24655
  */
24638
24656
  dry_run?: boolean;
24639
- /** @description 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. */
24657
+ /**
24658
+ * @description 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.
24659
+ *
24660
+ * Supported values: Mutations, Diff, ConfigData.
24661
+ */
24640
24662
  include?: string;
24641
24663
  };
24642
24664
  header?: never;
@@ -24871,6 +24893,16 @@ interface operations {
24871
24893
  * 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.
24872
24894
  */
24873
24895
  continue?: string;
24896
+ /**
24897
+ * @description Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
24898
+ *
24899
+ * Supported values: Space, Off.
24900
+ *
24901
+ * If not specified, results are restricted to at most one row per Space.
24902
+ *
24903
+ * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
24904
+ */
24905
+ distinct_on?: PathsReleaseGetParametersQueryDistinct_on;
24874
24906
  };
24875
24907
  header?: never;
24876
24908
  path?: never;
@@ -35943,7 +35975,11 @@ interface operations {
35943
35975
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
35944
35976
  */
35945
35977
  include_hidden?: string;
35946
- /** @description 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. */
35978
+ /**
35979
+ * @description 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.
35980
+ *
35981
+ * Supported values: ConfigData, Diff.
35982
+ */
35947
35983
  include?: string;
35948
35984
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
35949
35985
  resource_type?: string;
@@ -41638,7 +41674,11 @@ interface operations {
41638
41674
  merge_external_source?: string;
41639
41675
  /** @description Allowed values are true and false. Default is false. When true, reports success when an entity already exists and returns the existing entity */
41640
41676
  allow_exists?: string;
41641
- /** @description 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. */
41677
+ /**
41678
+ * @description 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.
41679
+ *
41680
+ * Supported values: ConfigData, MutationSources, Diff.
41681
+ */
41642
41682
  include?: string;
41643
41683
  /** @description 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. */
41644
41684
  dry_run?: boolean;
@@ -41937,7 +41977,11 @@ interface operations {
41937
41977
  prior_revisions?: string;
41938
41978
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
41939
41979
  subgroup?: string;
41940
- /** @description 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. */
41980
+ /**
41981
+ * @description 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.
41982
+ *
41983
+ * Supported values: ConfigData, MutationSources, Diff.
41984
+ */
41941
41985
  include?: string;
41942
41986
  };
41943
41987
  header?: never;
@@ -42244,7 +42288,11 @@ interface operations {
42244
42288
  prior_revisions?: string;
42245
42289
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
42246
42290
  subgroup?: string;
42247
- /** @description 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. */
42291
+ /**
42292
+ * @description 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.
42293
+ *
42294
+ * Supported values: ConfigData, MutationSources, Diff.
42295
+ */
42248
42296
  include?: string;
42249
42297
  };
42250
42298
  header?: never;
@@ -42564,7 +42612,11 @@ interface operations {
42564
42612
  query?: {
42565
42613
  /** @description Human-readable description of this change, copied to the Revision it creates. */
42566
42614
  last_change_description?: string;
42567
- /** @description 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. */
42615
+ /**
42616
+ * @description 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.
42617
+ *
42618
+ * Supported values: ConfigData, MutationSources, Diff.
42619
+ */
42568
42620
  include?: string;
42569
42621
  /** @description Dry run mode: return changed unit(s) but don't update configuration data */
42570
42622
  dry_run?: boolean;
@@ -42686,7 +42738,11 @@ interface operations {
42686
42738
  from?: string;
42687
42739
  /** @description The Revision on the To side, in the same syntax as from. */
42688
42740
  to?: string;
42689
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
42741
+ /**
42742
+ * @description 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.
42743
+ *
42744
+ * Supported values: Attribution, Unchanged, Context.
42745
+ */
42690
42746
  include?: string;
42691
42747
  /** @description Limit the diff to the resources this where expression selects on either side. */
42692
42748
  where_resource?: string;
@@ -50148,6 +50204,10 @@ interface operations {
50148
50204
  *
50149
50205
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50150
50206
  *
50207
+ * 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.
50208
+ *
50209
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50210
+ *
50151
50211
  * The whole string must be query-encoded.
50152
50212
  */
50153
50213
  include?: string;
@@ -50722,6 +50782,10 @@ interface operations {
50722
50782
  *
50723
50783
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50724
50784
  *
50785
+ * 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.
50786
+ *
50787
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50788
+ *
50725
50789
  * The whole string must be query-encoded.
50726
50790
  */
50727
50791
  include?: string;
@@ -52080,7 +52144,11 @@ interface operations {
52080
52144
  from?: string;
52081
52145
  /** @description The Revision on the To side, in the same syntax as from. */
52082
52146
  to?: string;
52083
- /** @description Comma-separated: Attribution to attach to each changed path the To side's MutationSources entry, which says what set the new value, and Unchanged to also list resources with no changes. */
52147
+ /**
52148
+ * @description 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.
52149
+ *
52150
+ * Supported values: Attribution, Unchanged, Context.
52151
+ */
52084
52152
  include?: string;
52085
52153
  /** @description Limit the diff to the resources this where expression selects on either side. */
52086
52154
  where_resource?: string;
@@ -52584,7 +52652,11 @@ interface operations {
52584
52652
  * @description 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.
52585
52653
  */
52586
52654
  dry_run?: boolean;
52587
- /** @description 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. */
52655
+ /**
52656
+ * @description 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.
52657
+ *
52658
+ * Supported values: Mutations, Diff.
52659
+ */
52588
52660
  include?: string;
52589
52661
  };
52590
52662
  header?: never;
@@ -54438,6 +54510,10 @@ interface operations {
54438
54510
  };
54439
54511
  };
54440
54512
  }
54513
+ declare enum PathsReleaseGetParametersQueryDistinct_on {
54514
+ Space = "Space",
54515
+ Off = "Off"
54516
+ }
54441
54517
  declare enum PathsRevisionGetParametersQueryDistinct_on {
54442
54518
  Unit = "Unit",
54443
54519
  Off = "Off"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.8.23",
3
+ "version": "0.8.24",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {