Skip to content

Commit 2d6686e

Browse files
committed
Release 4.0.0 - Added API search functionality
1 parent 66069a1 commit 2d6686e

19 files changed

+1481
-1446
lines changed

.babelrc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"presets": [
3+
[
4+
"@babel/preset-env",
5+
{ "targets": {"esmodules": true}}
6+
]
7+
],
8+
"plugins": [
9+
["template-html-minifier", {
10+
"modules": {
11+
"lit-html": ["html"],
12+
"lit-element": [
13+
"html",
14+
{"name": "css", "encapsulation": "style"}
15+
],
16+
},
17+
"htmlMinifier": {
18+
"collapseWhitespace": true
19+
}
20+
}]
21+
]
22+
}

dist/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@
6868
>
6969
</rapi-doc>
7070
-->
71-
<rapi-doc spec-url="https://api.apis.guru/v2/specs/azure.com/workloadmonitor-Microsoft.WorkloadMonitor/2018-08-31-preview/swagger.json"
71+
<rapi-doc
72+
spec-url="https://petstore.swagger.io/v2/swagger.json"
7273
layout="row"
7374
theme="light"
74-
show-info="false"
7575
>
7676
</rapi-doc>
7777
<script type="text/javascript" src="rapidoc-min.js"></script></body>

dist/index.html.gz

-54 Bytes
Binary file not shown.

dist/rapidoc-min.js

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

dist/rapidoc-min.js.gz

89 Bytes
Binary file not shown.

dist/rapidoc-min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/rapidoc-min.js.map.gz

-544 Bytes
Binary file not shown.

docs/index.html

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -175,11 +175,13 @@ <h2> Attributes</h2>
175175
<th style="text-align:left">Description </th>
176176
<th class="default-col">Default</th>
177177
</tr>
178+
178179
<tr>
179180
<td class="mono-bold">spec-url </td>
180181
<td class="gray">url of the OpenAPI spec to view </td>
181182
<td>(empty)</td>
182183
</tr>
184+
183185
<tr>
184186
<td class="mono-bold">server</td>
185187
<td class="gray">
@@ -190,26 +192,30 @@ <h2> Attributes</h2>
190192
</td>
191193
<td>(empty)</td>
192194
</tr>
195+
193196
<tr>
194-
<td class="mono-bold">show-authentication</td>
195-
<td class="gray">
196-
Authentication feature, allows the user to select one of the authentication mechanism thats available in the spec.
197-
It can be http-basic, http-bearer or api-key.
198-
If you dont want your users to go through the authentication process, instead want them to use a pre-generated api-key
199-
then you may hide authentication section by setting this attribute to false
200-
and provide the api-key details using various api-key-???? attributes.</td>
201-
<td>true</td>
202-
</tr>
197+
<td class="mono-bold">allow-authentication</td>
198+
<td class="gray">
199+
Authentication feature, allows the user to select one of the authentication mechanism thats available in the spec.
200+
It can be http-basic, http-bearer or api-key.
201+
If you dont want your users to go through the authentication process, instead want them to use a pre-generated api-key
202+
then you may hide authentication section by setting this attribute to false
203+
and provide the api-key details using various api-key-???? attributes.</td>
204+
<td>true</td>
205+
</tr>
206+
203207
<tr>
204208
<td class="mono-bold">api-key-name</td>
205209
<td class="gray">Name of the API key that will be send while trying out the APIs</td>
206210
<td>(empty)</td>
207211
</tr>
212+
208213
<tr>
209214
<td class="mono-bold">api-key-value</td>
210215
<td class="gray">Value of the API key that will be send while trying out the APIs</td>
211216
<td>Authorization</td>
212217
</tr>
218+
213219
<tr>
214220
<td class="mono-bold">api-key-location</td>
215221
<td class="gray">
@@ -218,14 +224,41 @@ <h2> Attributes</h2>
218224
</td>
219225
<td>header</td>
220226
</tr>
227+
221228
<tr>
222-
<td class="mono-bold">show-try</td>
229+
<td class="mono-bold">allow-spec-url-load</td>
230+
<td class="gray">
231+
If set to 'false', user will not be able to load any spec url from the UI.
232+
</td>
233+
<td>true</td>
234+
</tr>
235+
236+
<tr>
237+
<td class="mono-bold">allow-spec-file-load</td>
238+
<td class="gray">
239+
If set to 'false', user will not be able to load any spec file from the local drive.
240+
This attribute is applicable only when the device width is more than 768px, else this feature is not available
241+
</td>
242+
<td>true</td>
243+
</tr>
244+
245+
<tr>
246+
<td class="mono-bold">allow-search</td>
247+
<td class="gray">
248+
If set to 'false', user will not be able to search APIs.
249+
</td>
250+
<td>true</td>
251+
</tr>
252+
253+
<tr>
254+
<td class="mono-bold">allow-try</td>
223255
<td class="gray">
224256
'TRY' feature allows you to make REST calls to the API server.
225257
To disable this feature set it to false
226258
</td>
227259
<td>true</td>
228260
</tr>
261+
229262
<tr>
230263
<td class="mono-bold">show-info</td>
231264
<td class="gray">
@@ -236,52 +269,60 @@ <h2> Attributes</h2>
236269
</td>
237270
<td>true</td>
238271
</tr>
272+
239273
<tr>
240274
<td class="mono-bold">show-header </td>
241275
<td class="gray">show/hide the header.<br/>
242276
If you dont want your user to open any other api spec, other than the current one, then set this attribute to false</td>
243277
<td>true</td>
244278
</tr>
279+
245280
<tr>
246281
<td class="mono-bold">heading-text </td>
247282
<td class="gray">Heading Text on top-left corner </td>
248283
<td>(empty)</td>
249284
</tr>
285+
250286
<tr>
251287
<td class="mono-bold">header-color </td>
252288
<td class="gray">Hex color code for the header's background</td>
253289
<td>#444444</td>
254290
</tr>
291+
255292
<tr>
256293
<td class="mono-bold">primary-color</td>
257294
<td class="gray">Hex color code on various controls such as buttons, tabs </td>
258295
<td>#FF791A</td>
259296
</tr>
297+
260298
<tr>
261299
<td class="mono-bold">regular-font </td>
262300
<td class="gray">Font Name(s) to be used for regular text </td>
263301
<td>rapidoc, Helvetica, Arial</td>
264302
</tr>
303+
265304
<tr>
266305
<td class="mono-bold">mono-font </td>
267306
<td class="gray">Font Name(s) to be used for monospaced text </td>
268307
<td>Monaco, 'Andale Mono', 'Roboto Mono'</td>
269308
</tr>
309+
270310
<tr>
271311
<td class="mono-bold">theme </td>
272312
<td class="gray">light, dark </td>
273313
<td>light</td>
274314
</tr>
315+
275316
<tr>
276317
<td class="mono-bold"> layout </td>
277318
<td class="gray">layout helps in placement of your request/response sections. The allowed values are 'row' or 'column'.
278319
In column layout, request & response sections are placed one below the other,
279320
In row layout request & response sections are placed side by side.
280321
This attribute is applicable only when the device width is more than 768px.
281-
282322
</td>
283323
<td>row</td>
284324
</tr>
325+
285326
</table>
286327
</div>
287328

docs/rapidoc-min.js

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

index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@
6868
>
6969
</rapi-doc>
7070
-->
71-
<rapi-doc spec-url="https://api.apis.guru/v2/specs/azure.com/workloadmonitor-Microsoft.WorkloadMonitor/2018-08-31-preview/swagger.json"
71+
<rapi-doc
72+
spec-url="https://petstore.swagger.io/v2/swagger.json"
7273
layout="row"
7374
theme="light"
74-
show-info="false"
7575
>
7676
</rapi-doc>
7777
</body>

0 commit comments

Comments
 (0)