Skip to content

Commit e4c3f99

Browse files
mrin9mrin9
committed
generated build
1 parent a5844f9 commit e4c3f99

File tree

9 files changed

+108
-34
lines changed

9 files changed

+108
-34
lines changed

‎dist/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,user-scalable=yes"><title>RapiDoc</title><link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600&display=swap" rel="stylesheet"><link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/default.min.css"><script src="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"></script></head><body><rapi-doc id="thedoc" spec-url="https://petstore.swagger.io/v2/swagger.json" allow-server-selection="false" theme="light" allow-api-list-style-selection="false" regular-font="Open Sans" schema-style="tree" render-style="read" nav-bg-image="./images/sidebar-bg1.png" default-schema-tab="model" nav-bg-image-size="cover" nav-bg-color="#99448844" nav-text-color="#fff" nav-accent-color="#fff" nav-hover-bg-color="#212f4900"></rapi-doc><script src="rapidoc-min.js"></script></body></html>
1+
<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,user-scalable=yes"><title>RapiDoc</title><link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600&display=swap" rel="stylesheet"><link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/default.min.css"><script src="//cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"></script></head><body><rapi-doc id="thedoc" spec-url="./specs/nested-example.yaml" allow-server-selection="false" theme="light" allow-api-list-style-selection="false" regular-font="Open Sans" schema-style="tree" render-style="read" nav-bg-image="./images/sidebar-bg1.png" default-schema-tab="model" nav-bg-image-size="cover" nav-bg-color="#99448844" nav-text-color="#fff" nav-accent-color="#fff" nav-hover-bg-color="#212f4900"></rapi-doc><script src="rapidoc-min.js"></script></body></html>

‎dist/index.html.gz‎

-4 Bytes
Binary file not shown.

‎dist/rapidoc-min.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/rapidoc-min.js.gz‎

30 Bytes
Binary file not shown.

‎dist/report.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/examples/example-with-nested-refs.html‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!doctype html>
2+
<head>
3+
<!-- Global site tag (gtag.js) - Google Analytics -->
4+
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-132775238-1"></script>
5+
<script>
6+
window.dataLayer = window.dataLayer || [];
7+
function gtag(){dataLayer.push(arguments);}
8+
gtag('js', new Date());
9+
10+
gtag('config', 'UA-132775238-1');
11+
</script>
12+
13+
<meta charset="utf-8">
14+
<meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
15+
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600&display=swap" rel="stylesheet">
16+
<script type="text/javascript" src="../rapidoc-min.js"></script>
17+
<style>
18+
rapi-doc{
19+
width:100%;
20+
}
21+
</style>
22+
</head>
23+
<body>
24+
<rapi-doc spec-url="../specs/example-with-nested-refs.yaml"
25+
allow-authentication = "false"
26+
show-info = "false"
27+
show-header = "true"
28+
render-style = "read"
29+
allow-try = "false"
30+
regular-font = 'Open Sans'
31+
default-schema-tab = 'example'
32+
theme = 'light'
33+
bg-color = '#ecf1f7'
34+
text-color = '#133863'
35+
nav-bg-color = '#3f4d67'
36+
nav-text-color = '#a9b7d0'
37+
nav-hover-bg-color = '#333f54'
38+
nav-hover-text-color = '#fff'
39+
nav-accent-color = '#f44236'
40+
primary-color = '#5c7096'
41+
> </rapi-doc>
42+
</body>
43+
</html>

‎docs/list.html‎

Lines changed: 5 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -392,12 +392,16 @@ <h2 style="font-weight:700"> Mix HTML content </h2>
392392
<div style="display:flex; flex-direction: column; margin:20px 32px">
393393
<table class="m-table">
394394
<tr> <th style="text-align:left">List of Test cases</th></tr>
395-
396395
<tr>
397396
<td class="mono-bold">
398397
<a href="./examples/data-types.html"> Data types </a>
399398
</td>
400399
</tr>
400+
<tr>
401+
<td class="mono-bold">
402+
<a href="./examples/example-with-nested-refs.html"> Provide Examples with nested refs </a>
403+
</td>
404+
</tr>
401405
<tr>
402406
<td class="mono-bold">
403407
<a href="./examples/circular.html"> Circular references </a>
@@ -419,32 +423,6 @@ <h2 style="font-weight:700"> Mix HTML content </h2>
419423
<a href="./tests/xxx-of-recursive.html"> Various cases </a>
420424
<span class="gray descr"> Spec containing one-of, all-of with primitive types, recursive models and readonly-attributes </span>
421425
</td></tr>
422-
423-
<tr>
424-
<td class="mono-bold">
425-
<a href="./tests/perf-v2.html"> Large Swagger 2.0 Spec Performance (Bad - browser may become unresponsive ) </a>
426-
<span class="gray descr"> Most of the time is taken by swagger 2 to OpenAPI conversion</span>
427-
</td>
428-
</tr>
429-
<tr>
430-
<td class="mono-bold">
431-
<a href="./tests/perf-v3-read.html">Large OpenAPI 3.0 Spec Performance - Read Mode (Okay - browser wont hang)</a>
432-
<span class="gray descr"> The above spec pre-converted to OpenAPI 3 - (read-mode renders everything in one large page, resulting into very large DOM, the user interactions like expand collapse are not much snappier)</span>
433-
</td>
434-
</tr>
435-
436-
<tr>
437-
<td class="mono-bold">
438-
<a href="./tests/perf-v3-view.html">Large OpenAPI 3.0 Spec Performance - View Mode (Fast)</a>
439-
<span class="gray descr"> view mode - Fast (initial load is quick and user interaction is snappy, DOM is a bit larger than focused mode but very small compared to read mode)</span>
440-
</td>
441-
</tr>
442-
<tr>
443-
<td class="mono-bold">
444-
<a href="./tests/perf-v3-focused.html">Large OpenAPI 3.0 Spec Performance - Focused Mode (Fastest)</a>
445-
<span class="gray descr"> focused mode - Fastest (focused mode loads only the section that user is viewing, resulting into a small DOM footprint and snappier interactions)</span>
446-
</td>
447-
</tr>
448426
</table>
449427
</div>
450428
</body>

‎docs/rapidoc-min.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/specs/example-with-nested-refs.yaml‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
openapi: 3.0.0
2+
info:
3+
title: Providing example in nested refs
4+
version: '1.0'
5+
paths:
6+
/nested-refs-with-example:
7+
get:
8+
summary: List Bank Accounts
9+
responses:
10+
'200':
11+
description: OK
12+
content:
13+
application/json:
14+
schema:
15+
$ref: '#/components/schemas/ListBankAccountsResponse'
16+
components:
17+
schemas:
18+
EditableBankAccountParams:
19+
properties:
20+
name:
21+
type: string
22+
type:
23+
type: string
24+
ReadOnlyBankAccountParams:
25+
properties:
26+
url:
27+
type: string
28+
readOnly: true
29+
current_balance:
30+
type: number
31+
readOnly: true
32+
BankAccount:
33+
title: BankAccount
34+
type: object
35+
allOf:
36+
- $ref: '#/components/schemas/EditableBankAccountParams'
37+
- $ref: '#/components/schemas/ReadOnlyBankAccountParams'
38+
example:
39+
name: 'account-name'
40+
type: StandardBankAccount
41+
url: 'https://api.freeagent.com/v2/bank_accounts/4093'
42+
current_balance: 28742
43+
ListBankAccountsResponse:
44+
title: ListBankAccountsResponse
45+
type: object
46+
properties:
47+
bank_accounts:
48+
type: array
49+
items:
50+
$ref: '#/components/schemas/BankAccount'
51+
tags:
52+
- name: Person
53+
description: Person Datatype

0 commit comments

Comments
 (0)