Skip to content

Commit 9acd79f

Browse files
mrin9mrin9
committed
generated build
1 parent 4f12df2 commit 9acd79f

File tree

7 files changed

+156
-32
lines changed

7 files changed

+156
-32
lines changed

‎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‎

25 Bytes
Binary file not shown.

‎dist/report.html‎

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

‎docs/examples/data-types-simple.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
gtag('config', 'UA-132775238-1');
10+
</script>
11+
<meta charset='utf-8'>
12+
<meta name='viewport' content='width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes'>
13+
<link href="https://fonts.googleapis.com/css?family=Open+Sans:300,600&display=swap" rel="stylesheet">
14+
<script type='text/javascript' src='../rapidoc-min.js'></script>
15+
</head>
16+
<body>
17+
<rapi-doc spec-url="../specs/data-types-simple.yaml"
18+
allow-authentication = "false"
19+
show-info = "false"
20+
show-header = "false"
21+
render-style = "read"
22+
allow-try = "false"
23+
regular-font = 'Open Sans'
24+
> </rapi-doc>
25+
</body>
26+
</html>

‎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/data-types-simple.yaml‎

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -92,26 +92,16 @@ tags:
9292
description: Person Datatype
9393
components:
9494
schemas:
95-
Category:
96-
type: object
97-
properties:
98-
id:
99-
description: Category ID
100-
allOf:
101-
- $ref: '#/components/schemas/Id'
102-
name:
103-
description: Category name
104-
type: string
105-
minLength: 1
106-
Id:
107-
type: integer
108-
format: int64
109-
readOnly: true
11095
Person:
11196
type: object
11297
required:
11398
- name
11499
- photoUrls
100+
example:
101+
name: 'account-name'
102+
type: StandardBankAccount
103+
url: 'https://api.freeagent.com/v2/bank_accounts/4093'
104+
current_balance: 28742
115105
properties:
116106
id:
117107
description: Pet ID
@@ -162,6 +152,22 @@ components:
162152
pattern: '/^\+(?:[0-9]-?){6,14}[0-9]$/'
163153
example: +1-202-555-0192
164154
nullable: true
155+
156+
Category:
157+
type: object
158+
properties:
159+
id:
160+
description: Category ID
161+
allOf:
162+
- $ref: '#/components/schemas/Id'
163+
name:
164+
description: Category name
165+
type: string
166+
minLength: 1
167+
Id:
168+
type: integer
169+
format: int64
170+
readOnly: true
165171
Tag:
166172
type: object
167173
properties:

‎docs/specs/examples.yaml‎

Lines changed: 103 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,37 @@ paths:
125125
type: string
126126
example: |
127127
{
128-
person: {
129-
fullName: {
130-
firstName: Donald,
131-
lastName: Duck
132-
},
133-
age: 10
128+
age: 10,
129+
fullName: {
130+
firstName: Donald,
131+
lastName: Duck
134132
}
135133
}
134+
/example-with-array-1:
135+
get:
136+
summary: Single Example at schema Level
137+
tags:
138+
- Providing Examples
139+
responses:
140+
'200':
141+
description: Successful operation
142+
content:
143+
application/json:
144+
schema:
145+
$ref: "#/components/schemas/ArrayOfInt-1"
146+
/example-with-array-2:
147+
get:
148+
summary: Single Example at schema Level
149+
tags:
150+
- Providing Examples
151+
responses:
152+
'200':
153+
description: Successful operation
154+
content:
155+
application/json:
156+
schema:
157+
$ref: "#/components/schemas/ArrayOfInt-2"
158+
136159
/object-example-for-a-schema:
137160
get:
138161
summary: Single example having invalid JSON, under a Schema
@@ -181,8 +204,19 @@ paths:
181204
application/json:
182205
schema:
183206
$ref: "#/components/schemas/currencies"
184-
185-
/per-field-example:
207+
/example-with-simple-object:
208+
get:
209+
summary: Single Example of Type Array Under a Schema
210+
tags:
211+
- Providing Examples
212+
responses:
213+
'200':
214+
description: An array of currency codes
215+
content:
216+
application/json:
217+
schema:
218+
$ref: "#/components/schemas/PersonObject"
219+
/per-field-example-with-root-as-object:
186220
get:
187221
summary: Field Level example
188222
tags:
@@ -211,6 +245,42 @@ paths:
211245
description: Last name
212246
type: string
213247
example: 'Duck'
248+
dependents:
249+
type: array
250+
items:
251+
type: object
252+
properties:
253+
dependentName:
254+
type: string
255+
relation:
256+
type: string
257+
age:
258+
type: number
259+
/per-field-example-with-root-as-array:
260+
get:
261+
summary: Field Level example
262+
tags:
263+
- Providing Examples
264+
responses:
265+
'200':
266+
description: Successful operation
267+
content:
268+
application/json:
269+
schema:
270+
type: array
271+
items:
272+
type: object
273+
properties:
274+
dependentName:
275+
type: string
276+
relation:
277+
type: string
278+
age:
279+
type: number
280+
example:
281+
dependentName: Natasha
282+
relation: wife
283+
age: 28
214284
/example-with-refs:
215285
get:
216286
summary: When a Schema definition is provided as a ref (provide the example at schema-level)
@@ -237,8 +307,8 @@ paths:
237307
description: Cost in `Indian Rupees`
238308
value: |
239309
{
240-
amount: 10,
241-
currency: USD
310+
amount: 700,
311+
currency: INR
242312
}
243313
/multiple-example-in-request-body:
244314
post:
@@ -294,4 +364,26 @@ components:
294364
- currencyCode: USD
295365
evaluationDate: '2017-07-21T17:32:28Z'
296366
- currencyCode: INR
297-
evaluationDate: '2017-07-21T17:32:28Z'
367+
evaluationDate: '2017-07-21T17:32:28Z'
368+
ArrayOfInt-1:
369+
type: array
370+
items:
371+
type: integer
372+
format: int64
373+
example: [1, 2, 3]
374+
ArrayOfInt-2:
375+
type: array
376+
items:
377+
type: integer
378+
format: int64
379+
example: 1
380+
PersonObject:
381+
type: object
382+
properties:
383+
name:
384+
type: string
385+
age:
386+
type: integer
387+
example:
388+
name: name-1
389+
age: 1

0 commit comments

Comments
 (0)