Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@blueswen
blueswen committed Aug 17, 2022
1 parent 5bb8a7c commit de082e7
Show file tree
Hide file tree
Showing 24 changed files with 195 additions and 495 deletions.
2 changes: 1 addition & 1 deletion demo-mkdocs/docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
| 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. |
| 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" |
| tryItOutEnabled | Boolean | Default: False. Controls whether the "Try it out" section should be enabled by default. |
| oauth2RedirectUrl | String | Default: [site url]/assets/swagger-ui/oauth2-redirect.html. OAuth redirect URL. |
| 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. |
| 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. |
| 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. |
Expand Down
2 changes: 1 addition & 1 deletion demo-mkdocs/docs/options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Supported configurations included:
| 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. |
| 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" |
| tryItOutEnabled | Boolean | Default: False. Controls whether the "Try it out" section should be enabled by default. |
| oauth2RedirectUrl | String | Default: None. OAuth redirect URL. |
| 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. |
| 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. |
| 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. |

Expand Down
2 changes: 0 additions & 2 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,6 @@





<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
Expand Down
4 changes: 2 additions & 2 deletions docs/demo/build-in-multiple/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,10 @@ <h2 id="markdown">Markdown</h2>
<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>
</code></pre></div>
<h2 id="multiple-oas-in-single-swagger-ui">Multiple OAS in single Swagger UI</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="214bc153" src="swagger-214bc153.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="ccd02477" src="swagger-ccd02477.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
</p>
<h2 id="other-independent-swagger-ui">Other independent Swagger UI</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="f55d0a45" src="swagger-f55d0a45.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a5f51b77" src="swagger-a5f51b77.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
</div>
Expand Down
14 changes: 8 additions & 6 deletions docs/demo/static-file/swagger-6af52adf.html → ...o/build-in-multiple/swagger-a5f51b77.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
</head>

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


"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,


"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
Expand All @@ -37,8 +40,7 @@
"patch",
"trace"
],
"syntaxHighlight.theme": "agate",
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
"syntaxHighlight.theme": "agate"

})

Expand All @@ -51,7 +53,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("6af52adf");
parent.update_swagger_ui_iframe_height("a5f51b77");
});

// start observing for resize
Expand Down
14 changes: 8 additions & 6 deletions ...o/build-in-multiple/swagger-214bc153.html → ...o/build-in-multiple/swagger-ccd02477.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
</head>

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


"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,


"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
Expand All @@ -50,8 +53,7 @@
"patch",
"trace"
],
"syntaxHighlight.theme": "agate",
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
"syntaxHighlight.theme": "agate"

})

Expand All @@ -64,7 +66,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("214bc153");
parent.update_swagger_ui_iframe_height("ccd02477");
});

// start observing for resize
Expand Down
4 changes: 2 additions & 2 deletions docs/demo/multiple/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,8 @@ <h2 id="markdown">Markdown</h2>
<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>
</code></pre></div>
<h2 id="swagger-ui">Swagger UI</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="7fe4a43e" src="swagger-7fe4a43e.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
<iframe class="swagger-ui-iframe" frameborder="0" id="6a03f9f3" src="swagger-6a03f9f3.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a7a0437d" src="swagger-a7a0437d.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
<iframe class="swagger-ui-iframe" frameborder="0" id="4060b510" src="swagger-4060b510.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
</div>
Expand Down
14 changes: 8 additions & 6 deletions docs/demo/multiple/swagger-6a03f9f3.html → docs/demo/multiple/swagger-4060b510.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
</head>

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


"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,


"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
Expand All @@ -37,8 +40,7 @@
"patch",
"trace"
],
"syntaxHighlight.theme": "agate",
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
"syntaxHighlight.theme": "agate"

})

Expand All @@ -51,7 +53,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("6a03f9f3");
parent.update_swagger_ui_iframe_height("4060b510");
});

// start observing for resize
Expand Down
14 changes: 8 additions & 6 deletions ...o/build-in-multiple/swagger-f55d0a45.html → docs/demo/multiple/swagger-a7a0437d.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
</head>

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


"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,


"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
Expand All @@ -37,8 +40,7 @@
"patch",
"trace"
],
"syntaxHighlight.theme": "agate",
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
"syntaxHighlight.theme": "agate"

})

Expand All @@ -51,7 +53,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("f55d0a45");
parent.update_swagger_ui_iframe_height("a7a0437d");
});

// start observing for resize
Expand Down
2 changes: 1 addition & 1 deletion docs/demo/oauth2/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ <h2 id="markdown">Markdown</h2>
<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>
</code></pre></div>
<h2 id="swagger-ui">Swagger UI</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="24d3849a" src="swagger-24d3849a.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a1e27766" src="swagger-a1e27766.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
<script>var input,hash=location.hash.slice(1);hash.startsWith("__tabbed_")&&((input=document.getElementById(hash)).checked=!0)</script>
</div>
Expand Down
14 changes: 8 additions & 6 deletions docs/demo/oauth2/swagger-24d3849a.html → docs/demo/oauth2/swagger-a1e27766.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets//swagger-ui-dark.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../assets/stylesheets/swagger-ui-dark.css" />
</head>

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


"oauth2RedirectUrl": new URL("../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,


"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
Expand All @@ -37,8 +40,7 @@
"patch",
"trace"
],
"syntaxHighlight.theme": "agate",
"oauth2RedirectUrl": "https://blueswen.github.io/mkdocs-swagger-ui-tag/assets/swagger-ui/oauth2-redirect.html"
"syntaxHighlight.theme": "agate"

})

Expand All @@ -53,7 +55,7 @@
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("24d3849a");
parent.update_swagger_ui_iframe_height("a1e27766");
});

// start observing for resize
Expand Down
Loading

0 comments on commit de082e7

Please sign in to comment.