You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/USAGE.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,10 @@
22
22
-`[--overrides <file path>]`: Load an additional file to override parts of the original Open API file.
23
23
- This is most commonly used for malformed OAS files (e.g. missing `required` on a required field) but can be used for anything you want
24
24
-`[--write-merged-to <file path>]`: Write the merged Open API spec to the given file (see `--overrides` for merging).
25
+
-`[--effect-types <effect types>]`: A list of which kind of APIs to generate. Each item should be of the form `package.type`. If `package` is omitted it defaults to `elm/http`. If `type` is omitted it defaults to `cmd,task`. The options for package are: `elm/http`, `dillonkearns/elm-pages`, `lamdera/program-test`. The options for type are: `cmd`, `cmdrisky`, `cmdrecord`, `task`, `taskrisky`, `taskrecord`.
26
+
-`[--server <server>]`: The base URL for the OpenAPI server. If not specified this will be extracted from the OAS or default to root of the web application. You can pass in an object to define multiple servers, like `{"dev": "http://localhost", "prod": "https://example.com"}`. This will add a `server` parameter to functions and define a `Servers` module with your servers. You can pass in an empty object if you have fully dynamic servers.
27
+
-`[--no-elm-format]`: Don't run elm-format on the outputs.
28
+
-`[--keep-going]`: If a route can't be generated, skip it instead of erroring out.
25
29
## Example outputs:
26
30
27
31
Assume we have an OAS file named `my-cool-company-oas.json` and it has a field `"title": "My Coool Company"` and we run the CLI like so
0 commit comments