Skip to content

Commit a021d33

Browse files
committed
polish README
1 parent 385e758 commit a021d33

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ openApi {
7474
groupedApiMappings.set(["https://localhost:8080/v3/api-docs/groupA" to "swagger-groupA.json",
7575
"https://localhost:8080/v3/api-docs/groupB" to "swagger-groupB.json"])
7676
customBootRun {
77-
args = ["--spring.profiles.active=different-url"]
77+
args = ["--spring.profiles.active=special"]
7878
}
7979
}
8080
```
@@ -86,21 +86,21 @@ openApi {
8686
| `outputFileName` | The name of the output file with extension | No | openapi.json |
8787
| `waitTimeInSeconds` | Time to wait in seconds for your Spring Boot application to start, before we make calls to `apiDocsUrl` to download the OpenAPI doc | No | 30 seconds |
8888
| `groupedApiMappings` | A map of URLs (from where the OpenAPI docs can be downloaded) to output file names | No | [] |
89-
| `customBootRun` | Any bootRun property that you would normal need to start your spring boot application. | No | "" |
89+
| `customBootRun` | Any bootRun property that you would normal need to start your spring boot application. | No | (N/A) |
9090

9191
### `customBootRun` properties examples
9292
`customBootRun` allows you to send in the properties that might be necessary to allow for the forked spring boot application that gets started
9393
to be able to start (profiles, other custom properties, etc.)
94-
`customBootRun` allows you can specify bootRun style parameter, such as `args`, `jvmArgs`, `systemProperties`, `workingDir`.
94+
`customBootRun` allows you can specify bootRun style parameter, such as `args`, `jvmArgs`, `systemProperties` and `workingDir`.
9595
If you don't specify `customBootRun` parameter, this plugin uses the parameter specified to `bootRun` in Spring Boot Gradle Plugin.
9696

9797
#### Passing static args
9898
This allows for you to be able to just send the static properties when executing Spring application in `generateOpenApiDocs`.
9999
```
100100
openApi {
101101
customBootRun {
102-
args = ["--spring.profiles.active=different-url"]
103-
}
102+
args = ["--spring.profiles.active=special"]
103+
}
104104
}
105105
```
106106

@@ -114,7 +114,7 @@ and as long as the config looks as follows that value will be passed into the fo
114114
openApi {
115115
customBootRun {
116116
systemProperties = System.properties
117-
}
117+
}
118118
}
119119
```
120120

0 commit comments

Comments
 (0)