Skip to content

Commit ce86e45

Browse files
blueswenblueswen
committed
Update docs
1 parent 1a0c721 commit ce86e45

26 files changed

+86
-47
lines changed

‎demo-mkdocs/docs/demo/openapi-v3.1.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ Support using local OpenAPI Specification file on website.
33
## Markdown
44

55
```html
6-
<swagger-ui src="./openapi-spec/sample.yaml"/>
6+
<swagger-ui src="./openapi-spec/v3.1/non-oauth-scopes.yaml"/>
7+
<swagger-ui src="./openapi-spec/v3.1/webhook-example.yaml"/>
78
```
89

910
## Swagger UI

‎demo-mkdocs/docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
6464
| 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. |
6565
| validatorUrl | String | Default: "none". By default, the validation is disabled. When setting with "https://validator.swagger.io/validator", 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)). |
6666
| extra_css | Array | Default: []. Extra CSS files in your `docs_dir` included in Swagger UI iframe target html file. |
67+
| dark_scheme_name | String | Default: "slate". Custom dark mode scheme name for [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). Check more details on [Material for MkDocs Documents](https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/). |
6768
6869
## How it works
6970

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -367,10 +367,10 @@ <h2 id="markdown">Markdown</h2>
367367
<a href="#__codelineno-0-11" id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="p">&lt;</span><span class="nt">swagger-ui</span> <span class="na">src</span><span class="o">=</span><span class="s">"./openapi-spec/sample.yaml"</span><span class="p">/&gt;</span>
368368
</code></pre></div>
369369
<h2 id="multiple-oas-in-single-swagger-ui">Multiple OAS in single Swagger UI</h2>
370-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="6c9c6150" src="swagger-6c9c6150.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
370+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="a55c422e" src="swagger-a55c422e.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
371371
</p>
372372
<h2 id="other-independent-swagger-ui">Other independent Swagger UI</h2>
373-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="332aed19" src="swagger-332aed19.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
373+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="e7949c7b" src="swagger-e7949c7b.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
374374
</article>
375375
</div>
376376
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
@@ -434,6 +434,8 @@ <h2 id="other-independent-swagger-ui">Other independent Swagger UI</h2>
434434
}
435435
});
436436

437+
const dark_scheme_name = "slate"
438+
437439
window.scheme = document.body.getAttribute("data-md-color-scheme")
438440
const options = {
439441
attributeFilter: ['data-md-color-scheme'],
@@ -446,7 +448,7 @@ <h2 id="other-independent-swagger-ui">Other independent Swagger UI</h2>
446448
for(var i = 0; i < iframe_list.length; i++) {
447449
var ele = iframe_list.item(i);
448450
if (ele) {
449-
if (scheme === "slate") {
451+
if (scheme === dark_scheme_name) {
450452
ele.contentWindow.enable_dark_mode();
451453
} else {
452454
ele.contentWindow.disable_dark_mode();

docs/demo/build-in-multiple/swagger-6c9c6150.html renamed to docs/demo/build-in-multiple/swagger-a55c422e.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@
5858
],
5959
"validatorUrl": "none",
6060
"extra_css": [],
61+
"dark_scheme_name": "slate",
6162
"syntaxHighlight.theme": "agate"
6263

6364
})
@@ -79,7 +80,7 @@
7980
}
8081

8182
const resize_ob = new ResizeObserver(function(entries) {
82-
parent.update_swagger_ui_iframe_height("6c9c6150");
83+
parent.update_swagger_ui_iframe_height("a55c422e");
8384
});
8485

8586
// start observing for resizing

docs/demo/build-in-multiple/swagger-332aed19.html renamed to docs/demo/build-in-multiple/swagger-e7949c7b.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
],
4646
"validatorUrl": "none",
4747
"extra_css": [],
48+
"dark_scheme_name": "slate",
4849
"syntaxHighlight.theme": "agate"
4950

5051
})
@@ -66,7 +67,7 @@
6667
}
6768

6869
const resize_ob = new ResizeObserver(function(entries) {
69-
parent.update_swagger_ui_iframe_height("332aed19");
70+
parent.update_swagger_ui_iframe_height("e7949c7b");
7071
});
7172

7273
// start observing for resizing

‎docs/demo/multiple/index.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -344,9 +344,9 @@ <h2 id="markdown">Markdown</h2>
344344
<a href="#__codelineno-0-3" id="__codelineno-0-3" name="__codelineno-0-3"></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>
345345
</code></pre></div>
346346
<h2 id="swagger-ui">Swagger UI</h2>
347-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="609999a2" src="swagger-609999a2.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
348-
<iframe class="swagger-ui-iframe" frameborder="0" id="dd212d42" src="swagger-dd212d42.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
349-
<iframe class="swagger-ui-iframe" frameborder="0" id="a70d04b1" src="swagger-a70d04b1.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
347+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="445eaa78" src="swagger-445eaa78.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
348+
<iframe class="swagger-ui-iframe" frameborder="0" id="ffa08031" src="swagger-ffa08031.html" style="overflow:hidden;width:100%;" width="100%"></iframe>
349+
<iframe class="swagger-ui-iframe" frameborder="0" id="b0e80296" src="swagger-b0e80296.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
350350
</article>
351351
</div>
352352
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
@@ -410,6 +410,8 @@ <h2 id="swagger-ui">Swagger UI</h2>
410410
}
411411
});
412412

413+
const dark_scheme_name = "slate"
414+
413415
window.scheme = document.body.getAttribute("data-md-color-scheme")
414416
const options = {
415417
attributeFilter: ['data-md-color-scheme'],
@@ -422,7 +424,7 @@ <h2 id="swagger-ui">Swagger UI</h2>
422424
for(var i = 0; i < iframe_list.length; i++) {
423425
var ele = iframe_list.item(i);
424426
if (ele) {
425-
if (scheme === "slate") {
427+
if (scheme === dark_scheme_name) {
426428
ele.contentWindow.enable_dark_mode();
427429
} else {
428430
ele.contentWindow.disable_dark_mode();

docs/demo/static-file/swagger-71d9bf85.html renamed to docs/demo/multiple/swagger-445eaa78.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
],
4646
"validatorUrl": "none",
4747
"extra_css": [],
48+
"dark_scheme_name": "slate",
4849
"syntaxHighlight.theme": "agate"
4950

5051
})
@@ -66,7 +67,7 @@
6667
}
6768

6869
const resize_ob = new ResizeObserver(function(entries) {
69-
parent.update_swagger_ui_iframe_height("71d9bf85");
70+
parent.update_swagger_ui_iframe_height("445eaa78");
7071
});
7172

7273
// start observing for resizing

docs/demo/pet-store-full-width/swagger-fa13c87f.html renamed to docs/demo/multiple/swagger-b0e80296.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
],
4646
"validatorUrl": "none",
4747
"extra_css": [],
48+
"dark_scheme_name": "slate",
4849
"syntaxHighlight.theme": "agate"
4950

5051
})
@@ -66,7 +67,7 @@
6667
}
6768

6869
const resize_ob = new ResizeObserver(function(entries) {
69-
parent.update_swagger_ui_iframe_height("fa13c87f");
70+
parent.update_swagger_ui_iframe_height("b0e80296");
7071
});
7172

7273
// start observing for resizing

docs/demo/multiple/swagger-dd212d42.html renamed to docs/demo/multiple/swagger-ffa08031.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
],
4646
"validatorUrl": "none",
4747
"extra_css": [],
48+
"dark_scheme_name": "slate",
4849
"syntaxHighlight.theme": "agate"
4950

5051
})
@@ -66,7 +67,7 @@
6667
}
6768

6869
const resize_ob = new ResizeObserver(function(entries) {
69-
parent.update_swagger_ui_iframe_height("dd212d42");
70+
parent.update_swagger_ui_iframe_height("ffa08031");
7071
});
7172

7273
// start observing for resizing

‎docs/demo/oauth2/index.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ <h2 id="markdown">Markdown</h2>
392392
<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>
393393
</code></pre></div>
394394
<h2 id="swagger-ui">Swagger UI</h2>
395-
<p><iframe class="swagger-ui-iframe" frameborder="0" id="b3cf5a8c" src="swagger-b3cf5a8c.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
395+
<p><iframe class="swagger-ui-iframe" frameborder="0" id="1a7881f7" src="swagger-1a7881f7.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
396396
</article>
397397
</div>
398398
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
@@ -456,6 +456,8 @@ <h2 id="swagger-ui">Swagger UI</h2>
456456
}
457457
});
458458

459+
const dark_scheme_name = "slate"
460+
459461
window.scheme = document.body.getAttribute("data-md-color-scheme")
460462
const options = {
461463
attributeFilter: ['data-md-color-scheme'],
@@ -468,7 +470,7 @@ <h2 id="swagger-ui">Swagger UI</h2>
468470
for(var i = 0; i < iframe_list.length; i++) {
469471
var ele = iframe_list.item(i);
470472
if (ele) {
471-
if (scheme === "slate") {
473+
if (scheme === dark_scheme_name) {
472474
ele.contentWindow.enable_dark_mode();
473475
} else {
474476
ele.contentWindow.disable_dark_mode();

0 commit comments

Comments
 (0)