Skip to content

Commit a515a78

Browse files
committed
Updated Docs after changing git and pom settings to case classes
1 parent fdc7110 commit a515a78

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

  • modules/openapi-generator-mill-plugin

modules/openapi-generator-mill-plugin/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Usage
1212
4. configure 1-n `OpenApiConfig` as sub-modules
1313

1414
```scala
15-
//| mill-version: 1.0.4
15+
//| mill-version: 1.0.6
1616
//| mvnDeps:
17-
//| - org.openapitools:openapi-generator-mill-plugin:7.16.0 # 1.
17+
//| - org.openapitools:openapi-generator-mill-plugin:7.19.0 # 1.
1818

1919
import mill.*
2020

@@ -82,9 +82,7 @@ This works because `generatedSources` expects a list of `PathRef`s which constit
8282
| `generatorName` | target generator name
8383
| `cleanupOutput` | Defines whether the output directory should be cleaned up before generating the output (`false` by default).
8484
| `cleanup` | Defines a task which contains an `Option[Path => Unit]` which is called after the generation completed. Useful for instance to delete generated Types which are already replaced by import/type-mappings. |
85-
| `gitHost` | The git host, e.g. gitlab.com
86-
| `gitUserId` | sets git information of the project
87-
| `gitRepoId` | sets the repo ID (e.g. openapi-generator)
85+
| `gitSettings` | sets Git information of the project (with `host`, `userId` and `repoId`)
8886
| `templateDirectory` | directory with mustache templates
8987
| `engine` | The name of templating engine to use, "mustache" (default) or "handlebars" (beta)
9088
| `auth` | adds authorization headers when fetching the OpenAPI definitions remotely. Pass in a URL-encoded string of `name:header` with a comma separating multiple values
@@ -93,9 +91,7 @@ This works because `generatedSources` expects a list of `PathRef`s which constit
9391
| `modelPackage` | the package to use for generated model objects/classes
9492
| `invokerPackage` | the package to use for the generated invoker objects
9593
| `packageName` | the default package name to use for the generated objects
96-
| `groupId` | sets project information in generated pom.xml/build.gradle or other build script. Language-specific conversions occur in non-jvm generators
97-
| `artifactId` | sets project information in generated pom.xml/build.gradle or other build script. Language-specific conversions occur in non-jvm generators
98-
| `artifactVersion` | sets project information in generated pom.xml/build.gradle or other build script. Language-specific conversions occur in non-jvm generators
94+
| `artifactSettings` | sets project information in generated pom.xml/build.gradle or other build script. Language-specific conversions occur in non-jvm generators
9995
| `library` | library template (sub-template)
10096
| `modelNamePrefix` | Sets the prefix for model classes and enums
10197
| `modelNameSuffix` | Sets the suffix for model classes and enums

0 commit comments

Comments
 (0)