Skip to content

Commit 310971d

Browse files
authored
Add enum flag to 7.x docs (#1487)
1 parent 49bbd72 commit 310971d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/cli.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,23 +81,26 @@ resolve:
8181

8282
Refer to the [Redocly docs](https://redocly.com/docs/cli/configuration/#resolve-non-public-or-non-remote-urls) for additional options.
8383

84-
## Options
84+
## Flags
8585

86-
| Option | Alias | Default | Description |
86+
The following flags are supported in the CLI:
87+
88+
| Flag | Alias | Default | Description |
8789
| :------------------------ | :---- | :------: | :------------------------------------------------------------------------------------------------------------------ |
8890
| `--help` | | | Display inline help message and exit |
8991
| `--version` | | | Display this library’s version and exit |
9092
| `--output [location]` | `-o` | (stdout) | Where should the output file be saved? |
9193
| `--redoc [location]` | | | Path to a `redocly.yaml` file (see [Multiple schemas](#multiple-schemas)) |
92-
| `--immutable` | | `false` | Generates immutable types (readonly properties and readonly array) |
9394
| `--additional-properties` | | `false` | Allow arbitrary properties for all schema objects without `additionalProperties: false` |
94-
| `--empty-objects-unknown` | | `false` | Allow arbitrary properties for schema objects with no specified properties, and no specified `additionalProperties` |
95+
| `--alphabetize` | | `false` | Sort types alphabetically |
96+
| `--array-length` | | `false` | Generate tuples using array `minItems` / `maxItems` |
9597
| `--default-non-nullable` | | `false` | Treat schema objects with default values as non-nullable |
98+
| `--empty-objects-unknown` | | `false` | Allow arbitrary properties for schema objects with no specified properties, and no specified `additionalProperties` |
99+
| `--enum` | | `false` | Generate true [TS enums](https://www.typescriptlang.org/docs/handbook/enums.html) rather than string unions. |
100+
| `--exclude-deprecated` | | `false` | Exclude deprecated fields from types |
96101
| `--export-type` | `-t` | `false` | Export `type` instead of `interface` |
102+
| `--immutable` | | `false` | Generates immutable types (readonly properties and readonly array) |
97103
| `--path-params-as-types` | | `false` | Allow dynamic string lookups on the `paths` object |
98-
| `--array-length` | | `false` | Generate tuples using array `minItems` / `maxItems` |
99-
| `--alphabetize` | | `false` | Sort types alphabetically |
100-
| `--exclude-deprecated` | | `false` | Exclude deprecated fields from types |
101104

102105
### pathParamsAsTypes
103106

0 commit comments

Comments
 (0)