You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ openApi {
74
74
groupedApiMappings.set(["https://localhost:8080/v3/api-docs/groupA" to "swagger-groupA.json",
75
75
"https://localhost:8080/v3/api-docs/groupB" to "swagger-groupB.json"])
76
76
customBootRun {
77
-
args = ["--spring.profiles.active=different-url"]
77
+
args = ["--spring.profiles.active=special"]
78
78
}
79
79
}
80
80
```
@@ -86,21 +86,21 @@ openApi {
86
86
|`outputFileName`| The name of the output file with extension | No | openapi.json |
87
87
|`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 |
88
88
|`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)|
90
90
91
91
### `customBootRun` properties examples
92
92
`customBootRun` allows you to send in the properties that might be necessary to allow for the forked spring boot application that gets started
93
93
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`.
95
95
If you don't specify `customBootRun` parameter, this plugin uses the parameter specified to `bootRun` in Spring Boot Gradle Plugin.
96
96
97
97
#### Passing static args
98
98
This allows for you to be able to just send the static properties when executing Spring application in `generateOpenApiDocs`.
99
99
```
100
100
openApi {
101
101
customBootRun {
102
-
args = ["--spring.profiles.active=different-url"]
103
-
}
102
+
args = ["--spring.profiles.active=special"]
103
+
}
104
104
}
105
105
```
106
106
@@ -114,7 +114,7 @@ and as long as the config looks as follows that value will be passed into the fo
0 commit comments