Skip to content

Commit 058d782

Browse files
committedApr 21, 2025
docs: fix typo in YAML documentation path description
1 parent b673632 commit 058d782

10 files changed

+12
-12
lines changed
 

‎docs/getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
6969
</div>
7070
</li>
7171
<li>
72-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
72+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
7373
</li>
7474
</ul>
7575
</div>

‎docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
341341
</div>
342342
</li>
343343
<li>
344-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
344+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
345345
</li>
346346
</ul>
347347
</div>
@@ -460,7 +460,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
460460
<div class="ulist">
461461
<ul>
462462
<li>
463-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
463+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
464464
</li>
465465
<li>
466466
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>

‎docs/modules.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
113113
<div class="ulist">
114114
<ul>
115115
<li>
116-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
116+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
117117
</li>
118118
<li>
119119
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>

‎docs/v1/getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
6969
</div>
7070
</li>
7171
<li>
72-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
72+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
7373
</li>
7474
</ul>
7575
</div>

‎docs/v1/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
323323
</div>
324324
</li>
325325
<li>
326-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
326+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
327327
</li>
328328
</ul>
329329
</div>
@@ -431,7 +431,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
431431
<div class="ulist">
432432
<ul>
433433
<li>
434-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
434+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
435435
</li>
436436
<li>
437437
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>

‎docs/v1/modules.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
113113
<div class="ulist">
114114
<ul>
115115
<li>
116-
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
116+
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
117117
</li>
118118
<li>
119119
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>

‎src/docs/asciidoc/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This will automatically deploy swagger-ui to a spring-boot application:
2020
** server: The server name or IP
2121
** port: The server port
2222
** context-path: The context path of the application
23-
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
23+
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml
2424

2525
TIP: For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file: .
2626

‎src/docs/asciidoc/modules.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ springdoc.api-docs.path=/api-docs
3535

3636
=== Spring WebFlux support
3737

38-
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
38+
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml
3939
* Add the library to the list of your project dependencies (No additional configuration is needed)
4040

4141
[source,xml, subs="attributes+"]

‎src/docs/asciidoc/v1/getting-started.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This will automatically deploy swagger-ui to a spring-boot application:
2020
** server: The server name or IP
2121
** port: The server port
2222
** context-path: The context path of the application
23-
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
23+
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml
2424

2525
TIP: For custom path of the swagger documentation in HTML format, add a custom springdoc property, in your spring-boot configuration file: .
2626

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ springdoc.api-docs.path=/api-docs
3535

3636
=== Spring WebFlux support
3737

38-
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
38+
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml
3939
* Add the library to the list of your project dependencies (No additional configuration is needed)
4040

4141
[source,xml, subs="attributes+"]

0 commit comments

Comments
 (0)