Skip to content

Commit 06862e4

Browse files
bnasslahsenbnasslahsen
committed
improve Kotlin module docs for v2. Fixes #41 
1 parent 14f748f commit 06862e4

File tree

9 files changed

+23
-15
lines changed

9 files changed

+23
-15
lines changed

‎docs/faq.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
684684
</table>
685685
</div>
686686
<div class="paragraph">
687-
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomiser</code> instead.</p>
687+
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomizer</code> instead.</p>
688688
</div>
689689
</div>
690690
<div class="sect2">
@@ -1972,7 +1972,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
19721972
</div>
19731973
<div id="footer">
19741974
<div id="footer-text">
1975-
Last updated 2022-11-25 00:20:49 +0100
1975+
Last updated 2022-11-25 15:05:37 +0100
19761976
</div>
19771977
</div>
19781978
</div>

‎docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3104,7 +3104,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
31043104
</table>
31053105
</div>
31063106
<div class="paragraph">
3107-
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomiser</code> instead.</p>
3107+
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomizer</code> instead.</p>
31083108
</div>
31093109
</div>
31103110
<div class="sect2">

‎docs/v2/faq.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,7 @@ <h3 id="_how_can_i_customise_the_openapi_object"><a class="anchor" href="#_how_c
675675
</table>
676676
</div>
677677
<div class="paragraph">
678-
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomiser</code> instead.</p>
678+
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomizer</code> instead.</p>
679679
</div>
680680
</div>
681681
<div class="sect2">
@@ -1858,7 +1858,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
18581858
</div>
18591859
<div id="footer">
18601860
<div id="footer-text">
1861-
Last updated 2022-11-25 00:20:38 +0100
1861+
Last updated 2022-11-25 15:05:37 +0100
18621862
</div>
18631863
</div>
18641864
</div>

‎docs/v2/index.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -750,10 +750,10 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.9. Kotlin
750750
<div class="ulist">
751751
<ul>
752752
<li>
753-
<p>If you are using spring-web, you should combine the <code>springdoc-openapi-kotlin</code> module with <code>springdoc-openapi-starter-webmvc-ui</code>.</p>
753+
<p>If you are using spring-web, you should only use <code>springdoc-openapi-starter-webmvc-ui</code>.</p>
754754
</li>
755755
<li>
756-
<p>If you are using spring-webflux, you should combine the <code>springdoc-openapi-kotlin</code> module with <code>springdoc-openapi-starter-webflux-ui</code>.</p>
756+
<p>If you are using spring-webflux, you should only use <code>springdoc-openapi-starter-webflux-ui</code>.</p>
757757
</li>
758758
</ul>
759759
</div>
@@ -2055,6 +2055,12 @@ <h2 id="migrating-from-springdoc-v1"><a class="anchor" href="#migrating-from-spr
20552055
<div class="ulist">
20562056
<ul>
20572057
<li>
2058+
<p><code>springdoc-openapi-javadoc</code></p>
2059+
</li>
2060+
<li>
2061+
<p><code>springdoc-openapi-kotlin</code></p>
2062+
</li>
2063+
<li>
20582064
<p><code>springdoc-openapi-data-rest</code></p>
20592065
</li>
20602066
<li>
@@ -3145,7 +3151,7 @@ <h3 id="how-can-i-customise-the-openapi-object"><a class="anchor" href="#how-can
31453151
</table>
31463152
</div>
31473153
<div class="paragraph">
3148-
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomiser</code> instead.</p>
3154+
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomizer</code> instead.</p>
31493155
</div>
31503156
</div>
31513157
<div class="sect2">

‎docs/v2/modules.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -420,10 +420,10 @@ <h3 id="_kotlin_support"><a class="anchor" href="#_kotlin_support"></a>Kotlin su
420420
<div class="ulist">
421421
<ul>
422422
<li>
423-
<p>If you are using spring-web, you should combine the <code>springdoc-openapi-kotlin</code> module with <code>springdoc-openapi-starter-webmvc-ui</code>.</p>
423+
<p>If you are using spring-web, you should only use <code>springdoc-openapi-starter-webmvc-ui</code>.</p>
424424
</li>
425425
<li>
426-
<p>If you are using spring-webflux, you should combine the <code>springdoc-openapi-kotlin</code> module with <code>springdoc-openapi-starter-webflux-ui</code>.</p>
426+
<p>If you are using spring-webflux, you should only use <code>springdoc-openapi-starter-webflux-ui</code>.</p>
427427
</li>
428428
</ul>
429429
</div>
@@ -508,7 +508,7 @@ <h3 id="_javadoc_support"><a class="anchor" href="#_javadoc_support"></a>Javadoc
508508
</div>
509509
<div id="footer">
510510
<div id="footer-text">
511-
Last updated 2022-11-24 23:37:28 +0100
511+
Last updated 2022-11-25 15:08:18 +0100
512512
</div>
513513
</div>
514514
</div>

‎src/docs/asciidoc/faq.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathI
314314

315315
NOTE: This bean `OpenApiCustomizer` will be applied to the Default OpenAPI only.
316316

317-
If you need the `OpenApiCustomizer` to applied to `GroupedOpenApi` as well, then use `GlobalOpenApiCustomiser` instead.
317+
If you need the `OpenApiCustomizer` to applied to `GroupedOpenApi` as well, then use `GlobalOpenApiCustomizer` instead.
318318

319319
=== How can I return an empty content as response?
320320
* It is be possible to handle as return an empty content as response using, one of the following syntaxes:

‎src/docs/asciidoc/v2/faq.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ return openApi -> openApi.getPaths().values().stream().flatMap(pathItem -> pathI
305305

306306
NOTE: This bean `OpenApiCustomizer` will be applied to the Default OpenAPI only.
307307

308-
If you need the `OpenApiCustomizer` to applied to `GroupedOpenApi` as well, then use `GlobalOpenApiCustomiser` instead.
308+
If you need the `OpenApiCustomizer` to applied to `GroupedOpenApi` as well, then use `GlobalOpenApiCustomizer` instead.
309309

310310
=== How can I return an empty content as response?
311311
* It is be possible to handle as return an empty content as response using, one of the following syntaxes:

‎src/docs/asciidoc/v2/migrating-from-springdoc-v1.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ TIP: Migration tips
4141

4242
The following modules are not anymore needed and can be removed:
4343

44+
- `springdoc-openapi-javadoc`
45+
- `springdoc-openapi-kotlin`
4446
- `springdoc-openapi-data-rest`
4547
- `springdoc-openapi-security`
4648
- `springdoc-openapi-webmvc-core`

‎src/docs/asciidoc/v2/modules.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ Some code samples are available on GITHUB of demos:
197197
For a project that uses Kotlin, you should use `springdoc-openapi-starter-common`.
198198
This dependency improves the support of Kotlin types.
199199

200-
* If you are using spring-web, you should combine the `springdoc-openapi-kotlin` module with `springdoc-openapi-starter-webmvc-ui`.
201-
* If you are using spring-webflux, you should combine the `springdoc-openapi-kotlin` module with `springdoc-openapi-starter-webflux-ui`.
200+
* If you are using spring-web, you should only use `springdoc-openapi-starter-webmvc-ui`.
201+
* If you are using spring-webflux, you should only use `springdoc-openapi-starter-webflux-ui`.
202202

203203
=== Groovy support
204204
For a project that uses Groovy, you should use `springdoc-openapi-starter-common`.

0 commit comments

Comments
 (0)