add OpenAPI generate option to write to file (#919) (#925)

2022-06-21 21:03:19 -04:00
parent 59e5d26b1d
commit 3b231c5fea
4 changed files with 19 additions and 5 deletions
@@ -28,6 +28,12 @@ This will dump the OpenAPI document as YAML to your system's ``stdout``.  To sav

   pygeoapi openapi generate /path/to/my-pygeoapi-config.yml > /path/to/my-pygeoapi-openapi.yml

+You can also write to a file explicitly via the ``--output-file`` option::
+
+.. code-block:: bash
+
+   pygeoapi openapi generate /path/to/my-pygeoapi-config.yml --output-file /path/to/my-pygeoapi-openapi.yml
+
 To generate the OpenAPI document as JSON, run:

 .. code-block:: bash