Skip to content

docs: fix typo in YAML documentation path description #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+12 −12
Open

docs: fix typo in YAML documentation path description #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
</div>
</li>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
</div>
</li>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -460,7 +460,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
<div class="ulist">
<ul>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
<li>
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
<div class="ulist">
<ul>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
<li>
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/getting-started.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>Getting S
</div>
</li>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/v1/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ <h2 id="getting-started"><a class="anchor" href="#getting-started"></a>2. Gettin
</div>
</li>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
</ul>
</div>
Expand Down Expand Up @@ -431,7 +431,7 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
<div class="ulist">
<ul>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
<li>
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/modules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3 id="_spring_webflux_support"><a class="anchor" href="#_spring_webflux_suppor
<div class="ulist">
<ul>
<li>
<p>Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
<p>Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml</p>
</li>
<li>
<p>Add the library to the list of your project dependencies (No additional configuration is needed)</p>
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This will automatically deploy swagger-ui to a spring-boot application:
** server: The server name or IP
** port: The server port
** context-path: The context path of the application
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml

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

Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ springdoc.api-docs.path=/api-docs

=== Spring WebFlux support

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

[source,xml, subs="attributes+"]
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/v1/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This will automatically deploy swagger-ui to a spring-boot application:
** server: The server name or IP
** port: The server port
** context-path: The context path of the application
* Documentation can be available in yaml format as well, on the following path : /v3/api-docs.yaml
* Documentation will be available in yaml format as well, on the following path : /v3/api-docs.yaml

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

Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/v1/modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ springdoc.api-docs.path=/api-docs

=== Spring WebFlux support

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

[source,xml, subs="attributes+"]
Expand Down