Skip to content

Commit 0ac55ef

Browse files
bnasslahsenbnasslahsen
committed
docs update
1 parent 2b7e02e commit 0ac55ef

17 files changed

+217
-102
lines changed

‎docs/core-properties.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
135135
</tr>
136136
<tr>
137-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
137+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].display-name</p></td>
138138
<td class="tableblock halign-left valign-top"></td>
139139
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
140140
</tr>
@@ -254,7 +254,7 @@
254254
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To Choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
255255
</tr>
256256
<tr>
257-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-paramObject</p></td>
257+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-param-object</p></td>
258258
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
259259
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default flatten parameter.</p></td>
260260
</tr>
@@ -269,7 +269,7 @@
269269
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default Enable Support for nullable request parameters in Kotlin.</p></td>
270270
</tr>
271271
<tr>
272-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoint</p></td>
272+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoints</p></td>
273273
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
274274
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
275275
</tr>
@@ -278,7 +278,7 @@
278278
</div>
279279
<div id="footer">
280280
<div id="footer-text">
281-
Last updated 2023-03-07 21:44:57 +0100
281+
Last updated 2023-04-02 00:44:12 +0200
282282
</div>
283283
</div>
284284
</div>

‎docs/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1375,7 +1375,7 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
13751375
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
13761376
</tr>
13771377
<tr>
1378-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
1378+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].display-name</p></td>
13791379
<td class="tableblock halign-left valign-top"></td>
13801380
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
13811381
</tr>
@@ -1495,7 +1495,7 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
14951495
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To Choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
14961496
</tr>
14971497
<tr>
1498-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-paramObject</p></td>
1498+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-param-object</p></td>
14991499
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
15001500
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default flatten parameter.</p></td>
15011501
</tr>
@@ -1510,7 +1510,7 @@ <h3 id="springdoc-openapi-core-properties"><a class="anchor" href="#springdoc-op
15101510
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default Enable Support for nullable request parameters in Kotlin.</p></td>
15111511
</tr>
15121512
<tr>
1513-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoint</p></td>
1513+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoints</p></td>
15141514
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
15151515
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
15161516
</tr>
@@ -2091,7 +2091,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
20912091
return GroupedOpenApi.builder()
20922092
.group("springshop-admin")
20932093
.pathsToMatch("/admin/**")
2094-
.addMethodFilter(method -&gt; method.isAnnotationPresent(Admin.class))
2094+
.addOpenApiMethodFilter(method -&gt; method.isAnnotationPresent(Admin.class))
20952095
.build();
20962096
}
20972097
</code></pre>

‎docs/migrating-from-springfox.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
143143
return GroupedOpenApi.builder()
144144
.group("springshop-admin")
145145
.pathsToMatch("/admin/**")
146-
.addMethodFilter(method -&gt; method.isAnnotationPresent(Admin.class))
146+
.addOpenApiMethodFilter(method -&gt; method.isAnnotationPresent(Admin.class))
147147
.build();
148148
}
149149
</code></pre>
@@ -220,7 +220,7 @@ <h2 id="migrating-from-springfox"><a class="anchor" href="#migrating-from-spring
220220
</div>
221221
<div id="footer">
222222
<div id="footer-text">
223-
Last updated 2022-08-15 16:50:02 +0200
223+
Last updated 2023-04-02 00:47:06 +0200
224224
</div>
225225
</div>
226226
</div>

‎docs/properties.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
142142
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
143143
</tr>
144144
<tr>
145-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
145+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].display-name</p></td>
146146
<td class="tableblock halign-left valign-top"></td>
147147
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
148148
</tr>
@@ -262,7 +262,7 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
262262
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To Choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
263263
</tr>
264264
<tr>
265-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-paramObject</p></td>
265+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-param-object</p></td>
266266
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
267267
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default flatten parameter.</p></td>
268268
</tr>
@@ -277,7 +277,7 @@ <h3 id="_springdoc_openapi_core_properties"><a class="anchor" href="#_springdoc_
277277
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default Enable Support for nullable request parameters in Kotlin.</p></td>
278278
</tr>
279279
<tr>
280-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoint</p></td>
280+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoints</p></td>
281281
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
282282
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
283283
</tr>

‎docs/v2/core-properties.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@
134134
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The group name</p></td>
135135
</tr>
136136
<tr>
137-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].displayName</p></td>
137+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.group-configs[0].display-name</p></td>
138138
<td class="tableblock halign-left valign-top"></td>
139139
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>.The display name of the group.</p></td>
140140
</tr>
@@ -279,7 +279,7 @@
279279
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code>. To Choose <code>OpenAPI 3.0</code> or <code>OpenAPI 3.1</code> (using the value <code>OPENAPI_3_1</code>).</p></td>
280280
</tr>
281281
<tr>
282-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-paramObject</p></td>
282+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.default-flat-param-object</p></td>
283283
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
284284
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default flatten parameter.</p></td>
285285
</tr>
@@ -294,7 +294,7 @@
294294
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To default Enable Support for nullable request parameters in Kotlin.</p></td>
295295
</tr>
296296
<tr>
297-
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoint</p></td>
297+
<td class="tableblock halign-left valign-top"><p class="tableblock">springdoc.show-oauth2-endpoints</p></td>
298298
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
299299
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code>. To make spring security oauth2-endpoint visible.</p></td>
300300
</tr>
@@ -303,7 +303,7 @@
303303
</div>
304304
<div id="footer">
305305
<div id="footer-text">
306-
Last updated 2023-03-29 00:59:36 +0200
306+
Last updated 2023-04-02 00:44:12 +0200
307307
</div>
308308
</div>
309309
</div>

‎docs/v2/demos.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
7070
<div class="ulist">
7171
<ul>
7272
<li>
73-
<p><a href="https://github.com/springdoc/springdoc-openapi-demos.git" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos.git</a></p>
73+
<p><a href="https://github.com/springdoc/springdoc-openapi-demos/tree/2.x" target="_blank" rel="noopener">https://github.com/springdoc/springdoc-openapi-demos/tree/2.x</a></p>
7474
</li>
7575
</ul>
7676
</div>
@@ -80,7 +80,7 @@ <h3 id="_source_code_of_the_demo_applications"><a class="anchor" href="#_source_
8080
</div>
8181
<div id="footer">
8282
<div id="footer-text">
83-
Last updated 2022-11-24 23:36:43 +0100
83+
Last updated 2023-04-02 00:44:55 +0200
8484
</div>
8585
</div>
8686
</div>

‎docs/v2/faq.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,23 @@ <h3 id="_how_can_i_ignore_authenticationprincipal_parameter_from_spring_security
331331
<p>A solution workaround would be to use: <code>@Parameter(hidden = true)</code></p>
332332
</li>
333333
<li>
334-
<p>For a project that uses <code>spring-security</code>, you should add <code>springdoc-openapi-starter-common</code>:</p>
334+
<p>The projects that use <code>spring-boot-starter-security</code> or <code>spring-security-oauth2-authorization-server</code> should use:</p>
335+
<div class="ulist">
336+
<ul>
337+
<li>
338+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
339+
</li>
340+
<li>
341+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
342+
</li>
343+
<li>
344+
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
345+
</li>
346+
<li>
347+
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
348+
</li>
349+
</ul>
350+
</div>
335351
</li>
336352
</ul>
337353
</div>
@@ -1868,7 +1884,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18681884
</div>
18691885
<div id="footer">
18701886
<div id="footer-text">
1871-
Last updated 2023-04-02 00:10:29 +0200
1887+
Last updated 2023-04-02 01:12:58 +0200
18721888
</div>
18731889
</div>
18741890
</div>

0 commit comments

Comments
 (0)