Add --show-schema support to drivers (#588)

docs/sections/user_guide/cli/drivers/.gitignore

@@ -0,0 +1 @@
+schema

docs/sections/user_guide/cli/drivers/cdeps.rst

@@ -37,11 +37,18 @@ Its contents are described in depth in section :ref:`cdeps_yaml`. Each of the va
 
   The driver creates a ``datm_in`` Fortran namelist file and a ``datm.streams`` stream-configuration file in the directory specified by ``rundir:`` in the config.
 
-
 * Specifying the ``--dry-run`` flag results in the driver logging messages about actions it would have taken, without actually taking any.
 
   .. code-block:: text
 
      $ uw cdeps run --config-file config.yaml --cycle 2023-12-15T18 --batch --dry-run
 
 .. include:: /shared/key_path.rst
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: cdeps/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: cdeps/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/cdeps/help.out

@@ -1,4 +1,4 @@
-usage: uw cdeps [-h] [--version] TASK ...
+usage: uw cdeps [-h] [--version] [--show-schema] TASK ...
 
 Execute cdeps tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/cdeps/show-schema.cmd

@@ -0,0 +1,2 @@
+uw cdeps --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/cdeps/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "$defs": {
+    "streams": {
+      "additionalProperties": false,
+      "minProperties": 1,
+      "patternProperties": {
+        "^stream0[1-9]$": {
+          "additionalProperties": false,
+          "properties": {
+            "dtlimit": {
+...
+      "required": [
+        "rundir"
+      ]
+    }
+  },
+  "required": [
+    "cdeps"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/chgres_cube.rst

@@ -58,3 +58,11 @@ Its contents are described in depth in section :ref:`chgres_cube_yaml`. Each of
   .. code-block:: text
 
      $ uw chgres_cube provisioned_rundir --config-file config.yaml --cycle 2023-12-15T18 --batch
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: chgres_cube/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: chgres_cube/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/chgres_cube/help.out

@@ -1,4 +1,4 @@
-usage: uw chgres_cube [-h] [--version] TASK ...
+usage: uw chgres_cube [-h] [--version] [--show-schema] TASK ...
 
 Execute chgres_cube tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.cmd

@@ -0,0 +1,2 @@
+uw chgres_cube --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/chgres_cube/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "properties": {
+    "chgres_cube": {
+      "additionalProperties": false,
+      "properties": {
+        "execution": {
+          "additionalProperties": false,
+          "properties": {
+            "batchargs": {
+              "additionalProperties": true,
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "chgres_cube"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/esg_grid.rst

@@ -58,3 +58,11 @@ The driver creates a ``runscript.esg_grid`` file in the directory specified by `
   .. code-block:: text
 
      $ uw esg_grid provisioned_rundir --config-file config.yaml --batch
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: esg_grid/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: esg_grid/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/esg_grid/help.out

@@ -1,4 +1,4 @@
-usage: uw esg_grid [-h] [--version] TASK ...
+usage: uw esg_grid [-h] [--version] [--show-schema] TASK ...
 
 Execute esg_grid tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/esg_grid/show-schema.cmd

@@ -0,0 +1,2 @@
+uw esg_grid --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/esg_grid/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "$defs": {
+    "base_file": {
+      "type": "string"
+    },
+    "namelist_content": {
+      "additionalproperties": false,
+      "properties": {
+        "regional_grid_nml": {
+          "additionalProperties": false,
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "esg_grid"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/filter_topo.rst

@@ -52,3 +52,11 @@ Its contents are described in section :ref:`filter_topo_yaml`.
      $ uw filter_topo run --config-file config.yaml --batch --dry-run
 
 .. include:: /shared/key_path.rst
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: filter_topo/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: filter_topo/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/filter_topo/help.out

@@ -1,4 +1,4 @@
-usage: uw filter_topo [-h] [--version] TASK ...
+usage: uw filter_topo [-h] [--version] [--show-schema] TASK ...
 
 Execute filter_topo tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/filter_topo/show-schema.cmd

@@ -0,0 +1,2 @@
+uw filter_topo --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/filter_topo/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "properties": {
+    "filter_topo": {
+      "additionalProperties": false,
+      "properties": {
+        "config": {
+          "additionalProperties": false,
+          "properties": {
+            "input_grid_file": {
+              "type": "string"
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "filter_topo"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/fv3.rst

@@ -53,3 +53,11 @@ The examples use a configuration file named ``config.yaml``. Its contents are de
   .. code-block:: text
 
      $ uw fv3 provisioned_rundir --config-file config.yaml --cycle 2024-02-11T12 --batch
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: fv3/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: fv3/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/fv3/help.out

@@ -1,4 +1,4 @@
-usage: uw fv3 [-h] [--version] TASK ...
+usage: uw fv3 [-h] [--version] [--show-schema] TASK ...
 
 Execute fv3 tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/fv3/show-schema.cmd

@@ -0,0 +1,2 @@
+uw fv3 --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/fv3/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "properties": {
+    "fv3": {
+      "additionalProperties": false,
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "domain": {
+                "const": "regional"
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "fv3"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/global_equiv_resol.rst

@@ -52,3 +52,11 @@ Its contents are described in section :ref:`global_equiv_resol_yaml`.
      $ uw global_equiv_resol run --config-file config.yaml --batch --dry-run
 
 .. include:: /shared/key_path.rst
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: global_equiv_resol/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: global_equiv_resol/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/global_equiv_resol/help.out

@@ -1,4 +1,4 @@
-usage: uw global_equiv_resol [-h] [--version] TASK ...
+usage: uw global_equiv_resol [-h] [--version] [--show-schema] TASK ...
 
 Execute global_equiv_resol tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.cmd

@@ -0,0 +1,2 @@
+uw global_equiv_resol --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/global_equiv_resol/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "properties": {
+    "global_equiv_resol": {
+      "additionalProperties": false,
+      "properties": {
+        "execution": {
+          "additionalProperties": false,
+          "properties": {
+            "batchargs": {
+              "additionalProperties": true,
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "global_equiv_resol"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/ioda.rst

@@ -52,3 +52,11 @@ The driver creates a ``runscript.ioda`` file in the directory specified by ``run
      $ uw ioda run --config-file config.yaml --cycle 2024-05-22T12 --batch --dry-run
 
 .. include:: /shared/key_path.rst
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: ioda/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: ioda/show-schema.out
+   :language: text

docs/sections/user_guide/cli/drivers/ioda/help.out

@@ -1,4 +1,4 @@
-usage: uw ioda [-h] [--version] TASK ...
+usage: uw ioda [-h] [--version] [--show-schema] TASK ...
 
 Execute ioda tasks
 
@@ -7,6 +7,8 @@ Optional arguments:
       Show help and exit
   --version
       Show version info and exit
+  --show-schema
+      Show driver schema and exit
 
 Positional arguments:
   TASK

docs/sections/user_guide/cli/drivers/ioda/show-schema.cmd

@@ -0,0 +1,2 @@
+uw ioda --show-schema >schema
+head schema && echo ... && tail schema

docs/sections/user_guide/cli/drivers/ioda/show-schema.out

@@ -0,0 +1,21 @@
+{
+  "properties": {
+    "ioda": {
+      "additionalProperties": false,
+      "properties": {
+        "configuration_file": {
+          "additionalProperties": false,
+          "anyOf": [
+            {
+              "required": [
+...
+        "rundir"
+      ],
+      "type": "object"
+    }
+  },
+  "required": [
+    "ioda"
+  ],
+  "type": "object"
+}

docs/sections/user_guide/cli/drivers/jedi.rst

@@ -52,3 +52,11 @@ The driver creates a ``runscript.jedi`` file in the directory specified by ``run
      $ uw jedi run --config-file config.yaml --cycle 2024-05-22T12 --batch --dry-run
 
 .. include:: /shared/key_path.rst
+
+* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
+
+.. literalinclude:: jedi/show-schema.cmd
+   :language: text
+   :emphasize-lines: 1
+.. literalinclude:: jedi/show-schema.out
+   :language: text