27db769f62ad7bc4704d94f52a44510455452a8f
[music.git] / docs / swagger.json
1 {
2   "swagger": "2.0",
3   "info": {
4     "version": "1.0.0",
5     "title": ""
6   },
7   "host": "localhost:8080",
8   "basePath": "/MUSIC/rest",
9   "tags": [
10     {
11       "name": "Data Api"
12     },
13     {
14       "name": "Healthcheck Api"
15     },
16     {
17       "name": "Lock Api"
18     },
19     {
20       "name": "Q Api"
21     },
22     {
23       "name": "Test Api"
24     },
25     {
26       "name": "Version Api"
27     }
28   ],
29   "schemes": [
30     "http"
31   ],
32   "paths": {
33     "/v2/keyspaces/{keyspace}/tables/{tablename}/rows": {
34       "get": {
35         "tags": [
36           "Data Api"
37         ],
38         "summary": "Select All or Select Specific",
39         "description": "",
40         "operationId": "select",
41         "produces": [
42           "application/json"
43         ],
44         "parameters": [
45           {
46             "name": "version",
47             "in": "path",
48             "description": "Major Version",
49             "required": true,
50             "type": "string"
51           },
52           {
53             "name": "X-minorVersion",
54             "in": "header",
55             "description": "Minor Version",
56             "required": false,
57             "type": "string"
58           },
59           {
60             "name": "X-patchVersion",
61             "in": "header",
62             "description": "Patch Version",
63             "required": false,
64             "type": "string"
65           },
66           {
67             "name": "aid",
68             "in": "header",
69             "description": "AID",
70             "required": true,
71             "type": "string"
72           },
73           {
74             "name": "ns",
75             "in": "header",
76             "description": "Application namespace",
77             "required": true,
78             "type": "string"
79           },
80           {
81             "name": "Authorization",
82             "in": "header",
83             "description": "Authorization",
84             "required": true,
85             "type": "string"
86           },
87           {
88             "name": "keyspace",
89             "in": "path",
90             "description": "Keyspace Name",
91             "required": true,
92             "type": "string"
93           },
94           {
95             "name": "tablename",
96             "in": "path",
97             "description": "Table Name",
98             "required": true,
99             "type": "string"
100           }
101         ],
102         "responses": {
103           "200": {
104             "description": "successful operation",
105             "schema": {
106               "type": "object",
107               "additionalProperties": {
108                 "type": "object"
109               }
110             }
111           }
112         }
113       },
114       "post": {
115         "tags": [
116           "Data Api"
117         ],
118         "summary": "Insert Into Table",
119         "description": "",
120         "operationId": "insertIntoTable",
121         "consumes": [
122           "application/json"
123         ],
124         "produces": [
125           "application/json"
126         ],
127         "parameters": [
128           {
129             "name": "version",
130             "in": "path",
131             "description": "Major Version",
132             "required": true,
133             "type": "string"
134           },
135           {
136             "name": "X-minorVersion",
137             "in": "header",
138             "description": "Minor Version",
139             "required": false,
140             "type": "string"
141           },
142           {
143             "name": "X-patchVersion",
144             "in": "header",
145             "description": "Patch Version",
146             "required": false,
147             "type": "string"
148           },
149           {
150             "name": "aid",
151             "in": "header",
152             "description": "AID",
153             "required": true,
154             "type": "string"
155           },
156           {
157             "name": "ns",
158             "in": "header",
159             "description": "Application namespace",
160             "required": true,
161             "type": "string"
162           },
163           {
164             "name": "Authorization",
165             "in": "header",
166             "description": "Authorization",
167             "required": true,
168             "type": "string"
169           },
170           {
171             "in": "body",
172             "name": "body",
173             "required": false,
174             "schema": {
175               "$ref": "#/definitions/JsonTable"
176             }
177           },
178           {
179             "name": "keyspace",
180             "in": "path",
181             "description": "Keyspace Name",
182             "required": true,
183             "type": "string"
184           },
185           {
186             "name": "tablename",
187             "in": "path",
188             "description": "Table Name",
189             "required": true,
190             "type": "string"
191           }
192         ],
193         "responses": {
194           "200": {
195             "description": "successful operation",
196             "schema": {
197               "type": "string"
198             }
199           }
200         }
201       },
202       "put": {
203         "tags": [
204           "Data Api"
205         ],
206         "summary": "Update Table",
207         "description": "",
208         "operationId": "updateTable",
209         "consumes": [
210           "application/json"
211         ],
212         "produces": [
213           "application/json"
214         ],
215         "parameters": [
216           {
217             "name": "version",
218             "in": "path",
219             "description": "Major Version",
220             "required": true,
221             "type": "string"
222           },
223           {
224             "name": "X-minorVersion",
225             "in": "header",
226             "description": "Minor Version",
227             "required": false,
228             "type": "string"
229           },
230           {
231             "name": "X-patchVersion",
232             "in": "header",
233             "description": "Patch Version",
234             "required": false,
235             "type": "string"
236           },
237           {
238             "name": "aid",
239             "in": "header",
240             "description": "AID",
241             "required": true,
242             "type": "string"
243           },
244           {
245             "name": "ns",
246             "in": "header",
247             "description": "Application namespace",
248             "required": true,
249             "type": "string"
250           },
251           {
252             "name": "Authorization",
253             "in": "header",
254             "description": "Authorization",
255             "required": true,
256             "type": "string"
257           },
258           {
259             "in": "body",
260             "name": "body",
261             "required": false,
262             "schema": {
263               "$ref": "#/definitions/JsonTable"
264             }
265           },
266           {
267             "name": "keyspace",
268             "in": "path",
269             "description": "Keyspace Name",
270             "required": true,
271             "type": "string"
272           },
273           {
274             "name": "tablename",
275             "in": "path",
276             "description": "Table Name",
277             "required": true,
278             "type": "string"
279           }
280         ],
281         "responses": {
282           "200": {
283             "description": "successful operation",
284             "schema": {
285               "type": "string"
286             }
287           }
288         }
289       },
290       "delete": {
291         "tags": [
292           "Data Api"
293         ],
294         "summary": "Delete From table",
295         "description": "",
296         "operationId": "deleteFromTable",
297         "consumes": [
298           "application/json"
299         ],
300         "produces": [
301           "application/json"
302         ],
303         "parameters": [
304           {
305             "name": "version",
306             "in": "path",
307             "description": "Major Version",
308             "required": true,
309             "type": "string"
310           },
311           {
312             "name": "X-minorVersion",
313             "in": "header",
314             "description": "Minor Version",
315             "required": false,
316             "type": "string"
317           },
318           {
319             "name": "X-patchVersion",
320             "in": "header",
321             "description": "Patch Version",
322             "required": false,
323             "type": "string"
324           },
325           {
326             "name": "aid",
327             "in": "header",
328             "description": "AID",
329             "required": true,
330             "type": "string"
331           },
332           {
333             "name": "ns",
334             "in": "header",
335             "description": "Application namespace",
336             "required": true,
337             "type": "string"
338           },
339           {
340             "name": "Authorization",
341             "in": "header",
342             "description": "Authorization",
343             "required": true,
344             "type": "string"
345           },
346           {
347             "in": "body",
348             "name": "body",
349             "required": false,
350             "schema": {
351               "$ref": "#/definitions/JsonTable"
352             }
353           },
354           {
355             "name": "keyspace",
356             "in": "path",
357             "description": "Keyspace Name",
358             "required": true,
359             "type": "string"
360           },
361           {
362             "name": "tablename",
363             "in": "path",
364             "description": "Table Name",
365             "required": true,
366             "type": "string"
367           }
368         ],
369         "responses": {
370           "200": {
371             "description": "successful operation",
372             "schema": {
373               "type": "string"
374             }
375           }
376         }
377       }
378     },
379     "/v2/keyspaces/{name}": {
380       "post": {
381         "tags": [
382           "Data Api"
383         ],
384         "summary": "Create Keyspace",
385         "description": "",
386         "operationId": "createKeySpace",
387         "consumes": [
388           "application/json"
389         ],
390         "produces": [
391           "application/json"
392         ],
393         "parameters": [
394           {
395             "name": "version",
396             "in": "path",
397             "description": "Major Version",
398             "required": true,
399             "type": "string"
400           },
401           {
402             "name": "X-minorVersion",
403             "in": "header",
404             "description": "Minor Version",
405             "required": false,
406             "type": "string"
407           },
408           {
409             "name": "X-patchVersion",
410             "in": "header",
411             "description": "Patch Version",
412             "required": false,
413             "type": "string"
414           },
415           {
416             "name": "aid",
417             "in": "header",
418             "description": "AID",
419             "required": true,
420             "type": "string"
421           },
422           {
423             "name": "Authorization",
424             "in": "header",
425             "description": "Authorization",
426             "required": true,
427             "type": "string"
428           },
429           {
430             "name": "ns",
431             "in": "header",
432             "description": "Application namespace",
433             "required": true,
434             "type": "string"
435           },
436           {
437             "in": "body",
438             "name": "body",
439             "required": false,
440             "schema": {
441               "$ref": "#/definitions/JsonTable"
442             }
443           },
444           {
445             "name": "name",
446             "in": "path",
447             "description": "Keyspace Name",
448             "required": true,
449             "type": "string"
450           }
451         ],
452         "responses": {
453           "200": {
454             "description": "successful operation",
455             "schema": {
456               "type": "string"
457             }
458           }
459         }
460       },
461       "delete": {
462         "tags": [
463           "Data Api"
464         ],
465         "summary": "Delete Keyspace",
466         "description": "",
467         "operationId": "dropKeySpace",
468         "produces": [
469           "application/json"
470         ],
471         "parameters": [
472           {
473             "name": "version",
474             "in": "path",
475             "description": "Major Version",
476             "required": true,
477             "type": "string"
478           },
479           {
480             "name": "X-minorVersion",
481             "in": "header",
482             "description": "Minor Version",
483             "required": false,
484             "type": "string"
485           },
486           {
487             "name": "X-patchVersion",
488             "in": "header",
489             "description": "Patch Version",
490             "required": false,
491             "type": "string"
492           },
493           {
494             "name": "aid",
495             "in": "header",
496             "description": "AID",
497             "required": true,
498             "type": "string"
499           },
500           {
501             "name": "Authorization",
502             "in": "header",
503             "description": "Authorization",
504             "required": true,
505             "type": "string"
506           },
507           {
508             "name": "ns",
509             "in": "header",
510             "description": "Application namespace",
511             "required": true,
512             "type": "string"
513           },
514           {
515             "name": "name",
516             "in": "path",
517             "description": "Keyspace Name",
518             "required": true,
519             "type": "string"
520           }
521         ],
522         "responses": {
523           "200": {
524             "description": "successful operation",
525             "schema": {
526               "type": "string"
527             }
528           }
529         }
530       }
531     },
532     "/v2/keyspaces/{keyspace}/tables/{tablename}/index/{field}": {
533       "post": {
534         "tags": [
535           "Data Api"
536         ],
537         "summary": "Create Index",
538         "description": "",
539         "operationId": "createIndex",
540         "produces": [
541           "application/json"
542         ],
543         "parameters": [
544           {
545             "name": "version",
546             "in": "path",
547             "description": "Major Version",
548             "required": true,
549             "type": "string"
550           },
551           {
552             "name": "X-minorVersion",
553             "in": "header",
554             "description": "Minor Version",
555             "required": false,
556             "type": "string"
557           },
558           {
559             "name": "X-patchVersion",
560             "in": "header",
561             "description": "Patch Version",
562             "required": false,
563             "type": "string"
564           },
565           {
566             "name": "aid",
567             "in": "header",
568             "description": "AID",
569             "required": true,
570             "type": "string"
571           },
572           {
573             "name": "ns",
574             "in": "header",
575             "description": "Application namespace",
576             "required": true,
577             "type": "string"
578           },
579           {
580             "name": "Authorization",
581             "in": "header",
582             "description": "Authorization",
583             "required": true,
584             "type": "string"
585           },
586           {
587             "name": "keyspace",
588             "in": "path",
589             "description": "Keyspace Name",
590             "required": true,
591             "type": "string"
592           },
593           {
594             "name": "tablename",
595             "in": "path",
596             "description": "Table Name",
597             "required": true,
598             "type": "string"
599           },
600           {
601             "name": "field",
602             "in": "path",
603             "description": "Field Name",
604             "required": true,
605             "type": "string"
606           }
607         ],
608         "responses": {
609           "200": {
610             "description": "successful operation",
611             "schema": {
612               "type": "string"
613             }
614           }
615         }
616       }
617     },
618     "/v2/keyspaces/{keyspace}/tables/{tablename}/rows/criticalget": {
619       "put": {
620         "tags": [
621           "Data Api"
622         ],
623         "summary": "Select Critical",
624         "description": "",
625         "operationId": "selectCritical",
626         "consumes": [
627           "application/json"
628         ],
629         "produces": [
630           "application/json"
631         ],
632         "parameters": [
633           {
634             "name": "version",
635             "in": "path",
636             "description": "Major Version",
637             "required": true,
638             "type": "string"
639           },
640           {
641             "name": "X-minorVersion",
642             "in": "header",
643             "description": "Minor Version",
644             "required": false,
645             "type": "string"
646           },
647           {
648             "name": "X-patchVersion",
649             "in": "header",
650             "description": "Patch Version",
651             "required": false,
652             "type": "string"
653           },
654           {
655             "name": "aid",
656             "in": "header",
657             "description": "AID",
658             "required": true,
659             "type": "string"
660           },
661           {
662             "name": "ns",
663             "in": "header",
664             "description": "Application namespace",
665             "required": true,
666             "type": "string"
667           },
668           {
669             "name": "Authorization",
670             "in": "header",
671             "description": "Authorization",
672             "required": true,
673             "type": "string"
674           },
675           {
676             "in": "body",
677             "name": "body",
678             "required": false,
679             "schema": {
680               "$ref": "#/definitions/JsonTable"
681             }
682           },
683           {
684             "name": "keyspace",
685             "in": "path",
686             "description": "Keyspace Name",
687             "required": true,
688             "type": "string"
689           },
690           {
691             "name": "tablename",
692             "in": "path",
693             "description": "Table Name",
694             "required": true,
695             "type": "string"
696           }
697         ],
698         "responses": {
699           "200": {
700             "description": "successful operation",
701             "schema": {
702               "type": "object",
703               "additionalProperties": {
704                 "type": "object"
705               }
706             }
707           }
708         }
709       }
710     },
711     "/v2/keyspaces/{keyspace}/tables/{tablename}": {
712       "post": {
713         "tags": [
714           "Data Api"
715         ],
716         "summary": "Create Table",
717         "description": "",
718         "operationId": "createTable",
719         "consumes": [
720           "application/json"
721         ],
722         "produces": [
723           "application/json"
724         ],
725         "parameters": [
726           {
727             "name": "version",
728             "in": "path",
729             "description": "Major Version",
730             "required": true,
731             "type": "string"
732           },
733           {
734             "name": "X-minorVersion",
735             "in": "header",
736             "description": "Minor Version",
737             "required": false,
738             "type": "string"
739           },
740           {
741             "name": "X-patchVersion",
742             "in": "header",
743             "description": "Patch Version",
744             "required": false,
745             "type": "string"
746           },
747           {
748             "name": "aid",
749             "in": "header",
750             "description": "AID",
751             "required": true,
752             "type": "string"
753           },
754           {
755             "name": "ns",
756             "in": "header",
757             "description": "Application namespace",
758             "required": true,
759             "type": "string"
760           },
761           {
762             "name": "Authorization",
763             "in": "header",
764             "description": "Authorization",
765             "required": true,
766             "type": "string"
767           },
768           {
769             "in": "body",
770             "name": "body",
771             "required": false,
772             "schema": {
773               "$ref": "#/definitions/JsonTable"
774             }
775           },
776           {
777             "name": "keyspace",
778             "in": "path",
779             "description": "Keyspace Name",
780             "required": true,
781             "type": "string"
782           },
783           {
784             "name": "tablename",
785             "in": "path",
786             "description": "Table Name",
787             "required": true,
788             "type": "string"
789           }
790         ],
791         "responses": {
792           "200": {
793             "description": "successful operation",
794             "schema": {
795               "type": "string"
796             }
797           }
798         }
799       },
800       "delete": {
801         "tags": [
802           "Data Api"
803         ],
804         "summary": "Drop Table",
805         "description": "",
806         "operationId": "dropTable",
807         "produces": [
808           "application/json"
809         ],
810         "parameters": [
811           {
812             "name": "version",
813             "in": "path",
814             "description": "Major Version",
815             "required": true,
816             "type": "string"
817           },
818           {
819             "name": "X-minorVersion",
820             "in": "header",
821             "description": "Minor Version",
822             "required": false,
823             "type": "string"
824           },
825           {
826             "name": "X-patchVersion",
827             "in": "header",
828             "description": "Patch Version",
829             "required": false,
830             "type": "string"
831           },
832           {
833             "name": "aid",
834             "in": "header",
835             "description": "AID",
836             "required": true,
837             "type": "string"
838           },
839           {
840             "name": "ns",
841             "in": "header",
842             "description": "Application namespace",
843             "required": true,
844             "type": "string"
845           },
846           {
847             "name": "Authorization",
848             "in": "header",
849             "description": "Authorization",
850             "required": true,
851             "type": "string"
852           },
853           {
854             "name": "keyspace",
855             "in": "path",
856             "description": "Keyspace Name",
857             "required": true,
858             "type": "string"
859           },
860           {
861             "name": "tablename",
862             "in": "path",
863             "description": "Table Name",
864             "required": true,
865             "type": "string"
866           }
867         ],
868         "responses": {
869           "200": {
870             "description": "successful operation",
871             "schema": {
872               "type": "string"
873             }
874           }
875         }
876       }
877     },
878     "/v{version}/service/pingCassandra/{consistency}": {
879       "get": {
880         "tags": [
881           "Healthcheck Api"
882         ],
883         "summary": "Get Health Status",
884         "description": "",
885         "operationId": "cassandraStatus",
886         "produces": [
887           "application/json"
888         ],
889         "parameters": [
890           {
891             "name": "consistency",
892             "in": "path",
893             "description": "Consistency level",
894             "required": true,
895             "type": "string"
896           }
897         ],
898         "responses": {
899           "200": {
900             "description": "successful operation",
901             "schema": {
902               "type": "object",
903               "additionalProperties": {
904                 "type": "object"
905               }
906             }
907           }
908         }
909       }
910     },
911     "/v{version}/service/pingZookeeper": {
912       "get": {
913         "tags": [
914           "Healthcheck Api"
915         ],
916         "summary": "Get Health Status",
917         "description": "",
918         "operationId": "ZKStatus",
919         "produces": [
920           "application/json"
921         ],
922         "parameters": [],
923         "responses": {
924           "200": {
925             "description": "successful operation",
926             "schema": {
927               "type": "object",
928               "additionalProperties": {
929                 "type": "object"
930               }
931             }
932           }
933         }
934       }
935     },
936     "/v2/locks/create/{lockname}": {
937       "post": {
938         "tags": [
939           "Lock Api"
940         ],
941         "summary": "Create Lock",
942         "description": "Puts the requesting process in the q for this lock. The corresponding node will be created in zookeeper if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId",
943         "operationId": "createLockReference",
944         "produces": [
945           "application/json"
946         ],
947         "parameters": [
948           {
949             "name": "lockname",
950             "in": "path",
951             "description": "Lock Name",
952             "required": true,
953             "type": "string"
954           },
955           {
956             "name": "X-minorVersion",
957             "in": "header",
958             "description": "Minor Version",
959             "required": false,
960             "type": "string"
961           },
962           {
963             "name": "X-patchVersion",
964             "in": "header",
965             "description": "Patch Version",
966             "required": false,
967             "type": "string"
968           },
969           {
970             "name": "Authorization",
971             "in": "header",
972             "description": "Authorization",
973             "required": true,
974             "type": "string"
975           },
976           {
977             "name": "aid",
978             "in": "header",
979             "description": "AID",
980             "required": true,
981             "type": "string"
982           },
983           {
984             "name": "ns",
985             "in": "header",
986             "description": "Application namespace",
987             "required": true,
988             "type": "string"
989           }
990         ],
991         "responses": {
992           "200": {
993             "description": "successful operation",
994             "schema": {
995               "type": "object",
996               "additionalProperties": {
997                 "type": "object"
998               }
999             }
1000           }
1001         }
1002       }
1003     },
1004     "/v2/locks/acquire/{lockreference}": {
1005       "get": {
1006         "tags": [
1007           "Lock Api"
1008         ],
1009         "summary": "Aquire Lock",
1010         "description": "Checks if the node is in the top of the queue and hence acquires the lock",
1011         "operationId": "accquireLock",
1012         "produces": [
1013           "application/json"
1014         ],
1015         "parameters": [
1016           {
1017             "name": "lockreference",
1018             "in": "path",
1019             "description": "Lock Reference",
1020             "required": true,
1021             "type": "string"
1022           },
1023           {
1024             "name": "X-minorVersion",
1025             "in": "header",
1026             "description": "Minor Version",
1027             "required": false,
1028             "type": "string"
1029           },
1030           {
1031             "name": "X-patchVersion",
1032             "in": "header",
1033             "description": "Patch Version",
1034             "required": false,
1035             "type": "string"
1036           },
1037           {
1038             "name": "Authorization",
1039             "in": "header",
1040             "description": "Authorization",
1041             "required": true,
1042             "type": "string"
1043           },
1044           {
1045             "name": "aid",
1046             "in": "header",
1047             "description": "AID",
1048             "required": true,
1049             "type": "string"
1050           },
1051           {
1052             "name": "ns",
1053             "in": "header",
1054             "description": "Application namespace",
1055             "required": true,
1056             "type": "string"
1057           }
1058         ],
1059         "responses": {
1060           "200": {
1061             "description": "successful operation",
1062             "schema": {
1063               "type": "object",
1064               "additionalProperties": {
1065                 "type": "object"
1066               }
1067             }
1068           }
1069         }
1070       }
1071     },
1072     "/v2/locks/acquire-with-lease/{lockreference}": {
1073       "post": {
1074         "tags": [
1075           "Lock Api"
1076         ],
1077         "summary": "Aquire Lock with Lease",
1078         "description": "",
1079         "operationId": "accquireLockWithLease",
1080         "consumes": [
1081           "application/json"
1082         ],
1083         "produces": [
1084           "application/json"
1085         ],
1086         "parameters": [
1087           {
1088             "in": "body",
1089             "name": "body",
1090             "required": false,
1091             "schema": {
1092               "$ref": "#/definitions/JsonTable"
1093             }
1094           },
1095           {
1096             "name": "lockreference",
1097             "in": "path",
1098             "description": "Lock Reference",
1099             "required": true,
1100             "type": "string"
1101           },
1102           {
1103             "name": "X-minorVersion",
1104             "in": "header",
1105             "description": "Minor Version",
1106             "required": false,
1107             "type": "string"
1108           },
1109           {
1110             "name": "X-patchVersion",
1111             "in": "header",
1112             "description": "Patch Version",
1113             "required": false,
1114             "type": "string"
1115           },
1116           {
1117             "name": "Authorization",
1118             "in": "header",
1119             "description": "Authorization",
1120             "required": true,
1121             "type": "string"
1122           },
1123           {
1124             "name": "aid",
1125             "in": "header",
1126             "description": "AID",
1127             "required": true,
1128             "type": "string"
1129           },
1130           {
1131             "name": "ns",
1132             "in": "header",
1133             "description": "Application namespace",
1134             "required": true,
1135             "type": "string"
1136           }
1137         ],
1138         "responses": {
1139           "200": {
1140             "description": "successful operation",
1141             "schema": {
1142               "type": "object",
1143               "additionalProperties": {
1144                 "type": "object"
1145               }
1146             }
1147           }
1148         }
1149       }
1150     },
1151     "/v2/locks/enquire/{lockname}": {
1152       "get": {
1153         "tags": [
1154           "Lock Api"
1155         ],
1156         "summary": "Get Lock Holder",
1157         "description": "Gets the current Lock Holder",
1158         "operationId": "currentLockHolder",
1159         "produces": [
1160           "application/json"
1161         ],
1162         "parameters": [
1163           {
1164             "name": "lockname",
1165             "in": "path",
1166             "description": "Lock Name",
1167             "required": true,
1168             "type": "string"
1169           },
1170           {
1171             "name": "X-minorVersion",
1172             "in": "header",
1173             "description": "Minor Version",
1174             "required": false,
1175             "type": "string"
1176           },
1177           {
1178             "name": "X-patchVersion",
1179             "in": "header",
1180             "description": "Patch Version",
1181             "required": false,
1182             "type": "string"
1183           },
1184           {
1185             "name": "Authorization",
1186             "in": "header",
1187             "description": "Authorization",
1188             "required": true,
1189             "type": "string"
1190           },
1191           {
1192             "name": "aid",
1193             "in": "header",
1194             "description": "AID",
1195             "required": true,
1196             "type": "string"
1197           },
1198           {
1199             "name": "ns",
1200             "in": "header",
1201             "description": "Application namespace",
1202             "required": true,
1203             "type": "string"
1204           }
1205         ],
1206         "responses": {
1207           "200": {
1208             "description": "successful operation",
1209             "schema": {
1210               "type": "object",
1211               "additionalProperties": {
1212                 "type": "object"
1213               }
1214             }
1215           }
1216         }
1217       }
1218     },
1219     "/v2/locks/{lockname}": {
1220       "get": {
1221         "tags": [
1222           "Lock Api"
1223         ],
1224         "summary": "Lock State",
1225         "description": "Returns current Lock State and Holder.",
1226         "operationId": "currentLockState",
1227         "produces": [
1228           "application/json"
1229         ],
1230         "parameters": [
1231           {
1232             "name": "lockname",
1233             "in": "path",
1234             "description": "Lock Name",
1235             "required": true,
1236             "type": "string"
1237           },
1238           {
1239             "name": "X-minorVersion",
1240             "in": "header",
1241             "description": "Minor Version",
1242             "required": false,
1243             "type": "string"
1244           },
1245           {
1246             "name": "X-patchVersion",
1247             "in": "header",
1248             "description": "Patch Version",
1249             "required": false,
1250             "type": "string"
1251           },
1252           {
1253             "name": "Authorization",
1254             "in": "header",
1255             "description": "Authorization",
1256             "required": true,
1257             "type": "string"
1258           },
1259           {
1260             "name": "aid",
1261             "in": "header",
1262             "description": "AID",
1263             "required": true,
1264             "type": "string"
1265           },
1266           {
1267             "name": "ns",
1268             "in": "header",
1269             "description": "Application namespace",
1270             "required": true,
1271             "type": "string"
1272           },
1273           {
1274             "name": "userId",
1275             "in": "header",
1276             "description": "userId",
1277             "required": true,
1278             "type": "string"
1279           },
1280           {
1281             "name": "password",
1282             "in": "header",
1283             "description": "Password",
1284             "required": true,
1285             "type": "string"
1286           }
1287         ],
1288         "responses": {
1289           "200": {
1290             "description": "successful operation",
1291             "schema": {
1292               "type": "object",
1293               "additionalProperties": {
1294                 "type": "object"
1295               }
1296             }
1297           }
1298         }
1299       }
1300     },
1301     "/v2/locks/release/{lockreference}": {
1302       "delete": {
1303         "tags": [
1304           "Lock Api"
1305         ],
1306         "summary": "Release Lock",
1307         "description": "deletes the process from the zk queue",
1308         "operationId": "unLock",
1309         "produces": [
1310           "application/json"
1311         ],
1312         "parameters": [
1313           {
1314             "name": "lockreference",
1315             "in": "path",
1316             "required": true,
1317             "type": "string"
1318           },
1319           {
1320             "name": "X-minorVersion",
1321             "in": "header",
1322             "description": "Minor Version",
1323             "required": false,
1324             "type": "string"
1325           },
1326           {
1327             "name": "X-patchVersion",
1328             "in": "header",
1329             "description": "Patch Version",
1330             "required": false,
1331             "type": "string"
1332           },
1333           {
1334             "name": "Authorization",
1335             "in": "header",
1336             "description": "Authorization",
1337             "required": true,
1338             "type": "string"
1339           },
1340           {
1341             "name": "aid",
1342             "in": "header",
1343             "description": "AID",
1344             "required": true,
1345             "type": "string"
1346           },
1347           {
1348             "name": "ns",
1349             "in": "header",
1350             "description": "Application namespace",
1351             "required": true,
1352             "type": "string"
1353           }
1354         ],
1355         "responses": {
1356           "200": {
1357             "description": "successful operation",
1358             "schema": {
1359               "type": "object",
1360               "additionalProperties": {
1361                 "type": "object"
1362               }
1363             }
1364           }
1365         }
1366       }
1367     },
1368     "/v2/locks/delete/{lockname}": {
1369       "delete": {
1370         "tags": [
1371           "Lock Api"
1372         ],
1373         "summary": "Delete Lock",
1374         "description": "",
1375         "operationId": "deleteLock",
1376         "produces": [
1377           "application/json"
1378         ],
1379         "parameters": [
1380           {
1381             "name": "lockname",
1382             "in": "path",
1383             "required": true,
1384             "type": "string"
1385           },
1386           {
1387             "name": "X-minorVersion",
1388             "in": "header",
1389             "description": "Minor Version",
1390             "required": false,
1391             "type": "string"
1392           },
1393           {
1394             "name": "X-patchVersion",
1395             "in": "header",
1396             "description": "Patch Version",
1397             "required": false,
1398             "type": "string"
1399           },
1400           {
1401             "name": "aid",
1402             "in": "header",
1403             "description": "AID",
1404             "required": true,
1405             "type": "string"
1406           },
1407           {
1408             "name": "Authorization",
1409             "in": "header",
1410             "description": "Authorization",
1411             "required": true,
1412             "type": "string"
1413           },
1414           {
1415             "name": "ns",
1416             "in": "header",
1417             "description": "Application namespace",
1418             "required": true,
1419             "type": "string"
1420           }
1421         ],
1422         "responses": {
1423           "200": {
1424             "description": "successful operation",
1425             "schema": {
1426               "type": "object",
1427               "additionalProperties": {
1428                 "type": "object"
1429               }
1430             }
1431           }
1432         }
1433       }
1434     },
1435     "/{version}/priorityq/keyspaces/{keyspace}/{qname}": {
1436       "post": {
1437         "tags": [
1438           "Q Api"
1439         ],
1440         "summary": "Create Q",
1441         "description": "",
1442         "operationId": "createQ",
1443         "consumes": [
1444           "application/json"
1445         ],
1446         "produces": [
1447           "application/json"
1448         ],
1449         "parameters": [
1450           {
1451             "name": "version",
1452             "in": "path",
1453             "description": "Major Version",
1454             "required": true,
1455             "type": "string"
1456           },
1457           {
1458             "name": "X-minorVersion",
1459             "in": "header",
1460             "description": "Minor Version",
1461             "required": false,
1462             "type": "string"
1463           },
1464           {
1465             "name": "X-patchVersion",
1466             "in": "header",
1467             "description": "Patch Version",
1468             "required": false,
1469             "type": "string"
1470           },
1471           {
1472             "name": "aid",
1473             "in": "header",
1474             "description": "AID",
1475             "required": true,
1476             "type": "string"
1477           },
1478           {
1479             "name": "ns",
1480             "in": "header",
1481             "description": "Application namespace",
1482             "required": true,
1483             "type": "string"
1484           },
1485           {
1486             "name": "Authorization",
1487             "in": "header",
1488             "description": "Authorization",
1489             "required": true,
1490             "type": "string"
1491           },
1492           {
1493             "in": "body",
1494             "name": "body",
1495             "required": false,
1496             "schema": {
1497               "$ref": "#/definitions/JsonTable"
1498             }
1499           },
1500           {
1501             "name": "keyspace",
1502             "in": "path",
1503             "description": "Key Space",
1504             "required": true,
1505             "type": "string"
1506           },
1507           {
1508             "name": "qname",
1509             "in": "path",
1510             "description": "Table Name",
1511             "required": true,
1512             "type": "string"
1513           }
1514         ],
1515         "responses": {
1516           "200": {
1517             "description": "successful operation",
1518             "schema": {
1519               "type": "string"
1520             }
1521           }
1522         }
1523       },
1524       "delete": {
1525         "tags": [
1526           "Q Api"
1527         ],
1528         "summary": "DropQ",
1529         "description": "",
1530         "operationId": "dropQ",
1531         "produces": [
1532           "application/json"
1533         ],
1534         "parameters": [
1535           {
1536             "name": "version",
1537             "in": "path",
1538             "description": "Major Version",
1539             "required": true,
1540             "type": "string"
1541           },
1542           {
1543             "name": "X-minorVersion",
1544             "in": "header",
1545             "description": "Minor Version",
1546             "required": false,
1547             "type": "string"
1548           },
1549           {
1550             "name": "X-patchVersion",
1551             "in": "header",
1552             "description": "Patch Version",
1553             "required": false,
1554             "type": "string"
1555           },
1556           {
1557             "name": "aid",
1558             "in": "header",
1559             "description": "AID",
1560             "required": true,
1561             "type": "string"
1562           },
1563           {
1564             "name": "ns",
1565             "in": "header",
1566             "description": "Application namespace",
1567             "required": true,
1568             "type": "string"
1569           },
1570           {
1571             "name": "Authorization",
1572             "in": "header",
1573             "description": "Authorization",
1574             "required": true,
1575             "type": "string"
1576           },
1577           {
1578             "name": "keyspace",
1579             "in": "path",
1580             "description": "Key Space",
1581             "required": true,
1582             "type": "string"
1583           },
1584           {
1585             "name": "qname",
1586             "in": "path",
1587             "description": "Table Name",
1588             "required": true,
1589             "type": "string"
1590           }
1591         ],
1592         "responses": {
1593           "200": {
1594             "description": "successful operation",
1595             "schema": {
1596               "type": "string"
1597             }
1598           }
1599         }
1600       }
1601     },
1602     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/rows": {
1603       "post": {
1604         "tags": [
1605           "Q Api"
1606         ],
1607         "summary": "",
1608         "description": "",
1609         "operationId": "insertIntoQ",
1610         "consumes": [
1611           "application/json"
1612         ],
1613         "produces": [
1614           "application/json"
1615         ],
1616         "parameters": [
1617           {
1618             "name": "version",
1619             "in": "path",
1620             "description": "Major Version",
1621             "required": true,
1622             "type": "string"
1623           },
1624           {
1625             "name": "X-minorVersion",
1626             "in": "header",
1627             "description": "Minor Version",
1628             "required": false,
1629             "type": "string"
1630           },
1631           {
1632             "name": "X-patchVersion",
1633             "in": "header",
1634             "description": "Patch Version",
1635             "required": false,
1636             "type": "string"
1637           },
1638           {
1639             "name": "aid",
1640             "in": "header",
1641             "description": "AID",
1642             "required": true,
1643             "type": "string"
1644           },
1645           {
1646             "name": "ns",
1647             "in": "header",
1648             "description": "Application namespace",
1649             "required": true,
1650             "type": "string"
1651           },
1652           {
1653             "name": "Authorization",
1654             "in": "header",
1655             "description": "Authorization",
1656             "required": true,
1657             "type": "string"
1658           },
1659           {
1660             "in": "body",
1661             "name": "body",
1662             "required": false,
1663             "schema": {
1664               "$ref": "#/definitions/JsonTable"
1665             }
1666           },
1667           {
1668             "name": "keyspace",
1669             "in": "path",
1670             "description": "Key Space",
1671             "required": true,
1672             "type": "string"
1673           },
1674           {
1675             "name": "qname",
1676             "in": "path",
1677             "description": "Table Name",
1678             "required": true,
1679             "type": "string"
1680           }
1681         ],
1682         "responses": {
1683           "default": {
1684             "description": "successful operation"
1685           }
1686         }
1687       },
1688       "put": {
1689         "tags": [
1690           "Q Api"
1691         ],
1692         "summary": "updateQ",
1693         "description": "",
1694         "operationId": "updateQ",
1695         "consumes": [
1696           "application/json"
1697         ],
1698         "produces": [
1699           "application/json"
1700         ],
1701         "parameters": [
1702           {
1703             "name": "version",
1704             "in": "path",
1705             "description": "Major Version",
1706             "required": true,
1707             "type": "string"
1708           },
1709           {
1710             "name": "X-minorVersion",
1711             "in": "header",
1712             "description": "Minor Version",
1713             "required": false,
1714             "type": "string"
1715           },
1716           {
1717             "name": "X-patchVersion",
1718             "in": "header",
1719             "description": "Patch Version",
1720             "required": false,
1721             "type": "string"
1722           },
1723           {
1724             "name": "aid",
1725             "in": "header",
1726             "description": "AID",
1727             "required": true,
1728             "type": "string"
1729           },
1730           {
1731             "name": "ns",
1732             "in": "header",
1733             "description": "Application namespace",
1734             "required": true,
1735             "type": "string"
1736           },
1737           {
1738             "name": "Authorization",
1739             "in": "header",
1740             "description": "Authorization",
1741             "required": true,
1742             "type": "string"
1743           },
1744           {
1745             "in": "body",
1746             "name": "body",
1747             "required": false,
1748             "schema": {
1749               "$ref": "#/definitions/JsonTable"
1750             }
1751           },
1752           {
1753             "name": "keyspace",
1754             "in": "path",
1755             "description": "Key Space",
1756             "required": true,
1757             "type": "string"
1758           },
1759           {
1760             "name": "qname",
1761             "in": "path",
1762             "description": "Table Name",
1763             "required": true,
1764             "type": "string"
1765           }
1766         ],
1767         "responses": {
1768           "200": {
1769             "description": "successful operation",
1770             "schema": {
1771               "type": "string"
1772             }
1773           }
1774         }
1775       },
1776       "delete": {
1777         "tags": [
1778           "Q Api"
1779         ],
1780         "summary": "deleteQ",
1781         "description": "",
1782         "operationId": "deleteFromQ",
1783         "consumes": [
1784           "application/json"
1785         ],
1786         "produces": [
1787           "application/json"
1788         ],
1789         "parameters": [
1790           {
1791             "name": "version",
1792             "in": "path",
1793             "description": "Major Version",
1794             "required": true,
1795             "type": "string"
1796           },
1797           {
1798             "name": "X-minorVersion",
1799             "in": "header",
1800             "description": "Minor Version",
1801             "required": false,
1802             "type": "string"
1803           },
1804           {
1805             "name": "X-patchVersion",
1806             "in": "header",
1807             "description": "Patch Version",
1808             "required": false,
1809             "type": "string"
1810           },
1811           {
1812             "name": "aid",
1813             "in": "header",
1814             "description": "AID",
1815             "required": true,
1816             "type": "string"
1817           },
1818           {
1819             "name": "ns",
1820             "in": "header",
1821             "description": "Application namespace",
1822             "required": true,
1823             "type": "string"
1824           },
1825           {
1826             "name": "Authorization",
1827             "in": "header",
1828             "description": "Authorization",
1829             "required": true,
1830             "type": "string"
1831           },
1832           {
1833             "in": "body",
1834             "name": "body",
1835             "required": false,
1836             "schema": {
1837               "$ref": "#/definitions/JsonTable"
1838             }
1839           },
1840           {
1841             "name": "keyspace",
1842             "in": "path",
1843             "description": "Key Space",
1844             "required": true,
1845             "type": "string"
1846           },
1847           {
1848             "name": "qname",
1849             "in": "path",
1850             "description": "Table Name",
1851             "required": true,
1852             "type": "string"
1853           }
1854         ],
1855         "responses": {
1856           "200": {
1857             "description": "successful operation",
1858             "schema": {
1859               "type": "string"
1860             }
1861           }
1862         }
1863       }
1864     },
1865     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/peek": {
1866       "get": {
1867         "tags": [
1868           "Q Api"
1869         ],
1870         "summary": "",
1871         "description": "",
1872         "operationId": "peek",
1873         "produces": [
1874           "application/json"
1875         ],
1876         "parameters": [
1877           {
1878             "name": "version",
1879             "in": "path",
1880             "description": "Major Version",
1881             "required": true,
1882             "type": "string"
1883           },
1884           {
1885             "name": "X-minorVersion",
1886             "in": "header",
1887             "description": "Minor Version",
1888             "required": false,
1889             "type": "string"
1890           },
1891           {
1892             "name": "X-patchVersion",
1893             "in": "header",
1894             "description": "Patch Version",
1895             "required": false,
1896             "type": "string"
1897           },
1898           {
1899             "name": "aid",
1900             "in": "header",
1901             "description": "AID",
1902             "required": true,
1903             "type": "string"
1904           },
1905           {
1906             "name": "ns",
1907             "in": "header",
1908             "description": "Application namespace",
1909             "required": true,
1910             "type": "string"
1911           },
1912           {
1913             "name": "Authorization",
1914             "in": "header",
1915             "description": "Authorization",
1916             "required": true,
1917             "type": "string"
1918           },
1919           {
1920             "name": "keyspace",
1921             "in": "path",
1922             "description": "Key Space",
1923             "required": true,
1924             "type": "string"
1925           },
1926           {
1927             "name": "qname",
1928             "in": "path",
1929             "description": "Table Name",
1930             "required": true,
1931             "type": "string"
1932           }
1933         ],
1934         "responses": {
1935           "200": {
1936             "description": "successful operation",
1937             "schema": {
1938               "type": "object",
1939               "additionalProperties": {
1940                 "type": "object"
1941               }
1942             }
1943           }
1944         }
1945       }
1946     },
1947     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/filter": {
1948       "get": {
1949         "tags": [
1950           "Q Api"
1951         ],
1952         "summary": "filter",
1953         "description": "",
1954         "operationId": "filter",
1955         "produces": [
1956           "application/json"
1957         ],
1958         "parameters": [
1959           {
1960             "name": "version",
1961             "in": "path",
1962             "description": "Major Version",
1963             "required": true,
1964             "type": "string"
1965           },
1966           {
1967             "name": "X-minorVersion",
1968             "in": "header",
1969             "description": "Minor Version",
1970             "required": false,
1971             "type": "string"
1972           },
1973           {
1974             "name": "X-patchVersion",
1975             "in": "header",
1976             "description": "Patch Version",
1977             "required": false,
1978             "type": "string"
1979           },
1980           {
1981             "name": "aid",
1982             "in": "header",
1983             "description": "AID",
1984             "required": true,
1985             "type": "string"
1986           },
1987           {
1988             "name": "ns",
1989             "in": "header",
1990             "description": "Application namespace",
1991             "required": true,
1992             "type": "string"
1993           },
1994           {
1995             "name": "Authorization",
1996             "in": "header",
1997             "description": "Authorization",
1998             "required": true,
1999             "type": "string"
2000           },
2001           {
2002             "name": "keyspace",
2003             "in": "path",
2004             "description": "Key Space",
2005             "required": true,
2006             "type": "string"
2007           },
2008           {
2009             "name": "qname",
2010             "in": "path",
2011             "description": "Table Name",
2012             "required": true,
2013             "type": "string"
2014           }
2015         ],
2016         "responses": {
2017           "200": {
2018             "description": "successful operation",
2019             "schema": {
2020               "type": "object",
2021               "additionalProperties": {
2022                 "type": "object"
2023               }
2024             }
2025           }
2026         }
2027       }
2028     },
2029     "/v{version}/test": {
2030       "get": {
2031         "tags": [
2032           "Test Api"
2033         ],
2034         "summary": "Get Test",
2035         "description": "",
2036         "operationId": "simpleTests",
2037         "produces": [
2038           "application/json"
2039         ],
2040         "parameters": [],
2041         "responses": {
2042           "200": {
2043             "description": "successful operation",
2044             "schema": {
2045               "type": "object",
2046               "additionalProperties": {
2047                 "type": "object"
2048               }
2049             }
2050           }
2051         }
2052       }
2053     },
2054     "/v{version}/version": {
2055       "get": {
2056         "tags": [
2057           "Version Api"
2058         ],
2059         "summary": "Get Version",
2060         "description": "",
2061         "operationId": "version",
2062         "produces": [
2063           "application/json"
2064         ],
2065         "parameters": [],
2066         "responses": {
2067           "200": {
2068             "description": "successful operation",
2069             "schema": {
2070               "type": "object",
2071               "additionalProperties": {
2072                 "type": "object"
2073               }
2074             }
2075           }
2076         }
2077       }
2078     }
2079   },
2080   "definitions": {
2081     "JsonTable": {
2082       "type": "object",
2083       "properties": {
2084         "columns": {
2085           "type": "array",
2086           "description": "Column values",
2087           "items": {
2088             "type": "string"
2089           }
2090         },
2091         "consistencyInfo": {
2092           "type": "object",
2093           "description": "Consistency level",
2094           "additionalProperties": {
2095             "type": "string"
2096           }
2097         },
2098         "conditions": {
2099           "type": "object",
2100           "description": "Conditions",
2101           "additionalProperties": {
2102             "type": "object"
2103           }
2104         },
2105         "ttl": {
2106           "type": "string",
2107           "description": "Time to live information"
2108         },
2109         "timestamp": {
2110           "type": "string",
2111           "description": "Time stamp"
2112         }
2113       },
2114       "description": "Json model for delete"
2115     }
2116   }
2117 }