@confighub/api 0.8.23 → 0.8.25

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;
@@ -5768,6 +5768,8 @@ interface components {
5768
5768
  };
5769
5769
  /** @description Release with additional related entities expanded based on the request's include parameter. */
5770
5770
  ExtendedRelease: {
5771
+ /** @description The ChangeOrder the Release was published for, if any. Expanded when requested via the include parameter. */
5772
+ ChangeOrder?: components["schemas"]["ChangeOrder"];
5771
5773
  Organization?: components["schemas"]["Organization"];
5772
5774
  /** @description The Release. */
5773
5775
  Release?: components["schemas"]["Release"];
@@ -5775,6 +5777,10 @@ interface components {
5775
5777
  Space?: components["schemas"]["Space"];
5776
5778
  /** @description The Tag the bundled Units were pinned to, if any. Expanded when requested via the include parameter. */
5777
5779
  Tag?: components["schemas"]["Tag"];
5780
+ /** @description The Target the Release was published for. Expanded when requested via the include parameter. */
5781
+ Target?: components["schemas"]["Target"];
5782
+ /** @description The User who published the Release. Expanded when requested via the include parameter. */
5783
+ User?: components["schemas"]["User"];
5778
5784
  };
5779
5785
  ExtendedResource: {
5780
5786
  Error?: components["schemas"]["ResponseError"];
@@ -6876,10 +6882,14 @@ interface components {
6876
6882
  PathChange: {
6877
6883
  /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
6878
6884
  Attribution?: components["schemas"]["MutationInfo"];
6879
- /** @description Add, Delete, Update, Replace, Reorder, or Rename */
6885
+ /** @description Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */
6880
6886
  ChangeType?: string;
6887
+ /** @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 */
6888
+ Comment?: string;
6881
6889
  /** @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
6890
  DisplayPath?: string;
6891
+ /** @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 */
6892
+ FromDataType?: string;
6883
6893
  /** @description The value on the From side: a scalar's text, or a YAML block for a map or array */
6884
6894
  FromValue?: string;
6885
6895
  /** @description A unified line diff, for multi-line string values */
@@ -6888,7 +6898,9 @@ interface components {
6888
6898
  Path?: string;
6889
6899
  /** @description The path split into its segments, for rendering without parsing the path syntax */
6890
6900
  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 */
6901
+ /** @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 */
6902
+ ToDataType?: string;
6903
+ /** @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
6904
  ToValue?: string;
6893
6905
  };
6894
6906
  PathExpression: {
@@ -6911,11 +6923,11 @@ interface components {
6911
6923
  /** @description The map key, for a map segment */
6912
6924
  Field?: string;
6913
6925
  /** @description The element's index on the From side; -1 for a map key or an element absent there */
6914
- FromIndex?: number;
6926
+ FromIndex: number;
6915
6927
  /** @description The merge keys that identify the element, for an element of a merge-keyed array */
6916
6928
  MergeKeys?: components["schemas"]["MergeKeyValue"][];
6917
6929
  /** @description The element's index on the To side; -1 for a map key or an element absent there */
6918
- ToIndex?: number;
6930
+ ToIndex: number;
6919
6931
  };
6920
6932
  PathToVisitorInfoType: {
6921
6933
  [key: string]: components["schemas"]["PathVisitorInfo"];
@@ -18710,7 +18722,11 @@ interface operations {
18710
18722
  query?: {
18711
18723
  /** @description Plan the demotion and return the same response without writing anything. */
18712
18724
  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. */
18725
+ /**
18726
+ * @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.
18727
+ *
18728
+ * Supported values: Mutations, Diff.
18729
+ */
18714
18730
  include?: string;
18715
18731
  };
18716
18732
  header?: never;
@@ -18818,7 +18834,11 @@ interface operations {
18818
18834
  DiffConfigurations: {
18819
18835
  parameters: {
18820
18836
  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. */
18837
+ /**
18838
+ * @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.
18839
+ *
18840
+ * Supported values: Attribution, Unchanged, Context.
18841
+ */
18822
18842
  include?: string;
18823
18843
  /** @description Limit the diff to the resources this where expression selects on either side. */
18824
18844
  where_resource?: string;
@@ -20308,7 +20328,11 @@ interface operations {
20308
20328
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
20309
20329
  */
20310
20330
  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. */
20331
+ /**
20332
+ * @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.
20333
+ *
20334
+ * Supported values: ConfigData, Diff.
20335
+ */
20312
20336
  include?: string;
20313
20337
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
20314
20338
  resource_type?: string;
@@ -24636,7 +24660,11 @@ interface operations {
24636
24660
  * @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
24661
  */
24638
24662
  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. */
24663
+ /**
24664
+ * @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.
24665
+ *
24666
+ * Supported values: Mutations, Diff, ConfigData.
24667
+ */
24640
24668
  include?: string;
24641
24669
  };
24642
24670
  header?: never;
@@ -24821,7 +24849,7 @@ interface operations {
24821
24849
  * The attribute names are case-sensitive, PascalCase, and
24822
24850
  * expected in a comma-separated list format as in the JSON encoding.
24823
24851
  *
24824
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
24852
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
24825
24853
  *
24826
24854
  * The whole string must be query-encoded.
24827
24855
  */
@@ -24871,6 +24899,16 @@ interface operations {
24871
24899
  * 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
24900
  */
24873
24901
  continue?: string;
24902
+ /**
24903
+ * @description Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
24904
+ *
24905
+ * Supported values: Space, Off.
24906
+ *
24907
+ * If not specified, results are restricted to at most one row per Space.
24908
+ *
24909
+ * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
24910
+ */
24911
+ distinct_on?: PathsReleaseGetParametersQueryDistinct_on;
24874
24912
  };
24875
24913
  header?: never;
24876
24914
  path?: never;
@@ -35943,7 +35981,11 @@ interface operations {
35943
35981
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
35944
35982
  */
35945
35983
  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. */
35984
+ /**
35985
+ * @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.
35986
+ *
35987
+ * Supported values: ConfigData, Diff.
35988
+ */
35947
35989
  include?: string;
35948
35990
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
35949
35991
  resource_type?: string;
@@ -38008,7 +38050,7 @@ interface operations {
38008
38050
  * The attribute names are case-sensitive, PascalCase, and
38009
38051
  * expected in a comma-separated list format as in the JSON encoding.
38010
38052
  *
38011
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
38053
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
38012
38054
  *
38013
38055
  * The whole string must be query-encoded.
38014
38056
  */
@@ -38242,7 +38284,7 @@ interface operations {
38242
38284
  * The attribute names are case-sensitive, PascalCase, and
38243
38285
  * expected in a comma-separated list format as in the JSON encoding.
38244
38286
  *
38245
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
38287
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
38246
38288
  *
38247
38289
  * The whole string must be query-encoded.
38248
38290
  */
@@ -41638,7 +41680,11 @@ interface operations {
41638
41680
  merge_external_source?: string;
41639
41681
  /** @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
41682
  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. */
41683
+ /**
41684
+ * @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.
41685
+ *
41686
+ * Supported values: ConfigData, MutationSources, Diff.
41687
+ */
41642
41688
  include?: string;
41643
41689
  /** @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
41690
  dry_run?: boolean;
@@ -41937,7 +41983,11 @@ interface operations {
41937
41983
  prior_revisions?: string;
41938
41984
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
41939
41985
  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. */
41986
+ /**
41987
+ * @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.
41988
+ *
41989
+ * Supported values: ConfigData, MutationSources, Diff.
41990
+ */
41941
41991
  include?: string;
41942
41992
  };
41943
41993
  header?: never;
@@ -42244,7 +42294,11 @@ interface operations {
42244
42294
  prior_revisions?: string;
42245
42295
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
42246
42296
  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. */
42297
+ /**
42298
+ * @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.
42299
+ *
42300
+ * Supported values: ConfigData, MutationSources, Diff.
42301
+ */
42248
42302
  include?: string;
42249
42303
  };
42250
42304
  header?: never;
@@ -42564,7 +42618,11 @@ interface operations {
42564
42618
  query?: {
42565
42619
  /** @description Human-readable description of this change, copied to the Revision it creates. */
42566
42620
  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. */
42621
+ /**
42622
+ * @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.
42623
+ *
42624
+ * Supported values: ConfigData, MutationSources, Diff.
42625
+ */
42568
42626
  include?: string;
42569
42627
  /** @description Dry run mode: return changed unit(s) but don't update configuration data */
42570
42628
  dry_run?: boolean;
@@ -42686,7 +42744,11 @@ interface operations {
42686
42744
  from?: string;
42687
42745
  /** @description The Revision on the To side, in the same syntax as from. */
42688
42746
  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. */
42747
+ /**
42748
+ * @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.
42749
+ *
42750
+ * Supported values: Attribution, Unchanged, Context.
42751
+ */
42690
42752
  include?: string;
42691
42753
  /** @description Limit the diff to the resources this where expression selects on either side. */
42692
42754
  where_resource?: string;
@@ -50148,6 +50210,10 @@ interface operations {
50148
50210
  *
50149
50211
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50150
50212
  *
50213
+ * 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.
50214
+ *
50215
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50216
+ *
50151
50217
  * The whole string must be query-encoded.
50152
50218
  */
50153
50219
  include?: string;
@@ -50722,6 +50788,10 @@ interface operations {
50722
50788
  *
50723
50789
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50724
50790
  *
50791
+ * 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.
50792
+ *
50793
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50794
+ *
50725
50795
  * The whole string must be query-encoded.
50726
50796
  */
50727
50797
  include?: string;
@@ -52080,7 +52150,11 @@ interface operations {
52080
52150
  from?: string;
52081
52151
  /** @description The Revision on the To side, in the same syntax as from. */
52082
52152
  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. */
52153
+ /**
52154
+ * @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.
52155
+ *
52156
+ * Supported values: Attribution, Unchanged, Context.
52157
+ */
52084
52158
  include?: string;
52085
52159
  /** @description Limit the diff to the resources this where expression selects on either side. */
52086
52160
  where_resource?: string;
@@ -52584,7 +52658,11 @@ interface operations {
52584
52658
  * @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
52659
  */
52586
52660
  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. */
52661
+ /**
52662
+ * @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.
52663
+ *
52664
+ * Supported values: Mutations, Diff.
52665
+ */
52588
52666
  include?: string;
52589
52667
  };
52590
52668
  header?: never;
@@ -54438,6 +54516,10 @@ interface operations {
54438
54516
  };
54439
54517
  };
54440
54518
  }
54519
+ declare enum PathsReleaseGetParametersQueryDistinct_on {
54520
+ Space = "Space",
54521
+ Off = "Off"
54522
+ }
54441
54523
  declare enum PathsRevisionGetParametersQueryDistinct_on {
54442
54524
  Unit = "Unit",
54443
54525
  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;
@@ -5768,6 +5768,8 @@ interface components {
5768
5768
  };
5769
5769
  /** @description Release with additional related entities expanded based on the request's include parameter. */
5770
5770
  ExtendedRelease: {
5771
+ /** @description The ChangeOrder the Release was published for, if any. Expanded when requested via the include parameter. */
5772
+ ChangeOrder?: components["schemas"]["ChangeOrder"];
5771
5773
  Organization?: components["schemas"]["Organization"];
5772
5774
  /** @description The Release. */
5773
5775
  Release?: components["schemas"]["Release"];
@@ -5775,6 +5777,10 @@ interface components {
5775
5777
  Space?: components["schemas"]["Space"];
5776
5778
  /** @description The Tag the bundled Units were pinned to, if any. Expanded when requested via the include parameter. */
5777
5779
  Tag?: components["schemas"]["Tag"];
5780
+ /** @description The Target the Release was published for. Expanded when requested via the include parameter. */
5781
+ Target?: components["schemas"]["Target"];
5782
+ /** @description The User who published the Release. Expanded when requested via the include parameter. */
5783
+ User?: components["schemas"]["User"];
5778
5784
  };
5779
5785
  ExtendedResource: {
5780
5786
  Error?: components["schemas"]["ResponseError"];
@@ -6876,10 +6882,14 @@ interface components {
6876
6882
  PathChange: {
6877
6883
  /** @description The To side's MutationSources entry for this path, which says what set the new value; returned when include names Attribution */
6878
6884
  Attribution?: components["schemas"]["MutationInfo"];
6879
- /** @description Add, Delete, Update, Replace, Reorder, or Rename */
6885
+ /** @description Add, Delete, Update, Replace, Reorder, or Rename; or None for an unchanged path returned as context */
6880
6886
  ChangeType?: string;
6887
+ /** @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 */
6888
+ Comment?: string;
6881
6889
  /** @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
6890
  DisplayPath?: string;
6891
+ /** @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 */
6892
+ FromDataType?: string;
6883
6893
  /** @description The value on the From side: a scalar's text, or a YAML block for a map or array */
6884
6894
  FromValue?: string;
6885
6895
  /** @description A unified line diff, for multi-line string values */
@@ -6888,7 +6898,9 @@ interface components {
6888
6898
  Path?: string;
6889
6899
  /** @description The path split into its segments, for rendering without parsing the path syntax */
6890
6900
  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 */
6901
+ /** @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 */
6902
+ ToDataType?: string;
6903
+ /** @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
6904
  ToValue?: string;
6893
6905
  };
6894
6906
  PathExpression: {
@@ -6911,11 +6923,11 @@ interface components {
6911
6923
  /** @description The map key, for a map segment */
6912
6924
  Field?: string;
6913
6925
  /** @description The element's index on the From side; -1 for a map key or an element absent there */
6914
- FromIndex?: number;
6926
+ FromIndex: number;
6915
6927
  /** @description The merge keys that identify the element, for an element of a merge-keyed array */
6916
6928
  MergeKeys?: components["schemas"]["MergeKeyValue"][];
6917
6929
  /** @description The element's index on the To side; -1 for a map key or an element absent there */
6918
- ToIndex?: number;
6930
+ ToIndex: number;
6919
6931
  };
6920
6932
  PathToVisitorInfoType: {
6921
6933
  [key: string]: components["schemas"]["PathVisitorInfo"];
@@ -18710,7 +18722,11 @@ interface operations {
18710
18722
  query?: {
18711
18723
  /** @description Plan the demotion and return the same response without writing anything. */
18712
18724
  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. */
18725
+ /**
18726
+ * @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.
18727
+ *
18728
+ * Supported values: Mutations, Diff.
18729
+ */
18714
18730
  include?: string;
18715
18731
  };
18716
18732
  header?: never;
@@ -18818,7 +18834,11 @@ interface operations {
18818
18834
  DiffConfigurations: {
18819
18835
  parameters: {
18820
18836
  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. */
18837
+ /**
18838
+ * @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.
18839
+ *
18840
+ * Supported values: Attribution, Unchanged, Context.
18841
+ */
18822
18842
  include?: string;
18823
18843
  /** @description Limit the diff to the resources this where expression selects on either side. */
18824
18844
  where_resource?: string;
@@ -20308,7 +20328,11 @@ interface operations {
20308
20328
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
20309
20329
  */
20310
20330
  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. */
20331
+ /**
20332
+ * @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.
20333
+ *
20334
+ * Supported values: ConfigData, Diff.
20335
+ */
20312
20336
  include?: string;
20313
20337
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
20314
20338
  resource_type?: string;
@@ -24636,7 +24660,11 @@ interface operations {
24636
24660
  * @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
24661
  */
24638
24662
  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. */
24663
+ /**
24664
+ * @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.
24665
+ *
24666
+ * Supported values: Mutations, Diff, ConfigData.
24667
+ */
24640
24668
  include?: string;
24641
24669
  };
24642
24670
  header?: never;
@@ -24821,7 +24849,7 @@ interface operations {
24821
24849
  * The attribute names are case-sensitive, PascalCase, and
24822
24850
  * expected in a comma-separated list format as in the JSON encoding.
24823
24851
  *
24824
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
24852
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
24825
24853
  *
24826
24854
  * The whole string must be query-encoded.
24827
24855
  */
@@ -24871,6 +24899,16 @@ interface operations {
24871
24899
  * 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
24900
  */
24873
24901
  continue?: string;
24902
+ /**
24903
+ * @description Entity to return at most one Release per. The result set applies DISTINCT ON this key, keeping the most recent row for each.
24904
+ *
24905
+ * Supported values: Space, Off.
24906
+ *
24907
+ * If not specified, results are restricted to at most one row per Space.
24908
+ *
24909
+ * Off disables the DISTINCT ON and returns every matching row, so it requires an explicit 'limit' and is rejected with 400 without one.
24910
+ */
24911
+ distinct_on?: PathsReleaseGetParametersQueryDistinct_on;
24874
24912
  };
24875
24913
  header?: never;
24876
24914
  path?: never;
@@ -35943,7 +35981,11 @@ interface operations {
35943
35981
  * ConfigHub/YAML Units, which hold the configuration of entities, are hidden with the HiddenReason `BackingUnit`.
35944
35982
  */
35945
35983
  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. */
35984
+ /**
35985
+ * @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.
35986
+ *
35987
+ * Supported values: ConfigData, Diff.
35988
+ */
35947
35989
  include?: string;
35948
35990
  /** @description Resource type: Resource type to match for the desired ToolchainType, for example apps/v1/Deployment */
35949
35991
  resource_type?: string;
@@ -38008,7 +38050,7 @@ interface operations {
38008
38050
  * The attribute names are case-sensitive, PascalCase, and
38009
38051
  * expected in a comma-separated list format as in the JSON encoding.
38010
38052
  *
38011
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
38053
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
38012
38054
  *
38013
38055
  * The whole string must be query-encoded.
38014
38056
  */
@@ -38242,7 +38284,7 @@ interface operations {
38242
38284
  * The attribute names are case-sensitive, PascalCase, and
38243
38285
  * expected in a comma-separated list format as in the JSON encoding.
38244
38286
  *
38245
- * Supported attributes for Release are OrganizationID, SpaceID, TagID.
38287
+ * Supported attributes for Release are ChangeOrderID, OrganizationID, SpaceID, TagID, TargetID, UserID.
38246
38288
  *
38247
38289
  * The whole string must be query-encoded.
38248
38290
  */
@@ -41638,7 +41680,11 @@ interface operations {
41638
41680
  merge_external_source?: string;
41639
41681
  /** @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
41682
  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. */
41683
+ /**
41684
+ * @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.
41685
+ *
41686
+ * Supported values: ConfigData, MutationSources, Diff.
41687
+ */
41642
41688
  include?: string;
41643
41689
  /** @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
41690
  dry_run?: boolean;
@@ -41937,7 +41983,11 @@ interface operations {
41937
41983
  prior_revisions?: string;
41938
41984
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
41939
41985
  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. */
41986
+ /**
41987
+ * @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.
41988
+ *
41989
+ * Supported values: ConfigData, MutationSources, Diff.
41990
+ */
41941
41991
  include?: string;
41942
41992
  };
41943
41993
  header?: never;
@@ -42244,7 +42294,11 @@ interface operations {
42244
42294
  prior_revisions?: string;
42245
42295
  /** @description User-defined category for the Mutation. Must be alphanumeric, at most 64 characters. The prefix 'ConfigHub' is reserved. */
42246
42296
  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. */
42297
+ /**
42298
+ * @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.
42299
+ *
42300
+ * Supported values: ConfigData, MutationSources, Diff.
42301
+ */
42248
42302
  include?: string;
42249
42303
  };
42250
42304
  header?: never;
@@ -42564,7 +42618,11 @@ interface operations {
42564
42618
  query?: {
42565
42619
  /** @description Human-readable description of this change, copied to the Revision it creates. */
42566
42620
  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. */
42621
+ /**
42622
+ * @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.
42623
+ *
42624
+ * Supported values: ConfigData, MutationSources, Diff.
42625
+ */
42568
42626
  include?: string;
42569
42627
  /** @description Dry run mode: return changed unit(s) but don't update configuration data */
42570
42628
  dry_run?: boolean;
@@ -42686,7 +42744,11 @@ interface operations {
42686
42744
  from?: string;
42687
42745
  /** @description The Revision on the To side, in the same syntax as from. */
42688
42746
  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. */
42747
+ /**
42748
+ * @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.
42749
+ *
42750
+ * Supported values: Attribution, Unchanged, Context.
42751
+ */
42690
42752
  include?: string;
42691
42753
  /** @description Limit the diff to the resources this where expression selects on either side. */
42692
42754
  where_resource?: string;
@@ -50148,6 +50210,10 @@ interface operations {
50148
50210
  *
50149
50211
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50150
50212
  *
50213
+ * 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.
50214
+ *
50215
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50216
+ *
50151
50217
  * The whole string must be query-encoded.
50152
50218
  */
50153
50219
  include?: string;
@@ -50722,6 +50788,10 @@ interface operations {
50722
50788
  *
50723
50789
  * Supported attributes for Unit are ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID.
50724
50790
  *
50791
+ * 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.
50792
+ *
50793
+ * Supported values: ChangeSetID, FromLinkID, HeadMutationNum, HeadRevisionNum, LastReleasedRevisionNum, OrganizationID, SpaceID, TargetID, UnitEventID, UpstreamSpaceID, UpstreamUnitID, ConfigData, MutationSources, Diff.
50794
+ *
50725
50795
  * The whole string must be query-encoded.
50726
50796
  */
50727
50797
  include?: string;
@@ -52080,7 +52150,11 @@ interface operations {
52080
52150
  from?: string;
52081
52151
  /** @description The Revision on the To side, in the same syntax as from. */
52082
52152
  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. */
52153
+ /**
52154
+ * @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.
52155
+ *
52156
+ * Supported values: Attribution, Unchanged, Context.
52157
+ */
52084
52158
  include?: string;
52085
52159
  /** @description Limit the diff to the resources this where expression selects on either side. */
52086
52160
  where_resource?: string;
@@ -52584,7 +52658,11 @@ interface operations {
52584
52658
  * @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
52659
  */
52586
52660
  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. */
52661
+ /**
52662
+ * @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.
52663
+ *
52664
+ * Supported values: Mutations, Diff.
52665
+ */
52588
52666
  include?: string;
52589
52667
  };
52590
52668
  header?: never;
@@ -54438,6 +54516,10 @@ interface operations {
54438
54516
  };
54439
54517
  };
54440
54518
  }
54519
+ declare enum PathsReleaseGetParametersQueryDistinct_on {
54520
+ Space = "Space",
54521
+ Off = "Off"
54522
+ }
54441
54523
  declare enum PathsRevisionGetParametersQueryDistinct_on {
54442
54524
  Unit = "Unit",
54443
54525
  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.25",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {