Document CLI flags of mix openapi.spec.json

open-api-spex · Mar 24, 2022 · 6b9f6d3 · 6b9f6d3
1 parent 95c0e96
commit 6b9f6d3
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/lib/mix/tasks/openapi.spec.json.ex b/lib/mix/tasks/openapi.spec.json.ex
@@ -1,6 +1,22 @@
 defmodule Mix.Tasks.Openapi.Spec.Json do
   @moduledoc """
   Serialize the given OpenApi spec module to a JSON file.
+
+  ## Examples
+
+      $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec apispec.json
+      $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec --pretty=true
+      $ mix openapi.spec.json --spec PhoenixAppWeb.ApiSpec --vendor-extensions=false
+
+  ## Command line options
+
+  * `--spec` - The ApiSpec module from which to generate the OpenAPI JSON file
+
+  * `--pretty` - Whether to prettify the generated JSON (defaults to false)
+
+  * `--vendor-extensions` - Whether to include open_api_spex OpenAPI vendor extensions
+    (defaults to true)
+
   """
   use Mix.Task
   require Mix.Generator