@confighub/api 0.8.26 → 0.8.28

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
@@ -4500,8 +4500,6 @@ interface components {
4500
4500
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4501
4501
  */
4502
4502
  ChangeWorkflowID?: string;
4503
- /** @description ContainerImages lists, for each Space the ChangeOrder has landed in, the container images it changed there: in each Unit the end Tag marks, the images get-container-image finds that differ from those at the Revision the start Tag marks. Derived only when a single ChangeOrder is read with container_images=true, never in a list. Spaces and Units the reader cannot view are left out. */
4504
- readonly ContainerImages?: components["schemas"]["ChangeOrderSpaceContainerImages"][];
4505
4503
  /**
4506
4504
  * Format: date-time
4507
4505
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -4688,36 +4686,6 @@ interface components {
4688
4686
  /** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'`. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
4689
4687
  WhereUnit?: string;
4690
4688
  };
4691
- ChangeOrderContainerImageChange: {
4692
- /** @description The image before the change; absent for a container the change added. */
4693
- FromImage?: string;
4694
- /**
4695
- * Format: int64
4696
- * @description The Revision the start Tag marks; absent for a Unit the change added.
4697
- */
4698
- FromRevisionNum?: number;
4699
- /** @description The path of the image within the resource. */
4700
- Path?: string;
4701
- /** @description The name of the resource the container is in, as it is at the end Tag's Revision. */
4702
- ResourceName?: string;
4703
- /** @description The type of the resource the container is in. */
4704
- ResourceType?: string;
4705
- /** @description The image after the change; absent for a container the change removed. */
4706
- ToImage?: string;
4707
- /**
4708
- * Format: int64
4709
- * @description The Revision the end Tag marks.
4710
- */
4711
- ToRevisionNum?: number;
4712
- /**
4713
- * Format: uuid
4714
- * @description The Unit the image is in.
4715
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4716
- */
4717
- UnitID?: string;
4718
- /** @description The Unit's slug. */
4719
- UnitSlug?: string;
4720
- };
4721
4689
  ChangeOrderCreateOrUpdateResponse: {
4722
4690
  ChangeOrder?: components["schemas"]["ChangeOrder"];
4723
4691
  Error?: components["schemas"]["ResponseError"];
@@ -4840,18 +4808,6 @@ interface components {
4840
4808
  */
4841
4809
  UserID: string;
4842
4810
  };
4843
- ChangeOrderSpaceContainerImages: {
4844
- /** @description The images that changed, by Unit, resource, and path. */
4845
- Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
4846
- /**
4847
- * Format: uuid
4848
- * @description The Space the images changed in.
4849
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4850
- */
4851
- SpaceID?: string;
4852
- /** @description The Space's slug. */
4853
- SpaceSlug?: string;
4854
- };
4855
4811
  /** @description Defines an entity changeset. */
4856
4812
  ChangeSet: {
4857
4813
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -5892,6 +5848,7 @@ interface components {
5892
5848
  ViewColumns?: components["schemas"]["ViewColumn"][];
5893
5849
  };
5894
5850
  ExtendedReviewComment: {
5851
+ ChangeOrder?: components["schemas"]["ChangeOrder"];
5895
5852
  Error?: components["schemas"]["ResponseError"];
5896
5853
  Organization?: components["schemas"]["Organization"];
5897
5854
  ReviewComment?: components["schemas"]["ReviewComment"];
@@ -7752,6 +7709,12 @@ interface components {
7752
7709
  };
7753
7710
  /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */
7754
7711
  ReviewComment: {
7712
+ /**
7713
+ * Format: uuid
7714
+ * @description Unique identifier of the ChangeOrder the comment was made in review of, which may be in another Space. Optional; requires Use permission on the ChangeOrder. A reply takes the ChangeOrderID of the comment it answers, and may not name another. Immutable.
7715
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7716
+ */
7717
+ ChangeOrderID?: string;
7755
7718
  /**
7756
7719
  * Format: date-time
7757
7720
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -19472,9 +19435,9 @@ interface operations {
19472
19435
  /** @description Plan the demotion and return the same response without writing anything. */
19473
19436
  dry_run?: boolean;
19474
19437
  /**
19475
- * @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.
19438
+ * @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. Context, with Diff, adds to each Diff 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.
19476
19439
  *
19477
- * Supported values: Mutations, Diff.
19440
+ * Supported values: Mutations, Diff, Context.
19478
19441
  */
19479
19442
  include?: string;
19480
19443
  };
@@ -25470,9 +25433,9 @@ interface operations {
25470
25433
  */
25471
25434
  dry_run?: boolean;
25472
25435
  /**
25473
- * @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.
25436
+ * @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. Context, with Diff, adds to each Diff 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.
25474
25437
  *
25475
- * Supported values: Mutations, Diff, ConfigData.
25438
+ * Supported values: Mutations, Diff, Context, ConfigData.
25476
25439
  */
25477
25440
  include?: string;
25478
25441
  };
@@ -26063,7 +26026,7 @@ interface operations {
26063
26026
  * An example conjunction is:
26064
26027
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26065
26028
  *
26066
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26029
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26067
26030
  *
26068
26031
  * The whole string must be query-encoded.
26069
26032
  */
@@ -26105,7 +26068,7 @@ interface operations {
26105
26068
  * The attribute names are case-sensitive, PascalCase, and
26106
26069
  * expected in a comma-separated list format as in the JSON encoding.
26107
26070
  *
26108
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26071
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26109
26072
  *
26110
26073
  * The whole string must be query-encoded.
26111
26074
  */
@@ -26148,7 +26111,7 @@ interface operations {
26148
26111
  *
26149
26112
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
26150
26113
  *
26151
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
26114
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
26152
26115
  *
26153
26116
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
26154
26117
  *
@@ -26277,7 +26240,7 @@ interface operations {
26277
26240
  * An example conjunction is:
26278
26241
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26279
26242
  *
26280
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26243
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26281
26244
  *
26282
26245
  * The whole string must be query-encoded.
26283
26246
  */
@@ -26329,7 +26292,7 @@ interface operations {
26329
26292
  * The attribute names are case-sensitive, PascalCase, and
26330
26293
  * expected in a comma-separated list format as in the JSON encoding.
26331
26294
  *
26332
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26295
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26333
26296
  *
26334
26297
  * The whole string must be query-encoded.
26335
26298
  */
@@ -26477,7 +26440,7 @@ interface operations {
26477
26440
  * An example conjunction is:
26478
26441
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26479
26442
  *
26480
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26443
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26481
26444
  *
26482
26445
  * The whole string must be query-encoded.
26483
26446
  */
@@ -26529,7 +26492,7 @@ interface operations {
26529
26492
  * The attribute names are case-sensitive, PascalCase, and
26530
26493
  * expected in a comma-separated list format as in the JSON encoding.
26531
26494
  *
26532
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26495
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26533
26496
  *
26534
26497
  * The whole string must be query-encoded.
26535
26498
  */
@@ -26548,6 +26511,8 @@ interface operations {
26548
26511
  requestBody?: {
26549
26512
  content: {
26550
26513
  "application/merge-patch+json": {
26514
+ /** Format: uuid */
26515
+ ChangeOrderID?: string | null;
26551
26516
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
26552
26517
  HiddenReason?: string | null;
26553
26518
  /** @description Path to which the remark is attached; optional */
@@ -31925,8 +31890,6 @@ interface operations {
31925
31890
  * The whole string must be query-encoded.
31926
31891
  */
31927
31892
  select?: string;
31928
- /** @description If true, fill in ContainerImages: for each Space the ChangeOrder has landed in, the container images get-container-image finds at the Revisions its end Tag marks that differ from those at the Revisions its start Tag marks. */
31929
- container_images?: boolean;
31930
31893
  };
31931
31894
  header?: never;
31932
31895
  path: {
@@ -44978,7 +44941,7 @@ interface operations {
44978
44941
  * An example conjunction is:
44979
44942
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
44980
44943
  *
44981
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
44944
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
44982
44945
  *
44983
44946
  * The whole string must be query-encoded.
44984
44947
  */
@@ -45020,7 +44983,7 @@ interface operations {
45020
44983
  * The attribute names are case-sensitive, PascalCase, and
45021
44984
  * expected in a comma-separated list format as in the JSON encoding.
45022
44985
  *
45023
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
44986
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
45024
44987
  *
45025
44988
  * The whole string must be query-encoded.
45026
44989
  */
@@ -45063,7 +45026,7 @@ interface operations {
45063
45026
  *
45064
45027
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
45065
45028
  *
45066
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
45029
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
45067
45030
  *
45068
45031
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
45069
45032
  *
@@ -45262,7 +45225,7 @@ interface operations {
45262
45225
  * The attribute names are case-sensitive, PascalCase, and
45263
45226
  * expected in a comma-separated list format as in the JSON encoding.
45264
45227
  *
45265
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
45228
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
45266
45229
  *
45267
45230
  * The whole string must be query-encoded.
45268
45231
  */
@@ -45573,6 +45536,8 @@ interface operations {
45573
45536
  requestBody?: {
45574
45537
  content: {
45575
45538
  "application/merge-patch+json": {
45539
+ /** Format: uuid */
45540
+ ChangeOrderID?: string | null;
45576
45541
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
45577
45542
  HiddenReason?: string | null;
45578
45543
  /** @description Path to which the remark is attached; optional */
@@ -53934,9 +53899,9 @@ interface operations {
53934
53899
  */
53935
53900
  dry_run?: boolean;
53936
53901
  /**
53937
- * @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.
53902
+ * @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. Context, with Diff, adds to each Diff 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.
53938
53903
  *
53939
- * Supported values: Mutations, Diff.
53904
+ * Supported values: Mutations, Diff, Context.
53940
53905
  */
53941
53906
  include?: string;
53942
53907
  };
package/dist/index.d.ts CHANGED
@@ -4500,8 +4500,6 @@ interface components {
4500
4500
  * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4501
4501
  */
4502
4502
  ChangeWorkflowID?: string;
4503
- /** @description ContainerImages lists, for each Space the ChangeOrder has landed in, the container images it changed there: in each Unit the end Tag marks, the images get-container-image finds that differ from those at the Revision the start Tag marks. Derived only when a single ChangeOrder is read with container_images=true, never in a list. Spaces and Units the reader cannot view are left out. */
4504
- readonly ContainerImages?: components["schemas"]["ChangeOrderSpaceContainerImages"][];
4505
4503
  /**
4506
4504
  * Format: date-time
4507
4505
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -4688,36 +4686,6 @@ interface components {
4688
4686
  /** @description WhereUnit narrows which Units of each Space in scope an Invoke ChangeOrder covers, and is refused on the other UpdateTypes. It takes what the where parameter of the Unit list does, attributes of what a Unit refers to included, as in `Space.Labels.Environment = 'prod'`. Empty covers every Unit. Unlike InScopeSpaceIDs it is asked again on every read, so a Unit added to a Space afterwards counts against that Space. Immutable. */
4689
4687
  WhereUnit?: string;
4690
4688
  };
4691
- ChangeOrderContainerImageChange: {
4692
- /** @description The image before the change; absent for a container the change added. */
4693
- FromImage?: string;
4694
- /**
4695
- * Format: int64
4696
- * @description The Revision the start Tag marks; absent for a Unit the change added.
4697
- */
4698
- FromRevisionNum?: number;
4699
- /** @description The path of the image within the resource. */
4700
- Path?: string;
4701
- /** @description The name of the resource the container is in, as it is at the end Tag's Revision. */
4702
- ResourceName?: string;
4703
- /** @description The type of the resource the container is in. */
4704
- ResourceType?: string;
4705
- /** @description The image after the change; absent for a container the change removed. */
4706
- ToImage?: string;
4707
- /**
4708
- * Format: int64
4709
- * @description The Revision the end Tag marks.
4710
- */
4711
- ToRevisionNum?: number;
4712
- /**
4713
- * Format: uuid
4714
- * @description The Unit the image is in.
4715
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4716
- */
4717
- UnitID?: string;
4718
- /** @description The Unit's slug. */
4719
- UnitSlug?: string;
4720
- };
4721
4689
  ChangeOrderCreateOrUpdateResponse: {
4722
4690
  ChangeOrder?: components["schemas"]["ChangeOrder"];
4723
4691
  Error?: components["schemas"]["ResponseError"];
@@ -4840,18 +4808,6 @@ interface components {
4840
4808
  */
4841
4809
  UserID: string;
4842
4810
  };
4843
- ChangeOrderSpaceContainerImages: {
4844
- /** @description The images that changed, by Unit, resource, and path. */
4845
- Images?: components["schemas"]["ChangeOrderContainerImageChange"][] | null;
4846
- /**
4847
- * Format: uuid
4848
- * @description The Space the images changed in.
4849
- * @example 248df4b7-aa70-47b8-a036-33ac447e668d
4850
- */
4851
- SpaceID?: string;
4852
- /** @description The Space's slug. */
4853
- SpaceSlug?: string;
4854
- };
4855
4811
  /** @description Defines an entity changeset. */
4856
4812
  ChangeSet: {
4857
4813
  /** @description An optional map of Annotation key/value pairs for tools to attach information to entities. */
@@ -5892,6 +5848,7 @@ interface components {
5892
5848
  ViewColumns?: components["schemas"]["ViewColumn"][];
5893
5849
  };
5894
5850
  ExtendedReviewComment: {
5851
+ ChangeOrder?: components["schemas"]["ChangeOrder"];
5895
5852
  Error?: components["schemas"]["ResponseError"];
5896
5853
  Organization?: components["schemas"]["Organization"];
5897
5854
  ReviewComment?: components["schemas"]["ReviewComment"];
@@ -7752,6 +7709,12 @@ interface components {
7752
7709
  };
7753
7710
  /** @description ReviewComment is a remark made in review of a Revision of a Unit, optionally about one resource or path in it. */
7754
7711
  ReviewComment: {
7712
+ /**
7713
+ * Format: uuid
7714
+ * @description Unique identifier of the ChangeOrder the comment was made in review of, which may be in another Space. Optional; requires Use permission on the ChangeOrder. A reply takes the ChangeOrderID of the comment it answers, and may not name another. Immutable.
7715
+ * @example 248df4b7-aa70-47b8-a036-33ac447e668d
7716
+ */
7717
+ ChangeOrderID?: string;
7755
7718
  /**
7756
7719
  * Format: date-time
7757
7720
  * @description The timestamp when the entity was created in "2023-01-01T12:00:00Z" format.
@@ -19472,9 +19435,9 @@ interface operations {
19472
19435
  /** @description Plan the demotion and return the same response without writing anything. */
19473
19436
  dry_run?: boolean;
19474
19437
  /**
19475
- * @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.
19438
+ * @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. Context, with Diff, adds to each Diff 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.
19476
19439
  *
19477
- * Supported values: Mutations, Diff.
19440
+ * Supported values: Mutations, Diff, Context.
19478
19441
  */
19479
19442
  include?: string;
19480
19443
  };
@@ -25470,9 +25433,9 @@ interface operations {
25470
25433
  */
25471
25434
  dry_run?: boolean;
25472
25435
  /**
25473
- * @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.
25436
+ * @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. Context, with Diff, adds to each Diff 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.
25474
25437
  *
25475
- * Supported values: Mutations, Diff, ConfigData.
25438
+ * Supported values: Mutations, Diff, Context, ConfigData.
25476
25439
  */
25477
25440
  include?: string;
25478
25441
  };
@@ -26063,7 +26026,7 @@ interface operations {
26063
26026
  * An example conjunction is:
26064
26027
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26065
26028
  *
26066
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26029
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26067
26030
  *
26068
26031
  * The whole string must be query-encoded.
26069
26032
  */
@@ -26105,7 +26068,7 @@ interface operations {
26105
26068
  * The attribute names are case-sensitive, PascalCase, and
26106
26069
  * expected in a comma-separated list format as in the JSON encoding.
26107
26070
  *
26108
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26071
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26109
26072
  *
26110
26073
  * The whole string must be query-encoded.
26111
26074
  */
@@ -26148,7 +26111,7 @@ interface operations {
26148
26111
  *
26149
26112
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
26150
26113
  *
26151
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
26114
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
26152
26115
  *
26153
26116
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
26154
26117
  *
@@ -26277,7 +26240,7 @@ interface operations {
26277
26240
  * An example conjunction is:
26278
26241
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26279
26242
  *
26280
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26243
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26281
26244
  *
26282
26245
  * The whole string must be query-encoded.
26283
26246
  */
@@ -26329,7 +26292,7 @@ interface operations {
26329
26292
  * The attribute names are case-sensitive, PascalCase, and
26330
26293
  * expected in a comma-separated list format as in the JSON encoding.
26331
26294
  *
26332
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26295
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26333
26296
  *
26334
26297
  * The whole string must be query-encoded.
26335
26298
  */
@@ -26477,7 +26440,7 @@ interface operations {
26477
26440
  * An example conjunction is:
26478
26441
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
26479
26442
  *
26480
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26443
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
26481
26444
  *
26482
26445
  * The whole string must be query-encoded.
26483
26446
  */
@@ -26529,7 +26492,7 @@ interface operations {
26529
26492
  * The attribute names are case-sensitive, PascalCase, and
26530
26493
  * expected in a comma-separated list format as in the JSON encoding.
26531
26494
  *
26532
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
26495
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
26533
26496
  *
26534
26497
  * The whole string must be query-encoded.
26535
26498
  */
@@ -26548,6 +26511,8 @@ interface operations {
26548
26511
  requestBody?: {
26549
26512
  content: {
26550
26513
  "application/merge-patch+json": {
26514
+ /** Format: uuid */
26515
+ ChangeOrderID?: string | null;
26551
26516
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
26552
26517
  HiddenReason?: string | null;
26553
26518
  /** @description Path to which the remark is attached; optional */
@@ -31925,8 +31890,6 @@ interface operations {
31925
31890
  * The whole string must be query-encoded.
31926
31891
  */
31927
31892
  select?: string;
31928
- /** @description If true, fill in ContainerImages: for each Space the ChangeOrder has landed in, the container images get-container-image finds at the Revisions its end Tag marks that differ from those at the Revisions its start Tag marks. */
31929
- container_images?: boolean;
31930
31893
  };
31931
31894
  header?: never;
31932
31895
  path: {
@@ -44978,7 +44941,7 @@ interface operations {
44978
44941
  * An example conjunction is:
44979
44942
  * `CreatedAt >= '2025-01-07' AND Slug = 'test' AND Labels.mykey = 'myvalue'`.
44980
44943
  *
44981
- * Supported attributes for filtering on ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
44944
+ * Supported attributes for filtering on ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, SpaceID, Text, UnitID, UpdatedAt, UserAgent, UserID.
44982
44945
  *
44983
44946
  * The whole string must be query-encoded.
44984
44947
  */
@@ -45020,7 +44983,7 @@ interface operations {
45020
44983
  * The attribute names are case-sensitive, PascalCase, and
45021
44984
  * expected in a comma-separated list format as in the JSON encoding.
45022
44985
  *
45023
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
44986
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
45024
44987
  *
45025
44988
  * The whole string must be query-encoded.
45026
44989
  */
@@ -45063,7 +45026,7 @@ interface operations {
45063
45026
  *
45064
45027
  * Field names are case-sensitive and PascalCase, as in the JSON encoding. Sort direction defaults to ASC when the 'DIRECTION:' prefix is omitted.
45065
45028
  *
45066
- * Supported attributes for ordering ReviewComment: CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
45029
+ * Supported attributes for ordering ReviewComment: ChangeOrderID, CreatedAt, HiddenReason, OrganizationID, Path, ReplyToID, ReviewCommentID, RevisionID, RevisionNum, Text, UnitID, UpdatedAt, UserAgent, UserID.
45067
45030
  *
45068
45031
  * Example: 'DESC:CreatedAt' or 'DisplayName,DESC:CreatedAt'.
45069
45032
  *
@@ -45262,7 +45225,7 @@ interface operations {
45262
45225
  * The attribute names are case-sensitive, PascalCase, and
45263
45226
  * expected in a comma-separated list format as in the JSON encoding.
45264
45227
  *
45265
- * Supported attributes for ReviewComment are OrganizationID, RevisionID, SpaceID, UnitID.
45228
+ * Supported attributes for ReviewComment are ChangeOrderID, OrganizationID, RevisionID, SpaceID, UnitID.
45266
45229
  *
45267
45230
  * The whole string must be query-encoded.
45268
45231
  */
@@ -45573,6 +45536,8 @@ interface operations {
45573
45536
  requestBody?: {
45574
45537
  content: {
45575
45538
  "application/merge-patch+json": {
45539
+ /** Format: uuid */
45540
+ ChangeOrderID?: string | null;
45576
45541
  /** @description The reason the entity is hidden, if it is. A hidden entity is left out of List and Search results, and of what bulk operations act on, unless the include_hidden parameter names its reason or is *, or the where parameter names the entity by Slug or ID. ConfigHub/YAML Units are created hidden with the reason BackingUnit unless given another. */
45577
45542
  HiddenReason?: string | null;
45578
45543
  /** @description Path to which the remark is attached; optional */
@@ -53934,9 +53899,9 @@ interface operations {
53934
53899
  */
53935
53900
  dry_run?: boolean;
53936
53901
  /**
53937
- * @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.
53902
+ * @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. Context, with Diff, adds to each Diff 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.
53938
53903
  *
53939
- * Supported values: Mutations, Diff.
53904
+ * Supported values: Mutations, Diff, Context.
53940
53905
  */
53941
53906
  include?: string;
53942
53907
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@confighub/api",
3
- "version": "0.8.26",
3
+ "version": "0.8.28",
4
4
  "description": "Typed, framework-agnostic client for the ConfigHub API",
5
5
  "license": "MIT",
6
6
  "repository": {