Skip to content

Commit 7fb2523

Browse files
committed
faq link update
1 parent a63c79f commit 7fb2523

File tree

2 files changed

+27
-21
lines changed

2 files changed

+27
-21
lines changed

docs/faq.html

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -924,38 +924,44 @@ <h3 id="_can_i_use_spring_property_with_swagger_annotations">Can I use spring pr
924924
<p>Its also possible to declare security URLs for <code>@OAuthFlow</code>: <code>openIdConnectUrl</code> * <code>authorizationUrl</code> * <code>refreshUrl</code> * <code>tokenUrl</code></p>
925925
</li>
926926
<li>
927-
<p>The support of spring property resolver for <code>@Schema</code>: <code>name</code> * <code>title</code> * <code>description</code> , by setting <code>springdoc.api-docs.resolve-schema-properties</code> to <code>true</code>
928-
=== How can I disable springdoc-openapi cache?</p>
929-
</li>
930-
<li>
931-
<p>By default, the OpenAPI description is calculated once, and then cached.</p>
927+
<p>The support of spring property resolver for <code>@Schema</code>: <code>name</code> * <code>title</code> * <code>description</code> , by setting <code>springdoc.api-docs.resolve-schema-properties</code> to <code>true</code></p>
932928
</li>
929+
</ul>
930+
</div>
931+
</div>
932+
<div class="sect2">
933+
<h3 id="_how_is_server_url_generated">How is server URL generated ?</h3>
934+
<div class="ulist">
935+
<ul>
933936
<li>
934-
<p>Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.</p>
937+
<p>Generating automatically server URL may be useful, if the documentation is not present.</p>
935938
</li>
936939
<li>
937-
<p>In order to disable springdoc cache, you will have to set the following property:</p>
940+
<p>If the server annotations are present, they will be used instead.</p>
938941
</li>
939942
</ul>
940943
</div>
941-
<div class="listingblock">
942-
<div class="content">
943-
<pre>springdoc.cache.disabled= true</pre>
944-
</div>
945-
</div>
946944
</div>
947945
<div class="sect2">
948-
<h3 id="_how_is_server_url_generated">How is server URL generated ?</h3>
946+
<h3 id="_how_can_i_disable_springdoc_openapi_cache">How can I disable springdoc-openapi cache?</h3>
949947
<div class="ulist">
950948
<ul>
951949
<li>
952-
<p>Generating automatically server URL may be useful, if the documentation is not present.</p>
950+
<p>By default, the OpenAPI description is calculated once, and then cached.</p>
953951
</li>
954952
<li>
955-
<p>If the server annotations are present, they will be used instead.</p>
953+
<p>Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.</p>
954+
</li>
955+
<li>
956+
<p>In order to disable springdoc cache, you will have to set the following property:</p>
956957
</li>
957958
</ul>
958959
</div>
960+
<div class="listingblock">
961+
<div class="content">
962+
<pre>springdoc.cache.disabled= true</pre>
963+
</div>
964+
</div>
959965
</div>
960966
<div class="sect2">
961967
<h3 id="_how_can_i_expose_the_api_docs_endpoints_without_using_the_swagger_ui">How can I expose the api-docs endpoints without using the <code>swagger-ui</code>?</h3>
@@ -1613,7 +1619,7 @@ <h3 id="_how_can_i_have_pretty_printed_output_of_the_openapi_specification">How
16131619
</div>
16141620
<div id="footer">
16151621
<div id="footer-text">
1616-
Last updated 2020-12-15 12:55:00 +0100
1622+
Last updated 2021-01-05 19:18:22 +0100
16171623
</div>
16181624
</div>
16191625
<link rel="stylesheet" href="js/highlight/styles/github.min.css">

src/docs/asciidoc/faq.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,11 @@ public OpenAPI customOpenAPI() {
442442
* The support of spring property resolver for `@ApiResponse`: `description`
443443
* Its also possible to declare security URLs for `@OAuthFlow`: `openIdConnectUrl` * `authorizationUrl` * `refreshUrl` * `tokenUrl`
444444
* The support of spring property resolver for `@Schema`: `name` * `title` * `description` , by setting `springdoc.api-docs.resolve-schema-properties` to `true`
445+
446+
=== How is server URL generated ?
447+
* Generating automatically server URL may be useful, if the documentation is not present.
448+
* If the server annotations are present, they will be used instead.
449+
445450
=== How can I disable springdoc-openapi cache?
446451
* By default, the OpenAPI description is calculated once, and then cached.
447452
* Sometimes the same swagger-ui is served behind internal and external proxies. some users want the server URL, to be computed on each http request.
@@ -451,11 +456,6 @@ public OpenAPI customOpenAPI() {
451456
springdoc.cache.disabled= true
452457
----
453458

454-
455-
=== How is server URL generated ?
456-
* Generating automatically server URL may be useful, if the documentation is not present.
457-
* If the server annotations are present, they will be used instead.
458-
459459
=== How can I expose the api-docs endpoints without using the `swagger-ui`?
460460
* You should use the `springdoc-openapi-core` dependency only:
461461

0 commit comments

Comments
 (0)