Skip to content

Fix small documentation errors #12811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 3 commits into from
Jul 9, 2022
Merged

Fix small documentation errors #12811

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
854b59b
fix typo in openapi-generator-maven-plugin readme
mmiikkkkaa Jul 8, 2022
cf3f9c9
fix copy&paste error in spring example pom.xml
mmiikkkkaa Jul 8, 2022
7db1686
fixed copy&paste errors in kotlin example pom.xml
mmiikkkkaa Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/openapi-generator-maven-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ The `key` and `value` text are any values you'd like to provide for that option.
</configuration>
```

Not that some of these environment variable options may overwrite or conflict with other options available to the maven plugin. For example, the above `globalProperties` example is equivalent to the following:
Notice that some of these environment variable options may overwrite or conflict with other options available to the maven plugin. For example, the above `globalProperties` example is equivalent to the following:

```xml
<configuration>
Expand Down
6 changes: 3 additions & 3 deletions modules/openapi-generator-maven-plugin/examples/kotlin.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@
<!-- specify the swagger yaml -->
<inputSpec>${project.basedir}/swagger.yaml</inputSpec>

<!-- target to generate java client code -->
<!-- target to generate kotlin client code -->
<generatorName>kotlin</generatorName>

<!-- hint: if you want to generate java server code, e.g. based on Spring Boot,
you can use the following target: <generatorName>spring</generatorName> -->
<!-- hint: if you want to generate kotlin server code, e.g. based on Spring Boot,
you can use the following generator: <generatorName>kotlin-spring</generatorName> -->

<!-- pass any necessary config options -->
<configOptions>
Expand Down
6 changes: 3 additions & 3 deletions modules/openapi-generator-maven-plugin/examples/spring.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@
<!-- specify the swagger yaml -->
<inputSpec>${project.basedir}/swagger.yaml</inputSpec>

<!-- target to generate java client code -->
<!-- target to generate java server code -->
<generatorName>spring</generatorName>

<!-- hint: if you want to generate java server code, e.g. based on Spring Boot,
you can use the following target: <generatorName>spring</generatorName> -->
<!-- hint: if you want to generate java client code
you can use the following generator: <generatorName>java</generatorName> -->

<!-- pass any necessary config options -->
<configOptions>
Expand Down