Skip to content

Commit acd7bd5

Browse files
mrin9mrin9
committed
Added render-style and schema-style examples comming up in version 6
1 parent e8d23e7 commit acd7bd5

20 files changed

+105
-20
lines changed

‎docs/api.html‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,13 @@ <h2> Attributes</h2>
170170
</td>
171171
<td>true</td>
172172
</tr>
173-
173+
<tr>
174+
<td class="mono-bold right">default-api-server</td>
175+
<td class="gray">
176+
Use this attribute, if you have defined multiple API-Servers defined in the sepc and want to set a default one which will be used while trying out the APIs
177+
</td>
178+
<td>(empty)</td>
179+
</tr>
174180
<tr>
175181
<td class="mono-bold right">allow-api-list-style-selection</td>
176182
<td class="gray">
@@ -226,16 +232,24 @@ <h2> Attributes</h2>
226232
<td class="gray">Font Name(s) to be used for monospaced text </td>
227233
<td>Monaco, 'Andale Mono', 'Roboto Mono'</td>
228234
</tr>
229-
230235
<tr>
231236
<td class="mono-bold right">theme </td>
232237
<td class="gray">light, dark </td>
233238
<td>light</td>
234239
</tr>
235-
240+
<tr>
241+
<td class="mono-bold right">schema-style </td>
242+
<td class="gray">tree, table (there are two different ways to display object-schemas in the responses and request bodies) </td>
243+
<td>tree</td>
244+
</tr>
245+
<tr>
246+
<td class="mono-bold right">render-style </td>
247+
<td class="gray">read, view</td>
248+
<td>view</td>
249+
</tr>
236250
<tr>
237251
<td class="mono-bold right"> layout </td>
238-
<td class="gray">layout helps in placement of your request/response sections. The allowed values are 'row' or 'column'.
252+
<td class="gray">Applicable only when render-style='view' layout helps in placement of your request/response sections. The allowed values are 'row' or 'column'.
239253
In column layout, request & response sections are placed one below the other,
240254
In row layout request & response sections are placed side by side.
241255
This attribute is applicable only when the device width is more than 768px.

‎docs/examples.html‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2> Basic (<a style="font-size:16px" href="./examples/example2.html">DEMO</a>)<
7878
&lt;/head&gt;
7979
&lt;body&gt;
8080
&lt;rapi-doc
81-
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
81+
spec-url = "https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
8282
&gt; &lt;/rapi-doc&gt;
8383
&lt;/body&gt;
8484
&lt;/html&gt;
@@ -89,7 +89,28 @@ <h2 class="section-heading"> Dark Theme (<a style="font-size:16px" href="./examp
8989
<pre class="shadow code-block" ><code class="html" style="border-radius:4px">
9090
&lt;rapi-doc
9191
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
92-
theme="dark"
92+
theme = "dark"
93+
&gt;
94+
&lt;/rapi-doc&gt;
95+
</code></pre>
96+
<br/>
97+
98+
<h2 class="section-heading"> Read Mode (<a style="font-size:16px" href="./examples/read-mode.html">DEMO</a>)</h2>
99+
<pre class="shadow code-block" ><code class="html" style="border-radius:4px">
100+
&lt;rapi-doc
101+
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
102+
render-style = "read"
103+
&gt;
104+
&lt;/rapi-doc&gt;
105+
</code></pre>
106+
<br/>
107+
108+
<h2 class="section-heading"> Schema in Tabular style (<a style="font-size:16px" href="./examples/schema-table.html">DEMO</a>)</h2>
109+
<pre class="shadow code-block" ><code class="html" style="border-radius:4px">
110+
&lt;rapi-doc
111+
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
112+
render-style = "read"
113+
theme = "dark"
93114
&gt;
94115
&lt;/rapi-doc&gt;
95116
</code></pre>
@@ -110,7 +131,7 @@ <h2 class="section-heading"> Change Header Color With Dark Theme (<a style="font
110131
&lt;rapi-doc
111132
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
112133
header-color="#2d87e2"
113-
theme="dark"
134+
theme = "dark"
114135
&gt;
115136
&lt;/rapi-doc&gt;
116137
</code></pre>

‎docs/examples/circular.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
<script type="text/javascript" src="../rapidoc-min.js"></script>
16+
</head>
17+
<body>
18+
<rapi-doc spec-url="../specs/circular.yaml"> </rapi-doc>
19+
</body>
20+
</html>

‎docs/tests/data-types.html‎ renamed to ‎docs/examples/data-types.html‎

File renamed without changes.

‎docs/examples/read-mode.html‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
<script type="text/javascript" src="../rapidoc-min.js"></script>
16+
</head>
17+
<body>
18+
<rapi-doc spec-url = "../specs/petstore_extended.yaml" render-style = "read" > </rapi-doc>
19+
</body>
20+
</html>

‎docs/tests/schema-table.html‎ renamed to ‎docs/examples/schema-table.html‎

File renamed without changes.

‎docs/list.html‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,15 @@
7171
</td>
7272
</tr>
7373
<tr>
74-
<td class="mono-bold">
75-
<a href="./examples/group-by-path.html"> API listing grouped by path </a>
76-
</td>
77-
</tr>
74+
<td class="mono-bold">
75+
<a href="./examples/group-by-path.html"> API listing grouped by path </a>
76+
</td>
77+
</tr>
78+
<tr>
79+
<td class="mono-bold">
80+
<a href="./examples/read-mode.html"> Read Mode </a>
81+
</td>
82+
</tr>
7883
<tr>
7984
<td class="mono-bold">
8085
<a href="./examples/example3.html"> Change Header Color </a>
@@ -144,12 +149,17 @@
144149
</tr>
145150
<tr>
146151
<td class="mono-bold">
147-
<a href="./tests/data-types.html"> various data types </a>
152+
<a href="./examples/data-types.html"> various data types </a>
153+
</td>
154+
</tr>
155+
<tr>
156+
<td class="mono-bold">
157+
<a href="./examples/schema-table.html"> Schema style as table </a>
148158
</td>
149159
</tr>
150160
<tr>
151161
<td class="mono-bold">
152-
<a href="./tests/schema-table.html"> Schema style as table </a>
162+
<a href="./examples/circular.html"> Circular references </a>
153163
</td>
154164
</tr>
155165
<tr>

‎docs/specs/test-specs/large-models.json‎ renamed to ‎docs/specs/large-models.json‎

File renamed without changes.

‎docs/specs/test-specs/long-descriptions.json‎ renamed to ‎docs/specs/long-descriptions.json‎

File renamed without changes.

‎docs/specs/test-specs/long-paths.json‎ renamed to ‎docs/specs/long-paths.json‎

File renamed without changes.

0 commit comments

Comments
 (0)