Skip to content

Commit de082e7

Browse files
blueswenblueswen
committed
Update docs
1 parent 5bb8a7c commit de082e7

24 files changed

+195
-495
lines changed

‎demo-mkdocs/docs/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
5555
| filter | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. |
5656
| syntaxHighlightTheme | String | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night" |
5757
| tryItOutEnabled | Boolean | Default: False. Controls whether the "Try it out" section should be enabled by default. |
58-
| oauth2RedirectUrl | String | Default: [site url]/assets/swagger-ui/oauth2-redirect.html. OAuth redirect URL. |
58+
| oauth2RedirectUrl | String | Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "[https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html](https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html)". OAuth redirect URL. |
5959
| supportedSubmitMethods | Array | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display. |
6060
| validatorUrl | String | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
6161

‎demo-mkdocs/docs/options.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Supported configurations included:
1414
| filter | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. |
1515
| syntaxHighlightTheme | String | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night" |
1616
| tryItOutEnabled | Boolean | Default: False. Controls whether the "Try it out" section should be enabled by default. |
17-
| oauth2RedirectUrl | String | Default: None. OAuth redirect URL. |
17+
| oauth2RedirectUrl | String | Default: Absolute URL of "/assets/swagger-ui/oauth2-redirect.html" relative with site_url in mkdocs.yml or document root path on site without site_url, e.g. "[https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html](https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html)". OAuth redirect URL. |
1818
| supportedSubmitMethods | Array | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display. |
1919
| validatorUrl | String | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
2020

‎docs/404.html‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,6 @@
8888

8989

9090

91-
92-
9391
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
9492
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
9593
<label class="md-overlay" for="__drawer"></label>

‎docs/demo/build-in-multiple/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,10 +229,10 @@ <h2 id="markdown">Markdown</h2>
229229
<a href="#__codelineno-0-5" id="__codelineno-0-5" name="__codelineno-0-5"></a><span class="p">&lt;</span><span class="nt">swagger-ui</span> <span class="na">grouped</span> <span class="na">name</span><span class="o">=</span><span class="s">"Sample Third"</span> <span class="na">src</span><span class="o">=</span><span class="s">"./openapi-spec/sample-third.yaml"</span><span class="p">/&gt;</span>
230230
</code></pre></div>
231231
<h2 id="multiple-oas-in-single-swagger-ui">Multiple OAS in single Swagger UI</h2>
232-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="214bc153" src="swagger-214bc153.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
232+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="ccd02477" src="swagger-ccd02477.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
233233
</p>
234234
<h2 id="other-independent-swagger-ui">Other independent Swagger UI</h2>
235-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="f55d0a45" src="swagger-f55d0a45.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
235+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a5f51b77" src="swagger-a5f51b77.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
236236
</article>
237237
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
238238
</div>

docs/demo/static-file/swagger-6af52adf.html renamed to docs/demo/build-in-multiple/swagger-a5f51b77.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
<meta charset="UTF-8">
66
<title>Swagger UI</title>
77
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
8-
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
8+
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
99
</head>
1010

1111
<body style="overflow:hidden;background: ;">
1212
<div id="swagger-ui"></div>
13-
<script src="../../assets/javascripts//swagger-ui-bundle.js" charset="UTF-8"> </script>
14-
<script src="../../assets/javascripts//swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
13+
<script src="../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
14+
<script src="../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
1515
<script>
1616
window.onload = function () {
1717
window.ui = SwaggerUIBundle({
@@ -24,6 +24,9 @@
2424
url: '../openapi-spec/sample.yaml',
2525

2626

27+
"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
28+
29+
2730
"docExpansion": "list",
2831
"filter": false,
2932
"tryItOutEnabled": false,
@@ -37,8 +40,7 @@
3740
"patch",
3841
"trace"
3942
],
40-
"syntaxHighlight.theme": "agate",
41-
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
43+
"syntaxHighlight.theme": "agate"
4244

4345
})
4446

@@ -51,7 +53,7 @@
5153
}
5254

5355
const resize_ob = new ResizeObserver(function(entries) {
54-
parent.update_swagger_ui_iframe_height("6af52adf");
56+
parent.update_swagger_ui_iframe_height("a5f51b77");
5557
});
5658

5759
// start observing for resize

docs/demo/build-in-multiple/swagger-214bc153.html renamed to docs/demo/build-in-multiple/swagger-ccd02477.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
<meta charset="UTF-8">
66
<title>Swagger UI</title>
77
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
8-
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
8+
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
99
</head>
1010

1111
<body style="overflow:hidden;background: ;">
1212
<div id="swagger-ui"></div>
13-
<script src="../../assets/javascripts//swagger-ui-bundle.js" charset="UTF-8"> </script>
14-
<script src="../../assets/javascripts//swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
13+
<script src="../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
14+
<script src="../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
1515
<script>
1616
window.onload = function () {
1717
window.ui = SwaggerUIBundle({
@@ -37,6 +37,9 @@
3737
layout: "StandaloneLayout",
3838

3939

40+
"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
41+
42+
4043
"docExpansion": "list",
4144
"filter": false,
4245
"tryItOutEnabled": false,
@@ -50,8 +53,7 @@
5053
"patch",
5154
"trace"
5255
],
53-
"syntaxHighlight.theme": "agate",
54-
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
56+
"syntaxHighlight.theme": "agate"
5557

5658
})
5759

@@ -64,7 +66,7 @@
6466
}
6567

6668
const resize_ob = new ResizeObserver(function(entries) {
67-
parent.update_swagger_ui_iframe_height("214bc153");
69+
parent.update_swagger_ui_iframe_height("ccd02477");
6870
});
6971

7072
// start observing for resize

‎docs/demo/multiple/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,8 +213,8 @@ <h2 id="markdown">Markdown</h2>
213213
<a href="#__codelineno-0-2" id="__codelineno-0-2" name="__codelineno-0-2"></a><span class="p">&lt;</span><span class="nt">swagger-ui</span> <span class="na">src</span><span class="o">=</span><span class="s">"https://petstore.swagger.io/v2/swagger.json"</span><span class="p">/&gt;</span>
214214
</code></pre></div>
215215
<h2 id="swagger-ui">Swagger UI</h2>
216-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="7fe4a43e" src="swagger-7fe4a43e.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
217-
<iframe class="swagger-ui-iframe" frameborder="0" id="6a03f9f3" src="swagger-6a03f9f3.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
216+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a7a0437d" src="swagger-a7a0437d.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
217+
<iframe class="swagger-ui-iframe" frameborder="0" id="4060b510" src="swagger-4060b510.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
218218
</article>
219219
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
220220
</div>

docs/demo/multiple/swagger-6a03f9f3.html renamed to docs/demo/multiple/swagger-4060b510.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
<meta charset="UTF-8">
66
<title>Swagger UI</title>
77
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
8-
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
8+
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
99
</head>
1010

1111
<body style="overflow:hidden;background: ;">
1212
<div id="swagger-ui"></div>
13-
<script src="../../assets/javascripts//swagger-ui-bundle.js" charset="UTF-8"> </script>
14-
<script src="../../assets/javascripts//swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
13+
<script src="../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
14+
<script src="../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
1515
<script>
1616
window.onload = function () {
1717
window.ui = SwaggerUIBundle({
@@ -24,6 +24,9 @@
2424
url: 'https://petstore.swagger.io/v2/swagger.json',
2525

2626

27+
"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
28+
29+
2730
"docExpansion": "list",
2831
"filter": false,
2932
"tryItOutEnabled": false,
@@ -37,8 +40,7 @@
3740
"patch",
3841
"trace"
3942
],
40-
"syntaxHighlight.theme": "agate",
41-
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
43+
"syntaxHighlight.theme": "agate"
4244

4345
})
4446

@@ -51,7 +53,7 @@
5153
}
5254

5355
const resize_ob = new ResizeObserver(function(entries) {
54-
parent.update_swagger_ui_iframe_height("6a03f9f3");
56+
parent.update_swagger_ui_iframe_height("4060b510");
5557
});
5658

5759
// start observing for resize

docs/demo/build-in-multiple/swagger-f55d0a45.html renamed to docs/demo/multiple/swagger-a7a0437d.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
<meta charset="UTF-8">
66
<title>Swagger UI</title>
77
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
8-
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
8+
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
99
</head>
1010

1111
<body style="overflow:hidden;background: ;">
1212
<div id="swagger-ui"></div>
13-
<script src="../../assets/javascripts//swagger-ui-bundle.js" charset="UTF-8"> </script>
14-
<script src="../../assets/javascripts//swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
13+
<script src="../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
14+
<script src="../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
1515
<script>
1616
window.onload = function () {
1717
window.ui = SwaggerUIBundle({
@@ -24,6 +24,9 @@
2424
url: '../openapi-spec/sample.yaml',
2525

2626

27+
"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,
28+
29+
2730
"docExpansion": "list",
2831
"filter": false,
2932
"tryItOutEnabled": false,
@@ -37,8 +40,7 @@
3740
"patch",
3841
"trace"
3942
],
40-
"syntaxHighlight.theme": "agate",
41-
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
43+
"syntaxHighlight.theme": "agate"
4244

4345
})
4446

@@ -51,7 +53,7 @@
5153
}
5254

5355
const resize_ob = new ResizeObserver(function(entries) {
54-
parent.update_swagger_ui_iframe_height("f55d0a45");
56+
parent.update_swagger_ui_iframe_height("a7a0437d");
5557
});
5658

5759
// start observing for resize

‎docs/demo/oauth2/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ <h2 id="markdown">Markdown</h2>
262262
<a href="#__codelineno-0-9" id="__codelineno-0-9" name="__codelineno-0-9"></a> <span class="na">usePkceWithAuthorizationCodeGrant</span><span class="o">=</span><span class="s">"false"</span><span class="p">/&gt;</span>
263263
</code></pre></div>
264264
<h2 id="swagger-ui">Swagger UI</h2>
265-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="24d3849a" src="swagger-24d3849a.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
265+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a1e27766" src="swagger-a1e27766.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
266266
</article>
267267
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
268268
</div>

0 commit comments

Comments
 (0)