@confighub/api 0.8.8 → 0.8.9

package/dist/index.d.cts

@@ -6152,6 +6152,8 @@ interface components {
         PromoteUnitResult: {
             /** @description Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip. */
             Action?: string;
+            /** @description The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes. */
+            ConfigData?: string;
             /** @description Paths withheld because they were overridden locally or guarded. */
             Conflicts?: components["schemas"]["MutationConflictList"];
             /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
@@ -8203,8 +8205,12 @@ interface components {
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             ChangeSetID?: string;
+            /** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
+            Clearance?: components["schemas"]["Clearance"];
             /** @description Placement of each component. Exactly one is supported. */
             Components?: components["schemas"]["UploadComponentRequest"][];
+            /** @description Plan the upload and return the same response without writing anything. */
+            DryRun?: boolean;
             /** @description The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given. */
             Files?: components["schemas"]["UploadRequestFile"][];
             /** @description The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied. */
@@ -8216,6 +8222,14 @@ interface components {
             };
             /** @description Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}. */
             SpacePattern?: string;
+            /** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */
+            Subgroup?: string;
+            /**
+             * Format: uuid
+             * @description A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written.
+             * @example 248df4b7-aa70-47b8-a036-33ac447e668d
+             */
+            TagID?: string;
         };
         UploadRequestFile: {
             /** @description The file's contents. */
@@ -22222,7 +22236,7 @@ interface operations {
                  * @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.
                  */
                 dry_run?: boolean;
-                /** @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. On a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. */
+                /** @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. */
                 include?: string;
             };
             header?: never;
@@ -47271,7 +47285,10 @@ interface operations {
     Upload: {
         parameters: {
             query?: {
-                /** @description Plan the upload and return the same response without writing anything. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 dry_run?: boolean;
                 /** @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. */
                 include?: string;

package/dist/index.d.ts

@@ -6152,6 +6152,8 @@ interface components {
         PromoteUnitResult: {
             /** @description Upgrade, Resolve, Mark, Empty, Revive, Clone, Invoke, Unchanged, or Skip. */
             Action?: string;
+            /** @description The configuration the write produced, or on a dry run would produce. Returned when include names ConfigData, for a Unit the promotion writes. */
+            ConfigData?: string;
             /** @description Paths withheld because they were overridden locally or guarded. */
             Conflicts?: components["schemas"]["MutationConflictList"];
             /** @description The same change path by path, with the values on both sides. Returned when include names Diff. */
@@ -8203,8 +8205,12 @@ interface components {
              * @example 248df4b7-aa70-47b8-a036-33ac447e668d
              */
             ChangeSetID?: string;
+            /** @description The guarded reasons the Unit writes are cleared for. A path whose guards this does not cover is not written, and the withheld change is reported in the Unit's Conflicts. */
+            Clearance?: components["schemas"]["Clearance"];
             /** @description Placement of each component. Exactly one is supported. */
             Components?: components["schemas"]["UploadComponentRequest"][];
+            /** @description Plan the upload and return the same response without writing anything. */
+            DryRun?: boolean;
             /** @description The bundle's files. Paths must be relative and may not contain "..". Exactly one of Files and Source.Pull is given. */
             Files?: components["schemas"]["UploadRequestFile"][];
             /** @description The bundle is part of what its source owns: Units the source owns that it leaves out are left alone rather than emptied. */
@@ -8216,6 +8222,14 @@ interface components {
             };
             /** @description Slug pattern for created Spaces, over the Space's Component and labels. Default {{.Component.Slug}}-{{.Labels.Variant}}. */
             SpacePattern?: string;
+            /** @description A category recorded on the Mutations of each Unit write. Alphanumeric, at most 64 characters, and not starting with ConfigHub. */
+            Subgroup?: string;
+            /**
+             * Format: uuid
+             * @description A Tag to put on the Revision each Unit the upload writes is left at, created Units included. Units the upload leaves Unchanged are not tagged. Requires Use permission on the Tag; a ChangeSet's or ChangeOrder's own Tag is refused. An upload with a Unit to write that the Tag already marks fails, and nothing is written.
+             * @example 248df4b7-aa70-47b8-a036-33ac447e668d
+             */
+            TagID?: string;
         };
         UploadRequestFile: {
             /** @description The file's contents. */
@@ -22222,7 +22236,7 @@ interface operations {
                  * @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.
                  */
                 dry_run?: boolean;
-                /** @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. On a dry run either one runs the merges a plan otherwise skips, so they are returned only when named. */
+                /** @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. */
                 include?: string;
             };
             header?: never;
@@ -47271,7 +47285,10 @@ interface operations {
     Upload: {
         parameters: {
             query?: {
-                /** @description Plan the upload and return the same response without writing anything. */
+                /**
+                 * @deprecated
+                 * @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.
+                 */
                 dry_run?: boolean;
                 /** @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. */
                 include?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@confighub/api",
-  "version": "0.8.8",
+  "version": "0.8.9",
   "description": "Typed, framework-agnostic client for the ConfigHub API",
   "license": "MIT",
   "repository": {