Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@kay-schecker
kay-schecker authored Mar 17, 2022
1 parent 3e60d0c commit 0f86410
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions apps/generator-cli/src/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,21 @@ Further it is also possible to configure generators, for example:
If `openapi-generator-cli generate` is called without further arguments, then the configuration
is automatically used to generate your code. 🎉


##### Available placeholders
| placeholder | description | example |
|--------------|---------------------------------------------------------------|-------------------------------------------------------|
| name | just file name | auth |
| Name | just file name, but starting with a capital letter | Auth |
| cwd | the current cwd | /Users/some-user/projects/some-project |
| base | file name and extension | auth.yaml |
| path | full path and filename | /Users/some-user/projects/some-project/docs/auth.yaml |
| dir | path without the filename | /Users/some-user/projects/some-project/docs |
| relDir | directory name of file relative to the glob provided | docs |
| relPath | file name and extension of file relative to the glob provided | docs/auth.yaml |
| ext | just file extension | yaml |

### Using custom / private maven registry

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

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


##### Available placeholders
| placeholder | description | example |
|--------------|---------------------------------------------------------------|-------------------------------------------------------|
| name | just file name | auth |
| Name | just file name, but starting with a capital letter | Auth |
| cwd | the current cwd | /Users/some-user/projects/some-project |
| base | file name and extension | auth.yaml |
| path | full path and filename | /Users/some-user/projects/some-project/docs/auth.yaml |
| dir | path without the filename | /Users/some-user/projects/some-project/docs |
| relDir | directory name of file relative to the glob provided | docs |
| relPath | file name and extension of file relative to the glob provided | docs/auth.yaml |
| ext | just file extension | yaml |

## Run specific generators

| cmd | v3.0 runs | v2.0 runs |
Expand Down

0 comments on commit 0f86410

Please sign in to comment.