[WIP] Add --generate-skeleton flag

acceptance/cmd/workspace/apps/output.txt

@@ -89,14 +89,16 @@ Usage:
   databricks apps update NAME [flags]
 
 Flags:
-      --budget-policy-id string     
-      --compute-max-instances int   Maximum number of app instances.
-      --compute-min-instances int   Minimum number of app instances.
-      --compute-size ComputeSize    Supported values: [LARGE, MEDIUM, XLARGE]
-      --description string          The description of the app.
-  -h, --help                        help for update
-      --json JSON                   either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes))
-      --space string                Name of the space this app belongs to.
+      --budget-policy-id string           
+      --compute-max-instances int         Maximum number of app instances.
+      --compute-min-instances int         Minimum number of app instances.
+      --compute-size ComputeSize          Supported values: [LARGE, MEDIUM, XLARGE]
+      --description string                The description of the app.
+      --generate-skeleton-full            Print a fillable JSON skeleton of the full --json request body and exit.
+      --generate-skeleton-required-only   Print a fillable JSON skeleton of only the required --json fields and exit.
+  -h, --help                              help for update
+      --json JSON                         either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes))
+      --space string                      Name of the space this app belongs to.
       --usage-policy-id string
 
 Global Flags:

acceptance/cmd/workspace/database/update-database-instance/output.txt

@@ -6,15 +6,17 @@ Usage:
   databricks database update-database-instance NAME UPDATE_MASK [flags]
 
 Flags:
-      --capacity string                The sku of the instance.
-      --enable-pg-native-login         Whether to enable PG native password login on the instance.
-      --enable-readable-secondaries    Whether to enable secondaries to serve read-only traffic.
-  -h, --help                           help for update-database-instance
-      --json JSON                      either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes))
-      --node-count int                 The number of nodes in the instance, composed of 1 primary and 0 or more secondaries.
-      --retention-window-in-days int   The retention window for the instance.
-      --stopped                        Whether to stop the instance.
-      --usage-policy-id string         The desired usage policy to associate with the instance.
+      --capacity string                   The sku of the instance.
+      --enable-pg-native-login            Whether to enable PG native password login on the instance.
+      --enable-readable-secondaries       Whether to enable secondaries to serve read-only traffic.
+      --generate-skeleton-full            Print a fillable JSON skeleton of the full --json request body and exit.
+      --generate-skeleton-required-only   Print a fillable JSON skeleton of only the required --json fields and exit.
+  -h, --help                              help for update-database-instance
+      --json JSON                         either inline JSON string or @path/to/file.json with request body (default JSON (0 bytes))
+      --node-count int                    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries.
+      --retention-window-in-days int      The retention window for the instance.
+      --stopped                           Whether to stop the instance.
+      --usage-policy-id string            The desired usage policy to associate with the instance.
 
 Global Flags:
       --debug            enable debug logging

acceptance/cmd/workspace/generate-skeleton/output.txt

@@ -0,0 +1,47 @@
+
+=== Plain --json request body: full skeleton is the whole request struct
+
+>>> [CLI] vector-search-endpoints create-endpoint --generate-skeleton-full
+{
+  "budget_policy_id": "",
+  "endpoint_type": "",
+  "name": "",
+  "target_qps": 0,
+  "usage_policy_id": ""
+}
+
+=== Plain --json request body: required-only keeps just the mandatory fields
+
+>>> [CLI] vector-search-endpoints create-endpoint --generate-skeleton-required-only
+{
+  "endpoint_type": "",
+  "name": ""
+}
+
+=== Request-body-field command: full skeleton, positional args relaxed
+
+>>> [CLI] entity-tag-assignments create --generate-skeleton-full
+{
+  "entity_name": "",
+  "entity_type": "",
+  "source_type": "",
+  "tag_key": "",
+  "tag_value": "",
+  "update_time": "",
+  "updated_by": ""
+}
+
+=== Request-body-field command: required-only recurses into the body field
+
+>>> [CLI] entity-tag-assignments create --generate-skeleton-required-only
+{
+  "entity_name": "",
+  "entity_type": "",
+  "tag_key": ""
+}
+
+=== The two skeleton flags are mutually exclusive
+Error: if any flags in the group [generate-skeleton-full generate-skeleton-required-only] are set none of the others can be; [generate-skeleton-full generate-skeleton-required-only] were all set
+
+=== A skeleton flag is incompatible with --json
+Error: --generate-skeleton-full cannot be combined with --json

acceptance/cmd/workspace/generate-skeleton/script

@@ -0,0 +1,17 @@
+title "Plain --json request body: full skeleton is the whole request struct\n"
+trace $CLI vector-search-endpoints create-endpoint --generate-skeleton-full
+
+title "Plain --json request body: required-only keeps just the mandatory fields\n"
+trace $CLI vector-search-endpoints create-endpoint --generate-skeleton-required-only
+
+title "Request-body-field command: full skeleton, positional args relaxed\n"
+trace $CLI entity-tag-assignments create --generate-skeleton-full
+
+title "Request-body-field command: required-only recurses into the body field\n"
+trace $CLI entity-tag-assignments create --generate-skeleton-required-only
+
+title "The two skeleton flags are mutually exclusive\n"
+musterr $CLI vector-search-endpoints create-endpoint --generate-skeleton-full --generate-skeleton-required-only
+
+title "A skeleton flag is incompatible with --json\n"
+musterr $CLI jobs create --generate-skeleton-full --json '{}'

acceptance/cmd/workspace/generate-skeleton/test.toml

@@ -0,0 +1,3 @@
+# --generate-skeleton is offline and not bundle-aware; run it once instead of per-engine.
+[EnvMatrix]
+DATABRICKS_BUNDLE_ENGINE = []