Skip to content

Commit ca4778a

Browse files
mrin9mrin9
committed
updated docs
1 parent 274d422 commit ca4778a

10 files changed

+196
-32
lines changed

‎docs/api.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
<div class="banner" id="banner" style="max-height:255px; overflow:hidden">
6262
<div style="display:flex; justify-content: center; margin-top:20px">
6363
<div style="display:block">
64-
<img id="main-img" class="shadow3 hide-in-mobile" src="./images/light_ss.png" />
64+
<img id="main-img" class="shadow3 hide-in-mobile" style="filter:opacity(0.85)"src="./images/light_ss.png" />
6565
</div>
6666
</div>
6767
</div>

‎docs/examples/default-schema-tab.html‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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/multiple-example.yaml"
25+
allow-authentication = "false"
26+
show-info = "false"
27+
show-header = "false"
28+
render-style = "read"
29+
allow-try = "false"
30+
regular-font = 'Open Sans'
31+
default-schema-tab = 'example'
32+
> </rapi-doc>
33+
</body>
34+
</html>

‎docs/examples/file-upload.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
show-header = "false"
2727
render-style = "read"
2828
regular-font = 'Open Sans'
29-
allow-try = "false"
3029
> </rapi-doc>
3130
</body>
3231
</html>

‎docs/examples/request-body-multiple.html‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
</head>
18+
<body>
19+
<rapi-doc spec-url="../specs/request-body-multiple.yaml"
20+
allow-authentication = "false"
21+
show-info = "false"
22+
show-header = "false"
23+
render-style = "view"
24+
regular-font = 'Open Sans'
25+
> </rapi-doc>
26+
</body>
27+
</html>

‎docs/examples/server-override.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
render-style = "read"
2121
allow-authentication = "false"
2222
show-info = "false"
23-
regular-font="Open Sans"
24-
show-header="false"
23+
regular-font = "Open Sans"
24+
show-header = "false"
2525
> </rapi-doc>
2626
</body>
2727
</html>

‎docs/list.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,13 @@
118118
</div>
119119
</div>
120120

121+
<div class = "container" >
122+
<a href="./examples/default-schema-tab.html"> Schema View </a>
123+
<div class = "c-description" >
124+
Set the default tab in Schema to EXAMPLE insted on MODEL
125+
</div>
126+
</div>
127+
121128
<div class = "container" >
122129
<a href="./examples/navbar-spacing.html">Navigation Item Spacing</a>
123130
<div class = "c-description" >
@@ -225,11 +232,6 @@
225232
<a href="./examples/data-types.html"> Data types </a>
226233
</td>
227234
</tr>
228-
<tr>
229-
<td class="mono-bold">
230-
<a href="./examples/schema-table.html"> Schema style as table </a>
231-
</td>
232-
</tr>
233235
<tr>
234236
<td class="mono-bold">
235237
<a href="./examples/circular.html"> Circular references </a>

‎docs/rapidoc-min.js‎

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

‎docs/specs/arrange-by-tags.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ info:
33
version: 1.0.0
44
title: Aranging Endpoints by Tags
55
description: >
6-
Following OpenAPI spec demonstrates how to arrange order your tags. (even though the paths are defined in random order in the spec but the tags are ordered based on the `tags` section)
6+
Following OpenAPI spec demonstrates how to arrange the paths using tags. (even though the paths are defined in random order in the spec but they are shown in the order as they are defined under `tags` section)
77
8-
- If there are multiple paths inside a tag they can be further sorted use `sort-endpoints-by` propert which accepts `path` or `method`
8+
- If there are multiple paths inside a tag, they can be further sorted. Use `sort-endpoints-by` property which can accept `path` or `method`
99
- If you do not want to specify tag order, but follow certain naming conventions for tags in the spec you may use `sort-tags` property in RapiDoc element to sort tags alphabatically
1010
1111
```

‎docs/specs/file-upload.yaml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ paths:
7676
schema:
7777
type: object
7878
properties:
79-
filename:
79+
name:
80+
type: string
81+
photo:
8082
type: string
8183
format: binary
8284
responses:
@@ -94,7 +96,9 @@ paths:
9496
schema:
9597
type: object
9698
properties:
97-
filename:
99+
name:
100+
type: string
101+
picture:
98102
type: array
99103
items:
100104
type: string

‎docs/specs/request-body-multiple.yaml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
openapi: 3.0.0
2+
info:
3+
title: Request Body
4+
description: Request Body
5+
version: 1.0.0
6+
paths:
7+
/cost:
8+
post:
9+
summary: Multiple Request body
10+
description: Request body with multiple `media types`
11+
requestBody:
12+
description: Even though you can define multiple request bodies, but only one can be submitted
13+
content:
14+
application/json:
15+
schema:
16+
$ref: "#/components/schemas/Cost"
17+
examples:
18+
USD:
19+
description: Cost in `US Dollars`
20+
value: |
21+
{
22+
amount: 10,
23+
currency: USD
24+
}
25+
INR:
26+
description: Cost in `Indian Rupees`
27+
value: |
28+
{
29+
amount: 700,
30+
currency: INR
31+
}
32+
application/xml:
33+
schema:
34+
$ref: "#/components/schemas/Person"
35+
application/text:
36+
schema:
37+
$ref: "#/components/schemas/Person"
38+
examples:
39+
example-1:
40+
value: |
41+
Person:
42+
fullName:
43+
firstName: Mickey
44+
lastName: Mouse
45+
age: 9
46+
hobbies: music, movies
47+
example-2:
48+
value: |
49+
Person:
50+
fullName:
51+
firstName: Donald
52+
lastName: Duck
53+
age: 9
54+
hobbies: swiming, fishing
55+
multipart/form-data:
56+
schema:
57+
$ref: "#/components/schemas/Person"
58+
application/x-www-form-urlencoded:
59+
schema:
60+
$ref: "#/components/schemas/Person"
61+
application/octet-stream:
62+
schema:
63+
$ref: "#/components/schemas/Person"
64+
responses:
65+
200:
66+
description: Register response
67+
components:
68+
schemas:
69+
Person:
70+
type: object
71+
properties:
72+
Name:
73+
type: string
74+
Age:
75+
type: integer
76+
hobbies:
77+
type: array
78+
items:
79+
type: string
80+
Cost:
81+
type: object
82+
properties:
83+
amount:
84+
type: integer
85+
currency:
86+
type: string
87+

0 commit comments

Comments
 (0)