Skip to content

Commit 61d9ada

Browse files
333fredkerwanp
authored andcommitted
Add enum notes (openapi-ts#1750)
The example in the enum extensions sections of the docs needs to have `--enum` specified on the command line to generate as expected, so I added a note for that so future developers aren't as confused as I was.
1 parent c2fd11e commit 61d9ada

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/advanced.md

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ enum ErrorCode {
6868

6969
:::
7070

71+
To generate in this fashion, `--enum` needs to be specified on the [command line](cli.md#flags).
72+
7173
Alternatively you can use `x-enumNames` and `x-enumDescriptions` ([NSwag/NJsonSchema](https://github.com/RicoSuter/NJsonSchema/wiki/Enums#enum-names-and-descriptions)).
7274

7375
## Styleguide

0 commit comments

Comments
 (0)