Skip to content

Commit 7752008

Browse files
committed
update README
1 parent d0c1f37 commit 7752008

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,16 @@ $ saddlebackOpenapi --help
2020
-i, --input <value> OpenAPI specification, can be a path, url or string content
2121
-o, --output <value> Output directory
2222
-c, --config <value> Path to the config file
23+
-l, --login <value> Login
24+
-p, --password <value> Password
25+
-e, --environment <value> Environment dev | stage | stage2
26+
-s, --service <value> Service 'workflows' | 'event' | 'notifications' | 'core'
2327
-h, --help display help for command
2428
2529
Examples
26-
$ saddlebackOpenapi --input ./spec.json --output ./generated
27-
$ saddlebackOpenapi --config ./openapi.config.json
30+
$ saddlebackOpenApi --input ./spec.json --output ./generated
31+
$ saddlebackOpenApi --config ./openapi.config.json
32+
$ saddlebackOpenApi -o "./folderPath" -l "Login" -p "Password" -e "dev" -s "core"
2833
```
2934

3035
## Config file
@@ -50,6 +55,30 @@ OpenAPI specification, can be a path, url or string content (required in the con
5055

5156
Output directory (required in the config or cmd arguments)
5257

58+
### `login` (autofetch)
59+
- Default: `undefined`
60+
- Type: `string`
61+
62+
Login to saddleback identity server
63+
64+
### `password` (autofetch)
65+
- Default: `undefined`
66+
- Type: `string`
67+
68+
Password to saddleback identity server
69+
70+
### `environment` (autofetch)
71+
- Default: `undefined`
72+
- Type: `'dev' | 'stage' | 'stage2'`
73+
74+
Which Environment should be used for swagger.json
75+
76+
### `service` (autofetch)
77+
- Default: `undefined`
78+
- Type: `'workflows' | 'event' | 'notifications' | 'core'`
79+
80+
Which service should be fetched
81+
5382
### `additionalModelFileExtension`
5483
- Default: `true`
5584
- Type: `boolean`

0 commit comments

Comments
 (0)