forked from Mermade/shins
-
Notifications
You must be signed in to change notification settings - Fork 0
/
asyncapi.html
711 lines (628 loc) · 18.8 KB
/
asyncapi.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<title>AsyncAPI Sample v1.0.0</title>
<style>
</style>
<link rel="stylesheet" media="screen" href="pub/css/screen.css">
<link rel="stylesheet" media="print" href="pub/css/print.css">
<link rel="stylesheet" media="screen" href="pub/css/darkula.css">
<script src="source/javascripts/lib/_jquery.js"></script>
<script src="source/javascripts/lib/_jquery.highlight.js"></script>
<script src="source/javascripts/lib/_lunr.js"></script>
<script src="source/javascripts/lib/_imagesloaded.min.js"></script>
<script src="source/javascripts/lib/_energize.js"></script>
<script src="source/javascripts/app/_lang.js"></script>
<script src="source/javascripts/app/_search.js"></script>
<script src="source/javascripts/app/_toc.js"></script>
<script type="text/javascript">
$(function() {
loadToc($('#toc'), '.toc-link', '.toc-list-h2', 10);
setupLanguages($('body').data('languages'));
$('.content').imagesLoaded( function() {
recacheHeights();
refreshToc();
});
});
window.onpopstate = function() {
activateLanguage(getLanguageFromQueryString());
};
</script>
</head>
<body data-languages="["javascript--nodejs","javascript","python","ruby","java","go"]">
<a href="#" id="nav-button">
<span>
NAV
<img src="source/images/navbar.png" class="undefined" alt="Navigation">
</span>
</a>
<div class="toc-wrapper">
<img src="source/images/logo.png" class="logo" alt="Logo">
<div class="lang-selector">
<a href="#" data-language-name="javascript--nodejs">Node.JS</a>
<a href="#" data-language-name="javascript">JavaScript</a>
<a href="#" data-language-name="python">Python</a>
<a href="#" data-language-name="ruby">Ruby</a>
<a href="#" data-language-name="java">Java</a>
<a href="#" data-language-name="go">Go</a>
</div>
<div class="search">
<input type="text" class="search" id="input-search" placeholder="Search">
</div>
<ul class="search-results"></ul>
<div id="toc" class="toc-list-h1">
<ul class="toc-list-h1">
<li>
<a href="#asyncapi-sample-v1-0-0" class="toc-h1 toc-link" data-title="AsyncAPI Sample v1.0.0">AsyncAPI Sample v1.0.0</a>
</li>
<li>
<a href="#user" class="toc-h1 toc-link" data-title="user">user</a>
<ul class="toc-list-h2">
<li>
<a href="#publish-hitch-accounts-1-0-action-user-signup" class="toc-h2 toc-link" data-title="user">publish hitch.accounts.1.0.action.user.signup</a>
</li>
</ul>
</li>
<li>
<a href="#default" class="toc-h1 toc-link" data-title="Default">Default</a>
<ul class="toc-list-h2">
<li>
<a href="#subscribe-hitch-accounts-1-0-event-user-signup" class="toc-h2 toc-link" data-title="Default">subscribe hitch.accounts.1.0.event.user.signup</a>
</li>
</ul>
</li>
<li>
<a href="#schemas" class="toc-h1 toc-link" data-title="Schemas">Schemas</a>
<ul class="toc-list-h2">
<li>
<a href="#id" class="toc-h2 toc-link" data-title="Schemas">id</a>
</li>
<li>
<a href="#username" class="toc-h2 toc-link" data-title="Schemas">username</a>
</li>
<li>
<a href="#datetime" class="toc-h2 toc-link" data-title="Schemas">datetime</a>
</li>
<li>
<a href="#mqttqosheader" class="toc-h2 toc-link" data-title="Schemas">MQTTQoSHeader</a>
</li>
<li>
<a href="#mqttretainheader" class="toc-h2 toc-link" data-title="Schemas">MQTTRetainHeader</a>
</li>
<li>
<a href="#user" class="toc-h2 toc-link" data-title="Schemas">user</a>
</li>
<li>
<a href="#usercreate" class="toc-h2 toc-link" data-title="Schemas">userCreate</a>
</li>
<li>
<a href="#signup" class="toc-h2 toc-link" data-title="Schemas">signup</a>
</li>
</ul>
</li>
</ul>
</div>
<ul class="toc-footer">
<li><a href="https://mermade.github.io/shins/index.html">See OpenAPI example</a></li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<h1 id="asyncapi-sample-v1-0-0">AsyncAPI Sample v1.0.0</h1>
<blockquote>
<p>Scroll down for code samples, example headers and payloads. Select a language for code samples from the tabs above or the mobile navigation menu.</p>
</blockquote>
<p>This is a simple example of an <em>AsyncAPI</em> document.</p>
<p>Base URLs:</p>
<ul>
<li>
<p><a href="mqtt://api.company.com:{port}/{app-id}">mqtt://api.company.com:{port}/{app-id}</a></p>
<ul>
<li>
<p><strong>app-id</strong> - You can find your <code>app-id</code> in our control panel, under the auth tab. Default: demo</p>
</li>
<li>
<p><strong>port</strong> - Default: 5676</p>
<ul>
<li>
<p>5676</p>
</li>
<li>
<p>5677</p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Base Topic: <strong>hitch</strong></p>
<p><a href="You can specify the terms of service here. **It supports Markdown as well.**
">Terms of service</a></p>
<h1 id="user">user</h1>
<h2 id="publish-hitch-accounts-1-0-action-user-signup">publish hitch.accounts.1.0.action.user.signup</h2>
<p>Note: <strong>Deprecated</strong></p>
<blockquote>
<p>Example headers</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"qos"</span>: <span class="hljs-number">1</span>,
<span class="hljs-attr">"retainFlag"</span>: <span class="hljs-literal">false</span>
}
</code></pre>
<blockquote>
<p>Example payload</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"user"</span>: {
<span class="hljs-attr">"full_name"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>
},
<span class="hljs-attr">"signup"</span>: {
<span class="hljs-attr">"method"</span>: <span class="hljs-string">"email"</span>,
<span class="hljs-attr">"datetime"</span>: <span class="hljs-string">"2017-07-31T17:51:21Z"</span>
}
}
</code></pre>
<blockquote>
<p>Code samples</p>
</blockquote>
<pre class="highlight tab tab-javascript--nodejs"><code>app.from.client.send({
<span class="hljs-attr">topic</span>: <span class="hljs-string">'hitch.accounts.1.0.action.user.signup'</span>,
<span class="hljs-attr">payload</span>: { <span class="hljs-attr">user</span>: { <span class="hljs-attr">full_name</span>: <span class="hljs-string">'string'</span>, <span class="hljs-attr">username</span>: <span class="hljs-string">'string'</span> },
<span class="hljs-attr">signup</span>: { <span class="hljs-attr">method</span>: <span class="hljs-string">'email'</span>, <span class="hljs-attr">datetime</span>: <span class="hljs-string">'2017-07-31T17:51:21Z'</span> } }
});
</code></pre>
<pre class="highlight tab tab-javascript"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-ruby"><code><span class="hljs-comment"># Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-python"><code>//Coming soon...
</code></pre>
<pre class="highlight tab tab-java"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-go"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<p><em>Action to sign a user up.</em></p>
<p>Multiline description of what this action does. <strong>It allows Markdown.</strong></p>
<h3 id="headers">Headers</h3>
<h4 id="properties">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>qos</td>
<td>integer(int32)</td>
<td>false</td>
<td>Quality of Service</td>
</tr>
<tr>
<td>retainFlag</td>
<td>boolean</td>
<td>false</td>
<td>This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.</td>
</tr>
</tbody>
</table>
<h3 id="payload">Payload</h3>
<h4 id="properties">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>user</td>
<td><a href="#schemausercreate">userCreate</a></td>
<td>false</td>
<td>No description</td>
</tr>
<tr>
<td>» full_name</td>
<td>string</td>
<td>false</td>
<td>User full name</td>
</tr>
<tr>
<td>» username</td>
<td>string</td>
<td>true</td>
<td>User handle</td>
</tr>
<tr>
<td>signup</td>
<td><a href="#schemasignup">signup</a></td>
<td>false</td>
<td>No description</td>
</tr>
<tr>
<td>» method</td>
<td>string</td>
<td>true</td>
<td>Signup method</td>
</tr>
<tr>
<td>» datetime</td>
<td>string(date-time)</td>
<td>true</td>
<td>Date and Time of the message</td>
</tr>
</tbody>
</table>
<aside class="success">
This operation does not require authentication
</aside>
<h1 id="default">Default</h1>
<h2 id="subscribe-hitch-accounts-1-0-event-user-signup">subscribe hitch.accounts.1.0.event.user.signup</h2>
<blockquote>
<p>Example payload</p>
</blockquote>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"user"</span>: {
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"full_name"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>
},
<span class="hljs-attr">"signup"</span>: {
<span class="hljs-attr">"method"</span>: <span class="hljs-string">"email"</span>,
<span class="hljs-attr">"datetime"</span>: <span class="hljs-string">"2017-07-31T17:51:21Z"</span>
}
}
</code></pre>
<blockquote>
<p>Code samples</p>
</blockquote>
<pre class="highlight tab tab-javascript--nodejs"><code>app.from.client.send({
<span class="hljs-attr">topic</span>: <span class="hljs-string">'hitch.accounts.1.0.event.user.signup'</span>,
<span class="hljs-attr">payload</span>: { <span class="hljs-attr">user</span>: { <span class="hljs-attr">id</span>: <span class="hljs-string">'string'</span>, <span class="hljs-attr">full_name</span>: <span class="hljs-string">'string'</span>, <span class="hljs-attr">username</span>: <span class="hljs-string">'string'</span> },
<span class="hljs-attr">signup</span>: { <span class="hljs-attr">method</span>: <span class="hljs-string">'email'</span>, <span class="hljs-attr">datetime</span>: <span class="hljs-string">'2017-07-31T17:51:21Z'</span> } }
});
</code></pre>
<pre class="highlight tab tab-javascript"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-ruby"><code><span class="hljs-comment"># Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-python"><code>//Coming soon...
</code></pre>
<pre class="highlight tab tab-java"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<pre class="highlight tab tab-go"><code><span class="hljs-comment">//Coming soon...</span>
</code></pre>
<h3 id="payload">Payload</h3>
<h4 id="properties">Properties</h4>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>user</td>
<td><a href="#schemauser">user</a></td>
<td>false</td>
<td>No description</td>
</tr>
<tr>
<td>» id</td>
<td>string</td>
<td>true</td>
<td>Resource identifier</td>
</tr>
<tr>
<td>» full_name</td>
<td>string</td>
<td>false</td>
<td>User full name</td>
</tr>
<tr>
<td>» username</td>
<td>string</td>
<td>true</td>
<td>User handle</td>
</tr>
<tr>
<td>signup</td>
<td><a href="#schemasignup">signup</a></td>
<td>false</td>
<td>No description</td>
</tr>
<tr>
<td>» method</td>
<td>string</td>
<td>true</td>
<td>Signup method</td>
</tr>
<tr>
<td>» datetime</td>
<td>string(date-time)</td>
<td>true</td>
<td>Date and Time of the message</td>
</tr>
</tbody>
</table>
<aside class="success">
This operation does not require authentication
</aside>
<h1 id="schemas">Schemas</h1>
<h2 id="id">id</h2>
<p><a name="schemaid"></a></p>
<pre class="highlight tab tab-json"><code><span class="hljs-string">"string"</span>
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>string</td>
<td>false</td>
<td>Resource identifier</td>
</tr>
</tbody>
</table>
<h2 id="username">username</h2>
<p><a name="schemausername"></a></p>
<pre class="highlight tab tab-json"><code><span class="hljs-string">"string"</span>
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>username</td>
<td>string</td>
<td>false</td>
<td>User handle</td>
</tr>
</tbody>
</table>
<h2 id="datetime">datetime</h2>
<p><a name="schemadatetime"></a></p>
<pre class="highlight tab tab-json"><code><span class="hljs-string">"2017-07-31T17:51:21Z"</span>
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>datetime</td>
<td>string(date-time)</td>
<td>false</td>
<td>Date and Time of the message</td>
</tr>
</tbody>
</table>
<h2 id="mqttqosheader">MQTTQoSHeader</h2>
<p><a name="schemamqttqosheader"></a></p>
<pre class="highlight tab tab-json"><code><span class="hljs-number">1</span>
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>qos</td>
<td>integer(int32)</td>
<td>false</td>
<td>Quality of Service</td>
</tr>
</tbody>
</table>
<h2 id="mqttretainheader">MQTTRetainHeader</h2>
<p><a name="schemamqttretainheader"></a></p>
<pre class="highlight tab tab-json"><code><span class="hljs-literal">false</span>
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>retainFlag</td>
<td>boolean</td>
<td>false</td>
<td>This flag determines if the message will be saved by the broker for the specified topic as last known good value. New clients that subscribe to that topic will receive the last retained message on that topic instantly after subscribing. More on retained messages and best practices in one of the next posts.</td>
</tr>
</tbody>
</table>
<h2 id="user">user</h2>
<p><a name="schemauser"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"full_name"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>
}
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>string</td>
<td>true</td>
<td>Resource identifier</td>
</tr>
<tr>
<td>full_name</td>
<td>string</td>
<td>false</td>
<td>User full name</td>
</tr>
<tr>
<td>username</td>
<td>string</td>
<td>true</td>
<td>User handle</td>
</tr>
</tbody>
</table>
<h2 id="usercreate">userCreate</h2>
<p><a name="schemausercreate"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"full_name"</span>: <span class="hljs-string">"string"</span>,
<span class="hljs-attr">"username"</span>: <span class="hljs-string">"string"</span>
}
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>full_name</td>
<td>string</td>
<td>false</td>
<td>User full name</td>
</tr>
<tr>
<td>username</td>
<td>string</td>
<td>true</td>
<td>User handle</td>
</tr>
</tbody>
</table>
<h2 id="signup">signup</h2>
<p><a name="schemasignup"></a></p>
<pre class="highlight tab tab-json"><code>{
<span class="hljs-attr">"method"</span>: <span class="hljs-string">"email"</span>,
<span class="hljs-attr">"datetime"</span>: <span class="hljs-string">"2017-07-31T17:51:21Z"</span>
}
</code></pre>
<h3 id="properties">Properties</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Required</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>method</td>
<td>string</td>
<td>true</td>
<td>Signup method</td>
</tr>
<tr>
<td>datetime</td>
<td>string(date-time)</td>
<td>true</td>
<td>Date and Time of the message</td>
</tr>
</tbody>
</table>
<h4 id="enumerated-values">Enumerated Values</h4>
<table>
<thead>
<tr>
<th>Property</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>method</td>
<td>email</td>
</tr>
<tr>
<td>method</td>
<td>facebook</td>
</tr>
<tr>
<td>method</td>
<td>twitter</td>
</tr>
<tr>
<td>method</td>
<td>github</td>
</tr>
<tr>
<td>method</td>
<td>google</td>
</tr>
</tbody>
</table>
</div>
<div class="dark-box">
<div class="lang-selector">
<a href="#" data-language-name="javascript--nodejs">Node.JS</a>
<a href="#" data-language-name="javascript">JavaScript</a>
<a href="#" data-language-name="python">Python</a>
<a href="#" data-language-name="ruby">Ruby</a>
<a href="#" data-language-name="java">Java</a>
<a href="#" data-language-name="go">Go</a>
</div>
</div>
</div>
</body>
</html>