Skip to content

Commit c2ddeef

Browse files
mrin9mrin9
committed
Release 7.0.3
1 parent d0c4441 commit c2ddeef

16 files changed

+166
-30
lines changed

‎dist/index.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@
2222

2323
<rapi-doc
2424
id = "thedoc"
25-
spec-url = "./specs/petstore_extended.yaml"
25+
spec-url = "./specs/callback-demo.yaml"
2626
theme = "dark"
2727
render-style = "read"
28-
regular-font = 'Open Sans'
2928
schema-style = 'tree'
3029
goto-path= 'post-/person'
3130
api-key-name = "my-key"

‎dist/index.html.gz‎

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

245 Bytes
Binary file not shown.

‎dist/report.html‎

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

‎docs/examples/callback.html‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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+
<style>
17+
rapi-doc{
18+
width:100%;
19+
}
20+
</style>
21+
</head>
22+
<body>
23+
<rapi-doc spec-url="../specs/callback-demo.yaml" theme="dark" render-style = "read"> </rapi-doc>
24+
</body>
25+
</html>

‎docs/list.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@
145145
<a href="./examples/server-vars.html"> Server Variables </a>
146146
</td>
147147
</tr>
148+
<tr>
149+
<td class="mono-bold">
150+
<a href="./examples/callback.html"> Callbacks </a>
151+
</td>
152+
</tr>
148153
<tr>
149154
<td class="mono-bold">
150155
<a href="./examples/oneof.html"> one-of </a>,

‎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/callback-demo.yaml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
openapi: 3.0.0
2+
info:
3+
title: Callback Example
4+
version: 1.0.0
5+
paths:
6+
/streams:
7+
post:
8+
description: subscribes a client to receive out-of-band data
9+
parameters:
10+
- name: callbackUrl
11+
in: query
12+
required: true
13+
description: |
14+
the location where data will be sent. Must be network accessible
15+
by the source server
16+
schema:
17+
type: string
18+
format: uri
19+
example: https://tonys-server.com
20+
responses:
21+
'201':
22+
description: subscription successfully created
23+
content:
24+
application/json:
25+
schema:
26+
description: subscription information
27+
required:
28+
- subscriptionId
29+
properties:
30+
subscriptionId:
31+
description: this unique identifier allows management of the subscription
32+
type: string
33+
example: 2531329f-fb09-4ef7-887e-84e648214436
34+
callbacks:
35+
# the name `onData` is a convenience locator
36+
onData:
37+
# when data is sent, it will be sent to the `callbackUrl` provided
38+
# when making the subscription PLUS the suffix `/data`
39+
'{$request.query.callbackUrl1}/data':
40+
post:
41+
requestBody:
42+
description: subscription POST payload
43+
content:
44+
application/json:
45+
schema:
46+
type: object
47+
properties:
48+
timestamp:
49+
type: string
50+
format: date-time
51+
userData:
52+
type: string
53+
responses:
54+
'202':
55+
description: |
56+
Your server implementation should return this HTTP status code
57+
if the data was received successfully
58+
'204':
59+
description: |
60+
Your server should return this HTTP status code if no longer interested
61+
in further updates

‎index.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@
2222

2323
<rapi-doc
2424
id = "thedoc"
25-
spec-url = "./specs/petstore_extended.yaml"
25+
spec-url = "./specs/callback-demo.yaml"
2626
theme = "dark"
2727
render-style = "read"
28-
regular-font = 'Open Sans'
2928
schema-style = 'tree'
3029
goto-path= 'post-/person'
3130
api-key-name = "my-key"

0 commit comments

Comments
 (0)