Skip to content

Commit 0f86410

Browse files
authored
Update README.md
1 parent 3e60d0c commit 0f86410

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

apps/generator-cli/src/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,21 @@ Further it is also possible to configure generators, for example:
158158
If `openapi-generator-cli generate` is called without further arguments, then the configuration
159159
is automatically used to generate your code. 🎉
160160

161+
162+
##### Available placeholders
163+
164+
| placeholder | description | example |
165+
|--------------|---------------------------------------------------------------|-------------------------------------------------------|
166+
| name | just file name | auth |
167+
| Name | just file name, but starting with a capital letter | Auth |
168+
| cwd | the current cwd | /Users/some-user/projects/some-project |
169+
| base | file name and extension | auth.yaml |
170+
| path | full path and filename | /Users/some-user/projects/some-project/docs/auth.yaml |
171+
| dir | path without the filename | /Users/some-user/projects/some-project/docs |
172+
| relDir | directory name of file relative to the glob provided | docs |
173+
| relPath | file name and extension of file relative to the glob provided | docs/auth.yaml |
174+
| ext | just file extension | yaml |
175+
161176
### Using custom / private maven registry
162177

163178
If you're using a private maven registry you can configure the `downloadUrl` and `queryUrl` like this:
@@ -178,21 +193,6 @@ If you're using a private maven registry you can configure the `downloadUrl` and
178193

179194
If the `version` property param is set it is not necessary to configure the `queryUrl`.
180195

181-
182-
##### Available placeholders
183-
184-
| placeholder | description | example |
185-
|--------------|---------------------------------------------------------------|-------------------------------------------------------|
186-
| name | just file name | auth |
187-
| Name | just file name, but starting with a capital letter | Auth |
188-
| cwd | the current cwd | /Users/some-user/projects/some-project |
189-
| base | file name and extension | auth.yaml |
190-
| path | full path and filename | /Users/some-user/projects/some-project/docs/auth.yaml |
191-
| dir | path without the filename | /Users/some-user/projects/some-project/docs |
192-
| relDir | directory name of file relative to the glob provided | docs |
193-
| relPath | file name and extension of file relative to the glob provided | docs/auth.yaml |
194-
| ext | just file extension | yaml |
195-
196196
## Run specific generators
197197

198198
| cmd | v3.0 runs | v2.0 runs |

0 commit comments

Comments
 (0)