lazy_api_doc 0.1.6 → 0.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +22 -3
- data/docs/example/api.yml +1355 -0
- data/docs/example/index.html +24 -0
- data/docs/example/layout.yml +14 -0
- data/lib/generators/lazy_api_doc/install_generator.rb +42 -14
- data/lib/lazy_api_doc/generator.rb +22 -15
- data/lib/lazy_api_doc/route_parser.rb +6 -6
- data/lib/lazy_api_doc/variants_parser.rb +2 -2
- data/lib/lazy_api_doc/version.rb +1 -1
- data/lib/lazy_api_doc.rb +92 -51
- data/screenshot.png +0 -0
- metadata +6 -2
@@ -0,0 +1,1355 @@
|
|
1
|
+
---
|
2
|
+
openapi: 3.0.0
|
3
|
+
info:
|
4
|
+
title: App name
|
5
|
+
version: 1.0.0
|
6
|
+
contact:
|
7
|
+
name: User Name
|
8
|
+
email: user@example.com
|
9
|
+
url: https://app.example.com
|
10
|
+
servers:
|
11
|
+
- url: https://app.example.com
|
12
|
+
description: description
|
13
|
+
paths:
|
14
|
+
"/api/v1/price_alerts":
|
15
|
+
post:
|
16
|
+
tags:
|
17
|
+
- price_alerts
|
18
|
+
description: Basic create
|
19
|
+
summary: create
|
20
|
+
parameters: []
|
21
|
+
requestBody:
|
22
|
+
content:
|
23
|
+
application/vnd.api+json:
|
24
|
+
schema:
|
25
|
+
type: object
|
26
|
+
properties:
|
27
|
+
data:
|
28
|
+
type: object
|
29
|
+
properties:
|
30
|
+
type:
|
31
|
+
type: string
|
32
|
+
example: price_alerts
|
33
|
+
attributes:
|
34
|
+
type: object
|
35
|
+
properties:
|
36
|
+
operator:
|
37
|
+
type: string
|
38
|
+
example: lte
|
39
|
+
value:
|
40
|
+
type: integer
|
41
|
+
example: 29
|
42
|
+
webhook_url:
|
43
|
+
type: string
|
44
|
+
example: https://tqyumd.x.pipedream.net?foo=bar
|
45
|
+
security_sa_id:
|
46
|
+
type: integer
|
47
|
+
example: 14
|
48
|
+
required:
|
49
|
+
- operator
|
50
|
+
- value
|
51
|
+
- webhook_url
|
52
|
+
- security_sa_id
|
53
|
+
required:
|
54
|
+
- type
|
55
|
+
- attributes
|
56
|
+
required:
|
57
|
+
- data
|
58
|
+
responses:
|
59
|
+
201:
|
60
|
+
description: Basic create
|
61
|
+
content:
|
62
|
+
application/vnd.api+json; charset=utf-8:
|
63
|
+
schema:
|
64
|
+
type: object
|
65
|
+
properties:
|
66
|
+
data:
|
67
|
+
type: object
|
68
|
+
properties:
|
69
|
+
id:
|
70
|
+
type: string
|
71
|
+
example: '3'
|
72
|
+
type:
|
73
|
+
type: string
|
74
|
+
example: price_alerts
|
75
|
+
attributes:
|
76
|
+
type: object
|
77
|
+
properties:
|
78
|
+
security_sa_id:
|
79
|
+
type: integer
|
80
|
+
example: 14
|
81
|
+
status:
|
82
|
+
type: string
|
83
|
+
example: active
|
84
|
+
operator:
|
85
|
+
type: string
|
86
|
+
example: lte
|
87
|
+
value:
|
88
|
+
type: number
|
89
|
+
example: 29.0
|
90
|
+
webhook_url:
|
91
|
+
type: string
|
92
|
+
example: https://en2tqyumd.x.pipedream.net?foo=bar
|
93
|
+
triggered_at:
|
94
|
+
type: 'null'
|
95
|
+
example:
|
96
|
+
required:
|
97
|
+
- security_sa_id
|
98
|
+
- status
|
99
|
+
- operator
|
100
|
+
- value
|
101
|
+
- webhook_url
|
102
|
+
- triggered_at
|
103
|
+
relationships:
|
104
|
+
type: object
|
105
|
+
properties:
|
106
|
+
security:
|
107
|
+
type: object
|
108
|
+
properties:
|
109
|
+
links:
|
110
|
+
type: object
|
111
|
+
properties:
|
112
|
+
related:
|
113
|
+
type: string
|
114
|
+
example: http://test/api/v1/securities/14
|
115
|
+
required:
|
116
|
+
- related
|
117
|
+
required:
|
118
|
+
- links
|
119
|
+
required:
|
120
|
+
- security
|
121
|
+
required:
|
122
|
+
- id
|
123
|
+
- type
|
124
|
+
- attributes
|
125
|
+
- relationships
|
126
|
+
meta:
|
127
|
+
type: object
|
128
|
+
properties: {}
|
129
|
+
required: []
|
130
|
+
required:
|
131
|
+
- data
|
132
|
+
- meta
|
133
|
+
get:
|
134
|
+
tags:
|
135
|
+
- price_alerts
|
136
|
+
description: Basic fetch
|
137
|
+
summary: index
|
138
|
+
parameters: []
|
139
|
+
responses:
|
140
|
+
200:
|
141
|
+
description: Basic fetch
|
142
|
+
content:
|
143
|
+
application/vnd.api+json; charset=utf-8:
|
144
|
+
schema:
|
145
|
+
type: object
|
146
|
+
properties:
|
147
|
+
data:
|
148
|
+
type: array
|
149
|
+
items:
|
150
|
+
type: object
|
151
|
+
properties:
|
152
|
+
id:
|
153
|
+
type: string
|
154
|
+
example: '1'
|
155
|
+
type:
|
156
|
+
type: string
|
157
|
+
example: price_alerts
|
158
|
+
attributes:
|
159
|
+
type: object
|
160
|
+
properties:
|
161
|
+
security_sa_id:
|
162
|
+
type: integer
|
163
|
+
example: 2
|
164
|
+
status:
|
165
|
+
type: string
|
166
|
+
example: active
|
167
|
+
operator:
|
168
|
+
type: string
|
169
|
+
example: lte
|
170
|
+
value:
|
171
|
+
type: number
|
172
|
+
example: 89.0
|
173
|
+
webhook_url:
|
174
|
+
type: string
|
175
|
+
example: https://enf7v32tqyumd.x.pipedream.net?foo=bar
|
176
|
+
triggered_at:
|
177
|
+
type: 'null'
|
178
|
+
example:
|
179
|
+
required:
|
180
|
+
- security_sa_id
|
181
|
+
- status
|
182
|
+
- operator
|
183
|
+
- value
|
184
|
+
- webhook_url
|
185
|
+
- triggered_at
|
186
|
+
relationships:
|
187
|
+
type: object
|
188
|
+
properties:
|
189
|
+
security:
|
190
|
+
type: object
|
191
|
+
properties:
|
192
|
+
links:
|
193
|
+
type: object
|
194
|
+
properties:
|
195
|
+
related:
|
196
|
+
type: string
|
197
|
+
example: http://test/api/v1/securities/2
|
198
|
+
required:
|
199
|
+
- related
|
200
|
+
required:
|
201
|
+
- links
|
202
|
+
required:
|
203
|
+
- security
|
204
|
+
required:
|
205
|
+
- id
|
206
|
+
- type
|
207
|
+
- attributes
|
208
|
+
- relationships
|
209
|
+
example:
|
210
|
+
- id: '1'
|
211
|
+
type: price_alerts
|
212
|
+
attributes:
|
213
|
+
security_sa_id: 2
|
214
|
+
status: active
|
215
|
+
operator: lte
|
216
|
+
value: 89.0
|
217
|
+
webhook_url: https://enf7v32tqyumd.x.pipedream.net?foo=bar
|
218
|
+
triggered_at:
|
219
|
+
relationships:
|
220
|
+
security:
|
221
|
+
links:
|
222
|
+
related: http://test/api/v1/securities/2
|
223
|
+
- id: '2'
|
224
|
+
type: price_alerts
|
225
|
+
attributes:
|
226
|
+
security_sa_id: 3
|
227
|
+
status: active
|
228
|
+
operator: lte
|
229
|
+
value: 60.0
|
230
|
+
webhook_url: https://enf7v32tqyumd.x.pipedream.net?foo=bar
|
231
|
+
triggered_at:
|
232
|
+
relationships:
|
233
|
+
security:
|
234
|
+
links:
|
235
|
+
related: http://test/api/v1/securities/3
|
236
|
+
meta:
|
237
|
+
type: object
|
238
|
+
properties: {}
|
239
|
+
required: []
|
240
|
+
required:
|
241
|
+
- data
|
242
|
+
- meta
|
243
|
+
"/api/v1/price_alerts/{id}":
|
244
|
+
delete:
|
245
|
+
tags:
|
246
|
+
- price_alerts
|
247
|
+
description: Basic destroy
|
248
|
+
summary: destroy
|
249
|
+
parameters:
|
250
|
+
- in: path
|
251
|
+
required: true
|
252
|
+
name: id
|
253
|
+
schema:
|
254
|
+
type: string
|
255
|
+
example: '4'
|
256
|
+
responses:
|
257
|
+
200:
|
258
|
+
description: Basic destroy
|
259
|
+
content:
|
260
|
+
application/vnd.api+json; charset=utf-8:
|
261
|
+
schema:
|
262
|
+
type: object
|
263
|
+
properties:
|
264
|
+
meta:
|
265
|
+
type: object
|
266
|
+
properties: {}
|
267
|
+
required: []
|
268
|
+
required:
|
269
|
+
- meta
|
270
|
+
get:
|
271
|
+
tags:
|
272
|
+
- price_alerts
|
273
|
+
description: Basic fetch
|
274
|
+
summary: show
|
275
|
+
parameters:
|
276
|
+
- in: path
|
277
|
+
required: true
|
278
|
+
name: id
|
279
|
+
schema:
|
280
|
+
type: string
|
281
|
+
example: '5'
|
282
|
+
responses:
|
283
|
+
200:
|
284
|
+
description: Basic fetch
|
285
|
+
content:
|
286
|
+
application/vnd.api+json; charset=utf-8:
|
287
|
+
schema:
|
288
|
+
type: object
|
289
|
+
properties:
|
290
|
+
data:
|
291
|
+
type: object
|
292
|
+
properties:
|
293
|
+
id:
|
294
|
+
type: string
|
295
|
+
example: '5'
|
296
|
+
type:
|
297
|
+
type: string
|
298
|
+
example: price_alerts
|
299
|
+
attributes:
|
300
|
+
type: object
|
301
|
+
properties:
|
302
|
+
security_sa_id:
|
303
|
+
type: integer
|
304
|
+
example: 25
|
305
|
+
status:
|
306
|
+
type: string
|
307
|
+
example: active
|
308
|
+
operator:
|
309
|
+
type: string
|
310
|
+
example: gte
|
311
|
+
value:
|
312
|
+
type: number
|
313
|
+
example: 48.0
|
314
|
+
webhook_url:
|
315
|
+
type: string
|
316
|
+
example: https://enf7v32tqyumd.x.pipedream.net?foo=bar
|
317
|
+
triggered_at:
|
318
|
+
type: 'null'
|
319
|
+
example:
|
320
|
+
required:
|
321
|
+
- security_sa_id
|
322
|
+
- status
|
323
|
+
- operator
|
324
|
+
- value
|
325
|
+
- webhook_url
|
326
|
+
- triggered_at
|
327
|
+
relationships:
|
328
|
+
type: object
|
329
|
+
properties:
|
330
|
+
security:
|
331
|
+
type: object
|
332
|
+
properties:
|
333
|
+
links:
|
334
|
+
type: object
|
335
|
+
properties:
|
336
|
+
related:
|
337
|
+
type: string
|
338
|
+
example: http://test/api/v1/securities/25
|
339
|
+
required:
|
340
|
+
- related
|
341
|
+
required:
|
342
|
+
- links
|
343
|
+
required:
|
344
|
+
- security
|
345
|
+
required:
|
346
|
+
- id
|
347
|
+
- type
|
348
|
+
- attributes
|
349
|
+
- relationships
|
350
|
+
meta:
|
351
|
+
type: object
|
352
|
+
properties: {}
|
353
|
+
required: []
|
354
|
+
required:
|
355
|
+
- data
|
356
|
+
- meta
|
357
|
+
put:
|
358
|
+
tags:
|
359
|
+
- price_alerts
|
360
|
+
description: Basic update
|
361
|
+
summary: update
|
362
|
+
parameters:
|
363
|
+
- in: path
|
364
|
+
required: true
|
365
|
+
name: id
|
366
|
+
schema:
|
367
|
+
type: string
|
368
|
+
example: '18'
|
369
|
+
responses:
|
370
|
+
200:
|
371
|
+
description: Basic update
|
372
|
+
content:
|
373
|
+
application/vnd.api+json; charset=utf-8:
|
374
|
+
schema:
|
375
|
+
type: object
|
376
|
+
properties:
|
377
|
+
data:
|
378
|
+
type: object
|
379
|
+
properties:
|
380
|
+
id:
|
381
|
+
type: string
|
382
|
+
example: '18'
|
383
|
+
type:
|
384
|
+
type: string
|
385
|
+
example: price_alerts
|
386
|
+
attributes:
|
387
|
+
type: object
|
388
|
+
properties:
|
389
|
+
security_sa_id:
|
390
|
+
type: integer
|
391
|
+
example: 68
|
392
|
+
status:
|
393
|
+
type: string
|
394
|
+
example: active
|
395
|
+
operator:
|
396
|
+
type: string
|
397
|
+
example: lte
|
398
|
+
value:
|
399
|
+
type: number
|
400
|
+
example: 40.0
|
401
|
+
webhook_url:
|
402
|
+
type: string
|
403
|
+
example: https://enf7v32tqyumd.x.pipedream.net?foo=bar
|
404
|
+
triggered_at:
|
405
|
+
type: 'null'
|
406
|
+
example:
|
407
|
+
required:
|
408
|
+
- security_sa_id
|
409
|
+
- status
|
410
|
+
- operator
|
411
|
+
- value
|
412
|
+
- webhook_url
|
413
|
+
- triggered_at
|
414
|
+
relationships:
|
415
|
+
type: object
|
416
|
+
properties:
|
417
|
+
security:
|
418
|
+
type: object
|
419
|
+
properties:
|
420
|
+
links:
|
421
|
+
type: object
|
422
|
+
properties:
|
423
|
+
related:
|
424
|
+
type: string
|
425
|
+
example: http://test/api/v1/securities/68
|
426
|
+
required:
|
427
|
+
- related
|
428
|
+
required:
|
429
|
+
- links
|
430
|
+
required:
|
431
|
+
- security
|
432
|
+
required:
|
433
|
+
- id
|
434
|
+
- type
|
435
|
+
- attributes
|
436
|
+
- relationships
|
437
|
+
meta:
|
438
|
+
type: object
|
439
|
+
properties: {}
|
440
|
+
required: []
|
441
|
+
required:
|
442
|
+
- data
|
443
|
+
- meta
|
444
|
+
"/api/v1/retrievers":
|
445
|
+
post:
|
446
|
+
tags:
|
447
|
+
- retrievers
|
448
|
+
description: Basic create
|
449
|
+
summary: create
|
450
|
+
parameters: []
|
451
|
+
requestBody:
|
452
|
+
content:
|
453
|
+
application/vnd.api+json:
|
454
|
+
schema:
|
455
|
+
type: object
|
456
|
+
properties:
|
457
|
+
data:
|
458
|
+
type: object
|
459
|
+
properties:
|
460
|
+
type:
|
461
|
+
type: string
|
462
|
+
example: retrievers
|
463
|
+
attributes:
|
464
|
+
type: object
|
465
|
+
properties:
|
466
|
+
klass_name:
|
467
|
+
type: string
|
468
|
+
example: xignite_navs_puller
|
469
|
+
symbol:
|
470
|
+
type: string
|
471
|
+
example: SYMBOL17
|
472
|
+
security_id:
|
473
|
+
type: integer
|
474
|
+
example: 54
|
475
|
+
required:
|
476
|
+
- klass_name
|
477
|
+
- symbol
|
478
|
+
- security_id
|
479
|
+
required:
|
480
|
+
- type
|
481
|
+
- attributes
|
482
|
+
required:
|
483
|
+
- data
|
484
|
+
responses:
|
485
|
+
201:
|
486
|
+
description: Basic create
|
487
|
+
content:
|
488
|
+
application/vnd.api+json; charset=utf-8:
|
489
|
+
schema:
|
490
|
+
type: object
|
491
|
+
properties:
|
492
|
+
data:
|
493
|
+
type: object
|
494
|
+
properties:
|
495
|
+
id:
|
496
|
+
type: string
|
497
|
+
example: '30'
|
498
|
+
type:
|
499
|
+
type: string
|
500
|
+
example: retrievers
|
501
|
+
attributes:
|
502
|
+
type: object
|
503
|
+
properties:
|
504
|
+
security_id:
|
505
|
+
type: integer
|
506
|
+
example: 54
|
507
|
+
klass_name:
|
508
|
+
type: string
|
509
|
+
example: xignite_navs_puller
|
510
|
+
symbol:
|
511
|
+
type: string
|
512
|
+
example: SYMBOL17
|
513
|
+
required:
|
514
|
+
- security_id
|
515
|
+
- klass_name
|
516
|
+
- symbol
|
517
|
+
relationships:
|
518
|
+
type: object
|
519
|
+
properties:
|
520
|
+
security:
|
521
|
+
type: object
|
522
|
+
properties:
|
523
|
+
links:
|
524
|
+
type: object
|
525
|
+
properties:
|
526
|
+
related:
|
527
|
+
type: string
|
528
|
+
example: http://test/api/v1/securities/54
|
529
|
+
required:
|
530
|
+
- related
|
531
|
+
required:
|
532
|
+
- links
|
533
|
+
required:
|
534
|
+
- security
|
535
|
+
required:
|
536
|
+
- id
|
537
|
+
- type
|
538
|
+
- attributes
|
539
|
+
- relationships
|
540
|
+
meta:
|
541
|
+
type: object
|
542
|
+
properties: {}
|
543
|
+
required: []
|
544
|
+
required:
|
545
|
+
- data
|
546
|
+
- meta
|
547
|
+
get:
|
548
|
+
tags:
|
549
|
+
- retrievers
|
550
|
+
description: Basic fetch
|
551
|
+
summary: index
|
552
|
+
parameters: []
|
553
|
+
responses:
|
554
|
+
200:
|
555
|
+
description: Basic fetch
|
556
|
+
content:
|
557
|
+
application/vnd.api+json; charset=utf-8:
|
558
|
+
schema:
|
559
|
+
type: object
|
560
|
+
properties:
|
561
|
+
data:
|
562
|
+
type: array
|
563
|
+
items:
|
564
|
+
type: object
|
565
|
+
properties:
|
566
|
+
id:
|
567
|
+
type: string
|
568
|
+
example: '9'
|
569
|
+
type:
|
570
|
+
type: string
|
571
|
+
example: retrievers
|
572
|
+
attributes:
|
573
|
+
type: object
|
574
|
+
properties:
|
575
|
+
security_id:
|
576
|
+
type: integer
|
577
|
+
example: 16
|
578
|
+
klass_name:
|
579
|
+
type: string
|
580
|
+
example: fin_api_puller
|
581
|
+
symbol:
|
582
|
+
type: string
|
583
|
+
example: SYMBOL6
|
584
|
+
required:
|
585
|
+
- security_id
|
586
|
+
- klass_name
|
587
|
+
- symbol
|
588
|
+
relationships:
|
589
|
+
type: object
|
590
|
+
properties:
|
591
|
+
security:
|
592
|
+
type: object
|
593
|
+
properties:
|
594
|
+
links:
|
595
|
+
type: object
|
596
|
+
properties:
|
597
|
+
related:
|
598
|
+
type: string
|
599
|
+
example: http://test/api/v1/securities/16
|
600
|
+
required:
|
601
|
+
- related
|
602
|
+
required:
|
603
|
+
- links
|
604
|
+
required:
|
605
|
+
- security
|
606
|
+
required:
|
607
|
+
- id
|
608
|
+
- type
|
609
|
+
- attributes
|
610
|
+
- relationships
|
611
|
+
example:
|
612
|
+
- id: '9'
|
613
|
+
type: retrievers
|
614
|
+
attributes:
|
615
|
+
security_id: 16
|
616
|
+
klass_name: fin_api_puller
|
617
|
+
symbol: SYMBOL6
|
618
|
+
relationships:
|
619
|
+
security:
|
620
|
+
links:
|
621
|
+
related: http://test/api/v1/securities/16
|
622
|
+
- id: '10'
|
623
|
+
type: retrievers
|
624
|
+
attributes:
|
625
|
+
security_id: 17
|
626
|
+
klass_name: xignite_quote_puller
|
627
|
+
symbol: SYMBOL7
|
628
|
+
relationships:
|
629
|
+
security:
|
630
|
+
links:
|
631
|
+
related: http://test/api/v1/securities/17
|
632
|
+
meta:
|
633
|
+
type: object
|
634
|
+
properties: {}
|
635
|
+
required: []
|
636
|
+
required:
|
637
|
+
- data
|
638
|
+
- meta
|
639
|
+
"/api/v1/retrievers/{id}":
|
640
|
+
delete:
|
641
|
+
tags:
|
642
|
+
- retrievers
|
643
|
+
description: Basic destroy
|
644
|
+
summary: destroy
|
645
|
+
parameters:
|
646
|
+
- in: path
|
647
|
+
required: true
|
648
|
+
name: id
|
649
|
+
schema:
|
650
|
+
type: string
|
651
|
+
example: '31'
|
652
|
+
responses:
|
653
|
+
200:
|
654
|
+
description: Basic destroy
|
655
|
+
content:
|
656
|
+
application/vnd.api+json; charset=utf-8:
|
657
|
+
schema:
|
658
|
+
type: object
|
659
|
+
properties:
|
660
|
+
meta:
|
661
|
+
type: object
|
662
|
+
properties: {}
|
663
|
+
required: []
|
664
|
+
required:
|
665
|
+
- meta
|
666
|
+
get:
|
667
|
+
tags:
|
668
|
+
- retrievers
|
669
|
+
description: Basic fetch
|
670
|
+
summary: show
|
671
|
+
parameters:
|
672
|
+
- in: path
|
673
|
+
required: true
|
674
|
+
name: id
|
675
|
+
schema:
|
676
|
+
type: string
|
677
|
+
example: '5'
|
678
|
+
responses:
|
679
|
+
200:
|
680
|
+
description: Basic fetch
|
681
|
+
content:
|
682
|
+
application/vnd.api+json; charset=utf-8:
|
683
|
+
schema:
|
684
|
+
type: object
|
685
|
+
properties:
|
686
|
+
data:
|
687
|
+
type: object
|
688
|
+
properties:
|
689
|
+
id:
|
690
|
+
type: string
|
691
|
+
example: '5'
|
692
|
+
type:
|
693
|
+
type: string
|
694
|
+
example: retrievers
|
695
|
+
attributes:
|
696
|
+
type: object
|
697
|
+
properties:
|
698
|
+
security_id:
|
699
|
+
type: integer
|
700
|
+
example: 7
|
701
|
+
klass_name:
|
702
|
+
type: string
|
703
|
+
example: fin_api_puller
|
704
|
+
symbol:
|
705
|
+
type: string
|
706
|
+
example: SYMBOL1
|
707
|
+
required:
|
708
|
+
- security_id
|
709
|
+
- klass_name
|
710
|
+
- symbol
|
711
|
+
relationships:
|
712
|
+
type: object
|
713
|
+
properties:
|
714
|
+
security:
|
715
|
+
type: object
|
716
|
+
properties:
|
717
|
+
links:
|
718
|
+
type: object
|
719
|
+
properties:
|
720
|
+
related:
|
721
|
+
type: string
|
722
|
+
example: http://test/api/v1/securities/7
|
723
|
+
required:
|
724
|
+
- related
|
725
|
+
required:
|
726
|
+
- links
|
727
|
+
required:
|
728
|
+
- security
|
729
|
+
required:
|
730
|
+
- id
|
731
|
+
- type
|
732
|
+
- attributes
|
733
|
+
- relationships
|
734
|
+
meta:
|
735
|
+
type: object
|
736
|
+
properties: {}
|
737
|
+
required: []
|
738
|
+
required:
|
739
|
+
- data
|
740
|
+
- meta
|
741
|
+
put:
|
742
|
+
tags:
|
743
|
+
- retrievers
|
744
|
+
description: Basic update
|
745
|
+
summary: update
|
746
|
+
parameters:
|
747
|
+
- in: path
|
748
|
+
required: true
|
749
|
+
name: id
|
750
|
+
schema:
|
751
|
+
type: string
|
752
|
+
example: '11'
|
753
|
+
responses:
|
754
|
+
200:
|
755
|
+
description: Basic update
|
756
|
+
content:
|
757
|
+
application/vnd.api+json; charset=utf-8:
|
758
|
+
schema:
|
759
|
+
type: object
|
760
|
+
properties:
|
761
|
+
data:
|
762
|
+
type: object
|
763
|
+
properties:
|
764
|
+
id:
|
765
|
+
type: string
|
766
|
+
example: '11'
|
767
|
+
type:
|
768
|
+
type: string
|
769
|
+
example: retrievers
|
770
|
+
attributes:
|
771
|
+
type: object
|
772
|
+
properties:
|
773
|
+
security_id:
|
774
|
+
type: integer
|
775
|
+
example: 21
|
776
|
+
klass_name:
|
777
|
+
type: string
|
778
|
+
example: fin_api_puller
|
779
|
+
symbol:
|
780
|
+
type: string
|
781
|
+
example: SYMBOL9
|
782
|
+
required:
|
783
|
+
- security_id
|
784
|
+
- klass_name
|
785
|
+
- symbol
|
786
|
+
relationships:
|
787
|
+
type: object
|
788
|
+
properties:
|
789
|
+
security:
|
790
|
+
type: object
|
791
|
+
properties:
|
792
|
+
links:
|
793
|
+
type: object
|
794
|
+
properties:
|
795
|
+
related:
|
796
|
+
type: string
|
797
|
+
example: http://test/api/v1/securities/21
|
798
|
+
required:
|
799
|
+
- related
|
800
|
+
required:
|
801
|
+
- links
|
802
|
+
required:
|
803
|
+
- security
|
804
|
+
required:
|
805
|
+
- id
|
806
|
+
- type
|
807
|
+
- attributes
|
808
|
+
- relationships
|
809
|
+
meta:
|
810
|
+
type: object
|
811
|
+
properties: {}
|
812
|
+
required: []
|
813
|
+
required:
|
814
|
+
- data
|
815
|
+
- meta
|
816
|
+
"/api/v1/securities":
|
817
|
+
post:
|
818
|
+
tags:
|
819
|
+
- securities
|
820
|
+
description: Basic create
|
821
|
+
summary: create
|
822
|
+
parameters: []
|
823
|
+
requestBody:
|
824
|
+
content:
|
825
|
+
application/vnd.api+json:
|
826
|
+
schema:
|
827
|
+
type: object
|
828
|
+
properties:
|
829
|
+
data:
|
830
|
+
type: object
|
831
|
+
properties:
|
832
|
+
type:
|
833
|
+
type: string
|
834
|
+
example: securities
|
835
|
+
attributes:
|
836
|
+
type: object
|
837
|
+
properties:
|
838
|
+
type:
|
839
|
+
type: string
|
840
|
+
example: stock
|
841
|
+
sa_id:
|
842
|
+
type: integer
|
843
|
+
example: 67
|
844
|
+
sa_slug:
|
845
|
+
type: string
|
846
|
+
example: slug65
|
847
|
+
primary_retriever_klass_name:
|
848
|
+
type: string
|
849
|
+
example: xignite_navs_puller
|
850
|
+
default_retriever_klass_name:
|
851
|
+
type: string
|
852
|
+
example: xignite_quote_puller
|
853
|
+
required:
|
854
|
+
- type
|
855
|
+
- sa_id
|
856
|
+
- sa_slug
|
857
|
+
- primary_retriever_klass_name
|
858
|
+
- default_retriever_klass_name
|
859
|
+
required:
|
860
|
+
- type
|
861
|
+
- attributes
|
862
|
+
required:
|
863
|
+
- data
|
864
|
+
responses:
|
865
|
+
201:
|
866
|
+
description: Basic create
|
867
|
+
content:
|
868
|
+
application/vnd.api+json; charset=utf-8:
|
869
|
+
schema:
|
870
|
+
type: object
|
871
|
+
properties:
|
872
|
+
data:
|
873
|
+
type: object
|
874
|
+
properties:
|
875
|
+
id:
|
876
|
+
type: string
|
877
|
+
example: '69'
|
878
|
+
type:
|
879
|
+
type: string
|
880
|
+
example: securities
|
881
|
+
attributes:
|
882
|
+
type: object
|
883
|
+
properties:
|
884
|
+
type:
|
885
|
+
type: string
|
886
|
+
example: stock
|
887
|
+
sa_id:
|
888
|
+
type: integer
|
889
|
+
example: 67
|
890
|
+
sa_slug:
|
891
|
+
type: string
|
892
|
+
example: slug65
|
893
|
+
primary_retriever_klass_name:
|
894
|
+
type: string
|
895
|
+
example: xignite_navs_puller
|
896
|
+
default_retriever_klass_name:
|
897
|
+
type: string
|
898
|
+
example: xignite_quote_puller
|
899
|
+
required:
|
900
|
+
- type
|
901
|
+
- sa_id
|
902
|
+
- sa_slug
|
903
|
+
- primary_retriever_klass_name
|
904
|
+
- default_retriever_klass_name
|
905
|
+
relationships:
|
906
|
+
type: object
|
907
|
+
properties:
|
908
|
+
retrievers:
|
909
|
+
type: object
|
910
|
+
properties:
|
911
|
+
links:
|
912
|
+
type: object
|
913
|
+
properties:
|
914
|
+
related:
|
915
|
+
type: string
|
916
|
+
example: http://test/api/v1/retrievers?filter[security_id]=69
|
917
|
+
required:
|
918
|
+
- related
|
919
|
+
required:
|
920
|
+
- links
|
921
|
+
required:
|
922
|
+
- retrievers
|
923
|
+
required:
|
924
|
+
- id
|
925
|
+
- type
|
926
|
+
- attributes
|
927
|
+
- relationships
|
928
|
+
meta:
|
929
|
+
type: object
|
930
|
+
properties: {}
|
931
|
+
required: []
|
932
|
+
required:
|
933
|
+
- data
|
934
|
+
- meta
|
935
|
+
get:
|
936
|
+
tags:
|
937
|
+
- securities
|
938
|
+
description: Basic fetch
|
939
|
+
summary: index
|
940
|
+
parameters: []
|
941
|
+
responses:
|
942
|
+
200:
|
943
|
+
description: Basic fetch
|
944
|
+
content:
|
945
|
+
application/vnd.api+json; charset=utf-8:
|
946
|
+
schema:
|
947
|
+
type: object
|
948
|
+
properties:
|
949
|
+
data:
|
950
|
+
type: array
|
951
|
+
items:
|
952
|
+
type: object
|
953
|
+
properties:
|
954
|
+
id:
|
955
|
+
type: string
|
956
|
+
example: '18'
|
957
|
+
type:
|
958
|
+
type: string
|
959
|
+
example: securities
|
960
|
+
attributes:
|
961
|
+
type: object
|
962
|
+
properties:
|
963
|
+
type:
|
964
|
+
type: string
|
965
|
+
example: mf
|
966
|
+
sa_id:
|
967
|
+
type: integer
|
968
|
+
example: 17
|
969
|
+
sa_slug:
|
970
|
+
type: string
|
971
|
+
example: slug14
|
972
|
+
primary_retriever_klass_name:
|
973
|
+
type: string
|
974
|
+
example: xignite_index_puller
|
975
|
+
default_retriever_klass_name:
|
976
|
+
type: string
|
977
|
+
example: iex_puller
|
978
|
+
required:
|
979
|
+
- type
|
980
|
+
- sa_id
|
981
|
+
- sa_slug
|
982
|
+
- primary_retriever_klass_name
|
983
|
+
- default_retriever_klass_name
|
984
|
+
relationships:
|
985
|
+
type: object
|
986
|
+
properties:
|
987
|
+
retrievers:
|
988
|
+
type: object
|
989
|
+
properties:
|
990
|
+
links:
|
991
|
+
type: object
|
992
|
+
properties:
|
993
|
+
related:
|
994
|
+
type: string
|
995
|
+
example: http://test/api/v1/retrievers?filter[security_id]=18
|
996
|
+
required:
|
997
|
+
- related
|
998
|
+
required:
|
999
|
+
- links
|
1000
|
+
required:
|
1001
|
+
- retrievers
|
1002
|
+
required:
|
1003
|
+
- id
|
1004
|
+
- type
|
1005
|
+
- attributes
|
1006
|
+
- relationships
|
1007
|
+
example:
|
1008
|
+
- id: '18'
|
1009
|
+
type: securities
|
1010
|
+
attributes:
|
1011
|
+
type: mf
|
1012
|
+
sa_id: 17
|
1013
|
+
sa_slug: slug14
|
1014
|
+
primary_retriever_klass_name: xignite_index_puller
|
1015
|
+
default_retriever_klass_name: iex_puller
|
1016
|
+
relationships:
|
1017
|
+
retrievers:
|
1018
|
+
links:
|
1019
|
+
related: http://test/api/v1/retrievers?filter[security_id]=18
|
1020
|
+
- id: '19'
|
1021
|
+
type: securities
|
1022
|
+
attributes:
|
1023
|
+
type: crypto
|
1024
|
+
sa_id: 18
|
1025
|
+
sa_slug: slug15
|
1026
|
+
primary_retriever_klass_name: xignite_quote_puller
|
1027
|
+
default_retriever_klass_name: iex_puller
|
1028
|
+
relationships:
|
1029
|
+
retrievers:
|
1030
|
+
links:
|
1031
|
+
related: http://test/api/v1/retrievers?filter[security_id]=19
|
1032
|
+
meta:
|
1033
|
+
type: object
|
1034
|
+
properties: {}
|
1035
|
+
required: []
|
1036
|
+
required:
|
1037
|
+
- data
|
1038
|
+
- meta
|
1039
|
+
"/api/v1/securities/{id}":
|
1040
|
+
delete:
|
1041
|
+
tags:
|
1042
|
+
- securities
|
1043
|
+
description: Basic destroy
|
1044
|
+
summary: destroy
|
1045
|
+
parameters:
|
1046
|
+
- in: path
|
1047
|
+
required: true
|
1048
|
+
name: id
|
1049
|
+
schema:
|
1050
|
+
type: string
|
1051
|
+
example: '55'
|
1052
|
+
responses:
|
1053
|
+
200:
|
1054
|
+
description: Basic destroy
|
1055
|
+
content:
|
1056
|
+
application/vnd.api+json; charset=utf-8:
|
1057
|
+
schema:
|
1058
|
+
type: object
|
1059
|
+
properties:
|
1060
|
+
meta:
|
1061
|
+
type: object
|
1062
|
+
properties: {}
|
1063
|
+
required: []
|
1064
|
+
required:
|
1065
|
+
- meta
|
1066
|
+
get:
|
1067
|
+
tags:
|
1068
|
+
- securities
|
1069
|
+
description: Basic fetch
|
1070
|
+
summary: show
|
1071
|
+
parameters:
|
1072
|
+
- in: path
|
1073
|
+
required: true
|
1074
|
+
name: id
|
1075
|
+
schema:
|
1076
|
+
type: string
|
1077
|
+
example: '29'
|
1078
|
+
responses:
|
1079
|
+
200:
|
1080
|
+
description: Basic fetch
|
1081
|
+
content:
|
1082
|
+
application/vnd.api+json; charset=utf-8:
|
1083
|
+
schema:
|
1084
|
+
type: object
|
1085
|
+
properties:
|
1086
|
+
data:
|
1087
|
+
type: object
|
1088
|
+
properties:
|
1089
|
+
id:
|
1090
|
+
type: string
|
1091
|
+
example: '29'
|
1092
|
+
type:
|
1093
|
+
type: string
|
1094
|
+
example: securities
|
1095
|
+
attributes:
|
1096
|
+
type: object
|
1097
|
+
properties:
|
1098
|
+
type:
|
1099
|
+
type: string
|
1100
|
+
example: stock
|
1101
|
+
sa_id:
|
1102
|
+
type: integer
|
1103
|
+
example: 28
|
1104
|
+
sa_slug:
|
1105
|
+
type: string
|
1106
|
+
example: slug25
|
1107
|
+
primary_retriever_klass_name:
|
1108
|
+
type: string
|
1109
|
+
example: trading_economics_puller
|
1110
|
+
default_retriever_klass_name:
|
1111
|
+
type: string
|
1112
|
+
example: trading_economics_puller
|
1113
|
+
required:
|
1114
|
+
- type
|
1115
|
+
- sa_id
|
1116
|
+
- sa_slug
|
1117
|
+
- primary_retriever_klass_name
|
1118
|
+
- default_retriever_klass_name
|
1119
|
+
relationships:
|
1120
|
+
type: object
|
1121
|
+
properties:
|
1122
|
+
retrievers:
|
1123
|
+
type: object
|
1124
|
+
properties:
|
1125
|
+
links:
|
1126
|
+
type: object
|
1127
|
+
properties:
|
1128
|
+
related:
|
1129
|
+
type: string
|
1130
|
+
example: http://test/api/v1/retrievers?filter[security_id]=29
|
1131
|
+
required:
|
1132
|
+
- related
|
1133
|
+
required:
|
1134
|
+
- links
|
1135
|
+
required:
|
1136
|
+
- retrievers
|
1137
|
+
required:
|
1138
|
+
- id
|
1139
|
+
- type
|
1140
|
+
- attributes
|
1141
|
+
- relationships
|
1142
|
+
meta:
|
1143
|
+
type: object
|
1144
|
+
properties: {}
|
1145
|
+
required: []
|
1146
|
+
required:
|
1147
|
+
- data
|
1148
|
+
- meta
|
1149
|
+
put:
|
1150
|
+
tags:
|
1151
|
+
- securities
|
1152
|
+
description: Basic update
|
1153
|
+
summary: update
|
1154
|
+
parameters:
|
1155
|
+
- in: path
|
1156
|
+
required: true
|
1157
|
+
name: id
|
1158
|
+
schema:
|
1159
|
+
type: string
|
1160
|
+
example: '20'
|
1161
|
+
responses:
|
1162
|
+
200:
|
1163
|
+
description: Basic update
|
1164
|
+
content:
|
1165
|
+
application/vnd.api+json; charset=utf-8:
|
1166
|
+
schema:
|
1167
|
+
type: object
|
1168
|
+
properties:
|
1169
|
+
data:
|
1170
|
+
type: object
|
1171
|
+
properties:
|
1172
|
+
id:
|
1173
|
+
type: string
|
1174
|
+
example: '20'
|
1175
|
+
type:
|
1176
|
+
type: string
|
1177
|
+
example: securities
|
1178
|
+
attributes:
|
1179
|
+
type: object
|
1180
|
+
properties:
|
1181
|
+
type:
|
1182
|
+
type: string
|
1183
|
+
example: mf
|
1184
|
+
sa_id:
|
1185
|
+
type: integer
|
1186
|
+
example: 19
|
1187
|
+
sa_slug:
|
1188
|
+
type: string
|
1189
|
+
example: slug16
|
1190
|
+
primary_retriever_klass_name:
|
1191
|
+
type: string
|
1192
|
+
example: xignite_navs_puller
|
1193
|
+
default_retriever_klass_name:
|
1194
|
+
type: string
|
1195
|
+
example: trading_economics_puller
|
1196
|
+
required:
|
1197
|
+
- type
|
1198
|
+
- sa_id
|
1199
|
+
- sa_slug
|
1200
|
+
- primary_retriever_klass_name
|
1201
|
+
- default_retriever_klass_name
|
1202
|
+
relationships:
|
1203
|
+
type: object
|
1204
|
+
properties:
|
1205
|
+
retrievers:
|
1206
|
+
type: object
|
1207
|
+
properties:
|
1208
|
+
links:
|
1209
|
+
type: object
|
1210
|
+
properties:
|
1211
|
+
related:
|
1212
|
+
type: string
|
1213
|
+
example: http://test/api/v1/retrievers?filter[security_id]=20
|
1214
|
+
required:
|
1215
|
+
- related
|
1216
|
+
required:
|
1217
|
+
- links
|
1218
|
+
required:
|
1219
|
+
- retrievers
|
1220
|
+
required:
|
1221
|
+
- id
|
1222
|
+
- type
|
1223
|
+
- attributes
|
1224
|
+
- relationships
|
1225
|
+
meta:
|
1226
|
+
type: object
|
1227
|
+
properties: {}
|
1228
|
+
required: []
|
1229
|
+
required:
|
1230
|
+
- data
|
1231
|
+
- meta
|
1232
|
+
"/real_time_quotes":
|
1233
|
+
get:
|
1234
|
+
tags:
|
1235
|
+
- real_time_quotes
|
1236
|
+
description: Get /index
|
1237
|
+
summary: index
|
1238
|
+
parameters:
|
1239
|
+
- in: query
|
1240
|
+
required: true
|
1241
|
+
name: sa_ids
|
1242
|
+
schema:
|
1243
|
+
type: string
|
1244
|
+
example: '7'
|
1245
|
+
responses:
|
1246
|
+
200:
|
1247
|
+
description: Get /index
|
1248
|
+
content:
|
1249
|
+
application/json; charset=utf-8:
|
1250
|
+
schema:
|
1251
|
+
type: object
|
1252
|
+
properties:
|
1253
|
+
real_time_quotes:
|
1254
|
+
type: array
|
1255
|
+
items:
|
1256
|
+
type: object
|
1257
|
+
properties:
|
1258
|
+
sa_id:
|
1259
|
+
type: integer
|
1260
|
+
example: 7
|
1261
|
+
high:
|
1262
|
+
type: number
|
1263
|
+
example: 76.77
|
1264
|
+
low:
|
1265
|
+
type: number
|
1266
|
+
example: 60.31
|
1267
|
+
open:
|
1268
|
+
type: number
|
1269
|
+
example: 73.7
|
1270
|
+
close:
|
1271
|
+
type: number
|
1272
|
+
example: 74.0
|
1273
|
+
prev_close:
|
1274
|
+
type: number
|
1275
|
+
example: 68.91
|
1276
|
+
last:
|
1277
|
+
type: number
|
1278
|
+
example: 61.39
|
1279
|
+
volume:
|
1280
|
+
type: integer
|
1281
|
+
example: 151
|
1282
|
+
last_time:
|
1283
|
+
type: string
|
1284
|
+
example: '2022-05-06T16:30:04.311-04:00'
|
1285
|
+
market_cap:
|
1286
|
+
type: integer
|
1287
|
+
example: 842898728
|
1288
|
+
ext_time:
|
1289
|
+
type: string
|
1290
|
+
example: '2022-05-06T16:30:04.311-04:00'
|
1291
|
+
ext_price:
|
1292
|
+
type: number
|
1293
|
+
example: 67.95
|
1294
|
+
ext_market:
|
1295
|
+
type: string
|
1296
|
+
example: pre
|
1297
|
+
updated_at:
|
1298
|
+
type: string
|
1299
|
+
example: '2022-05-06T16:30:04.311-04:00'
|
1300
|
+
required:
|
1301
|
+
- sa_id
|
1302
|
+
- high
|
1303
|
+
- low
|
1304
|
+
- open
|
1305
|
+
- close
|
1306
|
+
- prev_close
|
1307
|
+
- last
|
1308
|
+
- volume
|
1309
|
+
- last_time
|
1310
|
+
- market_cap
|
1311
|
+
- ext_time
|
1312
|
+
- ext_price
|
1313
|
+
- ext_market
|
1314
|
+
- updated_at
|
1315
|
+
example:
|
1316
|
+
- sa_id: 7
|
1317
|
+
high: 76.77
|
1318
|
+
low: 60.31
|
1319
|
+
open: 73.7
|
1320
|
+
close: 74.0
|
1321
|
+
prev_close: 68.91
|
1322
|
+
last: 61.39
|
1323
|
+
volume: 151
|
1324
|
+
last_time: '2022-05-06T16:30:04.311-04:00'
|
1325
|
+
market_cap: 842898728
|
1326
|
+
ext_time: '2022-05-06T16:30:04.311-04:00'
|
1327
|
+
ext_price: 67.95
|
1328
|
+
ext_market: pre
|
1329
|
+
updated_at: '2022-05-06T16:30:04.311-04:00'
|
1330
|
+
required:
|
1331
|
+
- real_time_quotes
|
1332
|
+
"/status":
|
1333
|
+
get:
|
1334
|
+
tags:
|
1335
|
+
- system_status
|
1336
|
+
description: Systemstatuscontroller
|
1337
|
+
summary: status
|
1338
|
+
parameters: []
|
1339
|
+
responses:
|
1340
|
+
200:
|
1341
|
+
description: Systemstatuscontroller
|
1342
|
+
content:
|
1343
|
+
application/json; charset=utf-8:
|
1344
|
+
schema:
|
1345
|
+
type: object
|
1346
|
+
properties:
|
1347
|
+
status:
|
1348
|
+
type: string
|
1349
|
+
example: ok
|
1350
|
+
time:
|
1351
|
+
type: string
|
1352
|
+
example: '2022-05-06T16:30:04.901-04:00'
|
1353
|
+
required:
|
1354
|
+
- status
|
1355
|
+
- time
|