haveapi 0.28.3 → 0.28.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/doc/json-schema.html DELETED
@@ -1,1182 +0,0 @@
1
-
2
-
3
- <h1 id="envelope">Envelope</h1>
4
- <pre><code>{
5
- "title": "All response are wrapped in this envelope",
6
- "type": "object",
7
- "properties": {
8
- "version": {},
9
- "status": {
10
- "type": "boolean"
11
- },
12
- "response": {
13
- "type": "object"
14
- },
15
- "message": {
16
- "type": "string"
17
- },
18
- "errors": {
19
- "type": "object",
20
- "patternProperties": {
21
- "^.+$": {
22
- "type": "array"
23
- }
24
- }
25
- }
26
- },
27
- "required": [
28
- "status"
29
- ]
30
- }</code></pre>
31
-
32
-
33
- <h1 id="all">OPTIONS /</h1>
34
- <pre><code>{
35
- "title": "Describe all API versions",
36
- "type": "object",
37
- "properties": {
38
- "default_version": {},
39
- "versions": {
40
- "type": "object",
41
- "patternProperties": {
42
- "^.+$": {
43
- "$ref": "#/definitions/version"
44
- }
45
- },
46
- "properties": {
47
- "default": {
48
- "$ref": "#/definitions/version"
49
- }
50
- }
51
- }
52
- },
53
- "required": [
54
- "default_version",
55
- "versions"
56
- ],
57
- "version": {
58
- "type": "object",
59
- "properties": {
60
- "authentication": {
61
- "type": "object",
62
- "properties": {
63
- "basic": {
64
- "$ref": "#/definitions/auth_basic"
65
- },
66
- "token": {
67
- "$ref": "#/definitions/auth_token"
68
- }
69
- }
70
- },
71
- "resources": {
72
- "type": "object",
73
- "$ref": "#/definitions/resources"
74
- },
75
- "meta": {
76
- "type": "object",
77
- "properties": {
78
- "namespace": {
79
- "type": "string",
80
- "default": "_meta"
81
- }
82
- }
83
- },
84
- "help": {
85
- "type": "string"
86
- }
87
- }
88
- },
89
- "auth_basic": {
90
- "type": "object"
91
- },
92
- "auth_token": {
93
- "type": "object",
94
- "properties": {
95
- "http_header": {
96
- "type": "string",
97
- "default": "X-HaveAPI-Auth-Token"
98
- },
99
- "query_parameter": {
100
- "type": "string",
101
- "default": "_auth_token"
102
- },
103
- "resources": {
104
- "type": "object",
105
- "$ref": "#/definitions/resources"
106
- }
107
- }
108
- },
109
- "resources": {
110
- "type": "object",
111
- "patternProperties": {
112
- "^[a-z_]+$": {
113
- "type": "object",
114
- "properties": {
115
- "description": {
116
- "type": "string"
117
- },
118
- "actions": {
119
- "$ref": "#/definitions/actions"
120
- },
121
- "resources": {
122
- "$ref": "#/definitions/resources"
123
- }
124
- }
125
- }
126
- }
127
- },
128
- "actions": {
129
- "type": "object",
130
- "patternProperties": {
131
- "^[a-z_]+$": {
132
- "type": "object",
133
- "properties": {
134
- "auth": {
135
- "type": "boolean"
136
- },
137
- "description": {
138
- "type": "string"
139
- },
140
- "aliases": {
141
- "type": "array",
142
- "items": {
143
- "type": "string"
144
- }
145
- },
146
- "blocking": {
147
- "type": "boolean"
148
- },
149
- "input": {
150
- "$ref": "#/definitions/input_parameters"
151
- },
152
- "output": {
153
- "$ref": "#/definitions/output_parameters"
154
- },
155
- "meta": {
156
- "$ref": "#/definitions/action_meta"
157
- },
158
- "examples": {
159
- "type": "object",
160
- "properties": {
161
- "title": {
162
- "type": "string"
163
- },
164
- "url_params": {
165
- "type": "array",
166
- "items": {
167
- "type": "integer"
168
- }
169
- },
170
- "request": {
171
- "type": "object"
172
- },
173
- "response": {
174
- "type": "object"
175
- },
176
- "status": {
177
- "type": "boolean"
178
- },
179
- "message": {
180
- "type": "string"
181
- },
182
- "errors": {
183
- "type": "object",
184
- "patternProperties": {
185
- "^[a-z_]+$": {
186
- "type": "array",
187
- "items": {
188
- "type": "string"
189
- }
190
- }
191
- }
192
- },
193
- "http_status": {
194
- "type": "integer"
195
- },
196
- "comment": {
197
- "type": "string"
198
- }
199
- }
200
- },
201
- "url": {
202
- "type": "string"
203
- },
204
- "method": {
205
- "type": "string"
206
- },
207
- "help": {
208
- "type": "string"
209
- }
210
- }
211
- }
212
- }
213
- },
214
- "input_parameters": {
215
- "type": "object",
216
- "properties": {
217
- "parameters": {
218
- "type": "object",
219
- "patternProperties": {
220
- "^[a-z_]+$": {
221
- "type": "object",
222
- "oneOf": [
223
- {
224
- "title": "Data type",
225
- "type": "object",
226
- "properties": {
227
- "required": {
228
- "type": "boolean"
229
- },
230
- "label": {
231
- "type": "string"
232
- },
233
- "description": {
234
- "type": "string"
235
- },
236
- "type": {
237
- "type": "string",
238
- "enum": [
239
- "String",
240
- "Text",
241
- "Integer",
242
- "Float",
243
- "Datetime",
244
- "Boolean"
245
- ]
246
- },
247
- "validators": {
248
- "$ref": "#/definitions/input_validators"
249
- },
250
- "default": {},
251
- "protected": {
252
- "type": "boolean"
253
- }
254
- }
255
- },
256
- {
257
- "title": "Resource",
258
- "type": "object",
259
- "properties": {
260
- "required": {
261
- "type": "boolean"
262
- },
263
- "label": {
264
- "type": "string"
265
- },
266
- "description": {
267
- "type": "string"
268
- },
269
- "type": {
270
- "type": "string",
271
- "enum": [
272
- "Resource"
273
- ]
274
- },
275
- "resource": {
276
- "type": "array"
277
- },
278
- "value_id": {
279
- "type": "string"
280
- },
281
- "value_label": {
282
- "type": "string"
283
- },
284
- "value": {
285
- "type": "object",
286
- "properties": {
287
- "url": {
288
- "type": "string"
289
- },
290
- "method": {
291
- "type": "string"
292
- },
293
- "help": {
294
- "type": "string"
295
- }
296
- }
297
- },
298
- "choices": {
299
- "type": "object",
300
- "properties": {
301
- "url": {
302
- "type": "string"
303
- },
304
- "method": {
305
- "type": "string"
306
- },
307
- "help": {
308
- "type": "string"
309
- }
310
- }
311
- }
312
- }
313
- }
314
- ]
315
- }
316
- }
317
- },
318
- "layout": {
319
- "type": "string",
320
- "enum": [
321
- "hash",
322
- "hash_list",
323
- "object",
324
- "object_list"
325
- ]
326
- },
327
- "namespace": {
328
- "type": "string"
329
- }
330
- }
331
- },
332
- "input_validators": {
333
- "type": "object",
334
- "properties": {
335
- "accept": {
336
- "type": "object",
337
- "properties": {
338
- "value": {},
339
- "message": {
340
- "type": "string"
341
- }
342
- }
343
- },
344
- "confirm": {
345
- "type": "object",
346
- "properties": {
347
- "equal": {
348
- "type": "boolean"
349
- },
350
- "parameter": {
351
- "type": "string"
352
- },
353
- "message": {
354
- "type": "string"
355
- }
356
- }
357
- },
358
- "custom": {
359
- "type": "string"
360
- },
361
- "exclude": {
362
- "type": "object",
363
- "properties": {
364
- "values": {
365
- "type": "array"
366
- },
367
- "message": {
368
- "type": "string"
369
- }
370
- }
371
- },
372
- "format": {
373
- "type": "object",
374
- "properties": {
375
- "rx": {
376
- "type": "string"
377
- },
378
- "match": {
379
- "type": "boolean"
380
- },
381
- "description": {
382
- "type": "string"
383
- },
384
- "message": {
385
- "type": "string"
386
- }
387
- }
388
- },
389
- "include": {
390
- "type": "object",
391
- "properties": {
392
- "values": {
393
- "oneOf": [
394
- {
395
- "title": "Array of allowed values",
396
- "type": "array"
397
- },
398
- {
399
- "title": "Hash of allowed values",
400
- "type": "object"
401
- }
402
- ]
403
- },
404
- "message": {
405
- "type": "string"
406
- }
407
- }
408
- },
409
- "length": {
410
- "oneOf": [
411
- {
412
- "title": "Equality",
413
- "type": "object",
414
- "properties": {
415
- "equals": {
416
- "type": "integer"
417
- },
418
- "message": {
419
- "type": "string"
420
- }
421
- }
422
- },
423
- {
424
- "title": "Interval",
425
- "type": "object",
426
- "properties": {
427
- "min": {
428
- "type": "integer"
429
- },
430
- "max": {
431
- "type": "integer"
432
- },
433
- "message": {
434
- "type": "string"
435
- }
436
- }
437
- }
438
- ]
439
- },
440
- "number": {
441
- "type": "object",
442
- "properties": {
443
- "min": {
444
- "type": "number"
445
- },
446
- "max": {
447
- "type": "number"
448
- },
449
- "step": {
450
- "type": "number"
451
- },
452
- "mod": {
453
- "type": "integer"
454
- },
455
- "odd": {
456
- "type": "boolean"
457
- },
458
- "even": {
459
- "type": "boolean"
460
- },
461
- "message": {
462
- "type": "string"
463
- }
464
- }
465
- },
466
- "present": {
467
- "type": "object",
468
- "properties": {
469
- "empty": {
470
- "type": "boolean"
471
- },
472
- "message": {
473
- "type": "string"
474
- }
475
- }
476
- }
477
- }
478
- },
479
- "output_parameters": {
480
- "type": "object",
481
- "properties": {
482
- "parameters": {
483
- "type": "object",
484
- "patternProperties": {
485
- "^[a-z_]+$": {
486
- "type": "object",
487
- "oneOf": [
488
- {
489
- "title": "Data type",
490
- "type": "object",
491
- "properties": {
492
- "label": {
493
- "type": "string"
494
- },
495
- "description": {
496
- "type": "string"
497
- },
498
- "type": {
499
- "type": "string",
500
- "enum": [
501
- "String",
502
- "Text",
503
- "Integer",
504
- "Float",
505
- "Datetime",
506
- "Boolean"
507
- ]
508
- },
509
- "protected": {
510
- "type": "boolean"
511
- }
512
- }
513
- },
514
- {
515
- "title": "Resource",
516
- "type": "object",
517
- "properties": {
518
- "label": {
519
- "type": "string"
520
- },
521
- "description": {
522
- "type": "string"
523
- },
524
- "type": {
525
- "type": "string",
526
- "enum": [
527
- "Resource"
528
- ]
529
- },
530
- "resource": {
531
- "type": "array"
532
- },
533
- "value_id": {
534
- "type": "string"
535
- },
536
- "value_label": {
537
- "type": "string"
538
- },
539
- "value": {
540
- "type": "object",
541
- "properties": {
542
- "url": {
543
- "type": "string"
544
- },
545
- "method": {
546
- "type": "string"
547
- },
548
- "help": {
549
- "type": "string"
550
- }
551
- }
552
- },
553
- "choices": {
554
- "type": "object",
555
- "properties": {
556
- "url": {
557
- "type": "string"
558
- },
559
- "method": {
560
- "type": "string"
561
- },
562
- "help": {
563
- "type": "string"
564
- }
565
- }
566
- }
567
- }
568
- }
569
- ]
570
- }
571
- }
572
- },
573
- "layout": {
574
- "type": "string",
575
- "enum": [
576
- "hash",
577
- "hash_list",
578
- "object",
579
- "object_list"
580
- ]
581
- },
582
- "namespace": {
583
- "type": "string"
584
- }
585
- }
586
- },
587
- "action_meta": {
588
- "type": "object",
589
- "properties": {
590
- "object": {
591
- "input": {
592
- "$ref": "#/definitions/input_parameters"
593
- },
594
- "output": {
595
- "$ref": "#/definitions/output_parameters"
596
- }
597
- },
598
- "global": {
599
- "input": {
600
- "$ref": "#/definitions/input_parameters"
601
- },
602
- "output": {
603
- "$ref": "#/definitions/output_parameters"
604
- }
605
- }
606
- }
607
- }
608
- }</code></pre>
609
-
610
- <h1 id="versions">OPTIONS /?describe=versions</h1>
611
- <pre><code>{
612
- "title": "Show available API versions",
613
- "type": "object",
614
- "properties": {
615
- "versions": {
616
- "type": "array"
617
- },
618
- "default": {}
619
- },
620
- "required": [
621
- "versions",
622
- "default"
623
- ]
624
- }</code></pre>
625
-
626
- <h1 id="default">OPTIONS /?describe=default</h1>
627
- <pre><code>{
628
- "title": "Describe only the default version of the API",
629
- "$ref": "#/definitions/version",
630
- "version": {
631
- "type": "object",
632
- "properties": {
633
- "authentication": {
634
- "type": "object",
635
- "properties": {
636
- "basic": {
637
- "$ref": "#/definitions/auth_basic"
638
- },
639
- "token": {
640
- "$ref": "#/definitions/auth_token"
641
- }
642
- }
643
- },
644
- "resources": {
645
- "type": "object",
646
- "$ref": "#/definitions/resources"
647
- },
648
- "meta": {
649
- "type": "object",
650
- "properties": {
651
- "namespace": {
652
- "type": "string",
653
- "default": "_meta"
654
- }
655
- }
656
- },
657
- "help": {
658
- "type": "string"
659
- }
660
- }
661
- },
662
- "auth_basic": {
663
- "type": "object"
664
- },
665
- "auth_token": {
666
- "type": "object",
667
- "properties": {
668
- "http_header": {
669
- "type": "string",
670
- "default": "X-HaveAPI-Auth-Token"
671
- },
672
- "query_parameter": {
673
- "type": "string",
674
- "default": "_auth_token"
675
- },
676
- "resources": {
677
- "type": "object",
678
- "$ref": "#/definitions/resources"
679
- }
680
- }
681
- },
682
- "resources": {
683
- "type": "object",
684
- "patternProperties": {
685
- "^[a-z_]+$": {
686
- "type": "object",
687
- "properties": {
688
- "description": {
689
- "type": "string"
690
- },
691
- "actions": {
692
- "$ref": "#/definitions/actions"
693
- },
694
- "resources": {
695
- "$ref": "#/definitions/resources"
696
- }
697
- }
698
- }
699
- }
700
- },
701
- "actions": {
702
- "type": "object",
703
- "patternProperties": {
704
- "^[a-z_]+$": {
705
- "type": "object",
706
- "properties": {
707
- "auth": {
708
- "type": "boolean"
709
- },
710
- "description": {
711
- "type": "string"
712
- },
713
- "aliases": {
714
- "type": "array",
715
- "items": {
716
- "type": "string"
717
- }
718
- },
719
- "blocking": {
720
- "type": "boolean"
721
- },
722
- "input": {
723
- "$ref": "#/definitions/input_parameters"
724
- },
725
- "output": {
726
- "$ref": "#/definitions/output_parameters"
727
- },
728
- "meta": {
729
- "$ref": "#/definitions/action_meta"
730
- },
731
- "examples": {
732
- "type": "object",
733
- "properties": {
734
- "title": {
735
- "type": "string"
736
- },
737
- "url_params": {
738
- "type": "array",
739
- "items": {
740
- "type": "integer"
741
- }
742
- },
743
- "request": {
744
- "type": "object"
745
- },
746
- "response": {
747
- "type": "object"
748
- },
749
- "status": {
750
- "type": "boolean"
751
- },
752
- "message": {
753
- "type": "string"
754
- },
755
- "errors": {
756
- "type": "object",
757
- "patternProperties": {
758
- "^[a-z_]+$": {
759
- "type": "array",
760
- "items": {
761
- "type": "string"
762
- }
763
- }
764
- }
765
- },
766
- "http_status": {
767
- "type": "integer"
768
- },
769
- "comment": {
770
- "type": "string"
771
- }
772
- }
773
- },
774
- "url": {
775
- "type": "string"
776
- },
777
- "method": {
778
- "type": "string"
779
- },
780
- "help": {
781
- "type": "string"
782
- }
783
- }
784
- }
785
- }
786
- },
787
- "input_parameters": {
788
- "type": "object",
789
- "properties": {
790
- "parameters": {
791
- "type": "object",
792
- "patternProperties": {
793
- "^[a-z_]+$": {
794
- "type": "object",
795
- "oneOf": [
796
- {
797
- "title": "Data type",
798
- "type": "object",
799
- "properties": {
800
- "required": {
801
- "type": "boolean"
802
- },
803
- "label": {
804
- "type": "string"
805
- },
806
- "description": {
807
- "type": "string"
808
- },
809
- "type": {
810
- "type": "string",
811
- "enum": [
812
- "String",
813
- "Text",
814
- "Integer",
815
- "Float",
816
- "Datetime",
817
- "Boolean"
818
- ]
819
- },
820
- "validators": {
821
- "$ref": "#/definitions/input_validators"
822
- },
823
- "default": {},
824
- "protected": {
825
- "type": "boolean"
826
- }
827
- }
828
- },
829
- {
830
- "title": "Resource",
831
- "type": "object",
832
- "properties": {
833
- "required": {
834
- "type": "boolean"
835
- },
836
- "label": {
837
- "type": "string"
838
- },
839
- "description": {
840
- "type": "string"
841
- },
842
- "type": {
843
- "type": "string",
844
- "enum": [
845
- "Resource"
846
- ]
847
- },
848
- "resource": {
849
- "type": "array"
850
- },
851
- "value_id": {
852
- "type": "string"
853
- },
854
- "value_label": {
855
- "type": "string"
856
- },
857
- "value": {
858
- "type": "object",
859
- "properties": {
860
- "url": {
861
- "type": "string"
862
- },
863
- "method": {
864
- "type": "string"
865
- },
866
- "help": {
867
- "type": "string"
868
- }
869
- }
870
- },
871
- "choices": {
872
- "type": "object",
873
- "properties": {
874
- "url": {
875
- "type": "string"
876
- },
877
- "method": {
878
- "type": "string"
879
- },
880
- "help": {
881
- "type": "string"
882
- }
883
- }
884
- }
885
- }
886
- }
887
- ]
888
- }
889
- }
890
- },
891
- "layout": {
892
- "type": "string",
893
- "enum": [
894
- "hash",
895
- "hash_list",
896
- "object",
897
- "object_list"
898
- ]
899
- },
900
- "namespace": {
901
- "type": "string"
902
- }
903
- }
904
- },
905
- "input_validators": {
906
- "type": "object",
907
- "properties": {
908
- "accept": {
909
- "type": "object",
910
- "properties": {
911
- "value": {},
912
- "message": {
913
- "type": "string"
914
- }
915
- }
916
- },
917
- "confirm": {
918
- "type": "object",
919
- "properties": {
920
- "equal": {
921
- "type": "boolean"
922
- },
923
- "parameter": {
924
- "type": "string"
925
- },
926
- "message": {
927
- "type": "string"
928
- }
929
- }
930
- },
931
- "custom": {
932
- "type": "string"
933
- },
934
- "exclude": {
935
- "type": "object",
936
- "properties": {
937
- "values": {
938
- "type": "array"
939
- },
940
- "message": {
941
- "type": "string"
942
- }
943
- }
944
- },
945
- "format": {
946
- "type": "object",
947
- "properties": {
948
- "rx": {
949
- "type": "string"
950
- },
951
- "match": {
952
- "type": "boolean"
953
- },
954
- "description": {
955
- "type": "string"
956
- },
957
- "message": {
958
- "type": "string"
959
- }
960
- }
961
- },
962
- "include": {
963
- "type": "object",
964
- "properties": {
965
- "values": {
966
- "oneOf": [
967
- {
968
- "title": "Array of allowed values",
969
- "type": "array"
970
- },
971
- {
972
- "title": "Hash of allowed values",
973
- "type": "object"
974
- }
975
- ]
976
- },
977
- "message": {
978
- "type": "string"
979
- }
980
- }
981
- },
982
- "length": {
983
- "oneOf": [
984
- {
985
- "title": "Equality",
986
- "type": "object",
987
- "properties": {
988
- "equals": {
989
- "type": "integer"
990
- },
991
- "message": {
992
- "type": "string"
993
- }
994
- }
995
- },
996
- {
997
- "title": "Interval",
998
- "type": "object",
999
- "properties": {
1000
- "min": {
1001
- "type": "integer"
1002
- },
1003
- "max": {
1004
- "type": "integer"
1005
- },
1006
- "message": {
1007
- "type": "string"
1008
- }
1009
- }
1010
- }
1011
- ]
1012
- },
1013
- "number": {
1014
- "type": "object",
1015
- "properties": {
1016
- "min": {
1017
- "type": "number"
1018
- },
1019
- "max": {
1020
- "type": "number"
1021
- },
1022
- "step": {
1023
- "type": "number"
1024
- },
1025
- "mod": {
1026
- "type": "integer"
1027
- },
1028
- "odd": {
1029
- "type": "boolean"
1030
- },
1031
- "even": {
1032
- "type": "boolean"
1033
- },
1034
- "message": {
1035
- "type": "string"
1036
- }
1037
- }
1038
- },
1039
- "present": {
1040
- "type": "object",
1041
- "properties": {
1042
- "empty": {
1043
- "type": "boolean"
1044
- },
1045
- "message": {
1046
- "type": "string"
1047
- }
1048
- }
1049
- }
1050
- }
1051
- },
1052
- "output_parameters": {
1053
- "type": "object",
1054
- "properties": {
1055
- "parameters": {
1056
- "type": "object",
1057
- "patternProperties": {
1058
- "^[a-z_]+$": {
1059
- "type": "object",
1060
- "oneOf": [
1061
- {
1062
- "title": "Data type",
1063
- "type": "object",
1064
- "properties": {
1065
- "label": {
1066
- "type": "string"
1067
- },
1068
- "description": {
1069
- "type": "string"
1070
- },
1071
- "type": {
1072
- "type": "string",
1073
- "enum": [
1074
- "String",
1075
- "Text",
1076
- "Integer",
1077
- "Float",
1078
- "Datetime",
1079
- "Boolean"
1080
- ]
1081
- },
1082
- "protected": {
1083
- "type": "boolean"
1084
- }
1085
- }
1086
- },
1087
- {
1088
- "title": "Resource",
1089
- "type": "object",
1090
- "properties": {
1091
- "label": {
1092
- "type": "string"
1093
- },
1094
- "description": {
1095
- "type": "string"
1096
- },
1097
- "type": {
1098
- "type": "string",
1099
- "enum": [
1100
- "Resource"
1101
- ]
1102
- },
1103
- "resource": {
1104
- "type": "array"
1105
- },
1106
- "value_id": {
1107
- "type": "string"
1108
- },
1109
- "value_label": {
1110
- "type": "string"
1111
- },
1112
- "value": {
1113
- "type": "object",
1114
- "properties": {
1115
- "url": {
1116
- "type": "string"
1117
- },
1118
- "method": {
1119
- "type": "string"
1120
- },
1121
- "help": {
1122
- "type": "string"
1123
- }
1124
- }
1125
- },
1126
- "choices": {
1127
- "type": "object",
1128
- "properties": {
1129
- "url": {
1130
- "type": "string"
1131
- },
1132
- "method": {
1133
- "type": "string"
1134
- },
1135
- "help": {
1136
- "type": "string"
1137
- }
1138
- }
1139
- }
1140
- }
1141
- }
1142
- ]
1143
- }
1144
- }
1145
- },
1146
- "layout": {
1147
- "type": "string",
1148
- "enum": [
1149
- "hash",
1150
- "hash_list",
1151
- "object",
1152
- "object_list"
1153
- ]
1154
- },
1155
- "namespace": {
1156
- "type": "string"
1157
- }
1158
- }
1159
- },
1160
- "action_meta": {
1161
- "type": "object",
1162
- "properties": {
1163
- "object": {
1164
- "input": {
1165
- "$ref": "#/definitions/input_parameters"
1166
- },
1167
- "output": {
1168
- "$ref": "#/definitions/output_parameters"
1169
- }
1170
- },
1171
- "global": {
1172
- "input": {
1173
- "$ref": "#/definitions/input_parameters"
1174
- },
1175
- "output": {
1176
- "$ref": "#/definitions/output_parameters"
1177
- }
1178
- }
1179
- }
1180
- }
1181
- }</code></pre>
1182
-