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/pingZookeeper": {
 879       "get": {
 880         "tags": [
 881           "Healthcheck Api"
 882         ],
 883         "summary": "Get Health Status",
 884         "description": "",
 885         "operationId": "ZKStatus",
 886         "produces": [
 887           "application/json"
 888         ],
 889         "parameters": [],
 890         "responses": {
 891           "200": {
 892             "description": "successful operation",
 893             "schema": {
 894               "type": "object",
 895               "additionalProperties": {
 896                 "type": "object"
 897               }
 898             }
 899           }
 900         }
 901       }
 902     },
 903     "/v{version}/service/musicHealthCheck": {
 904       "get": {
 905         "tags": [
 906           "Healthcheck Api"
 907         ],
 908         "summary": "Get Health Status",
 909         "description": "",
 910         "operationId": "musicHealthCheck",
 911         "produces": [
 912           "application/json"
 913         ],
 914         "parameters": [],
 915         "responses": {
 916           "200": {
 917             "description": "successful operation",
 918             "schema": {
 919               "type": "object",
 920               "additionalProperties": {
 921                 "type": "object"
 922               }
 923             }
 924           }
 925         }
 926       }
 927     },
 928     "/v{version}/service/pingCassandra/{consistency}": {
 929       "get": {
 930         "tags": [
 931           "Healthcheck Api"
 932         ],
 933         "summary": "Get Health Status",
 934         "description": "",
 935         "operationId": "cassandraStatus",
 936         "produces": [
 937           "application/json"
 938         ],
 939         "parameters": [
 940           {
 941             "name": "consistency",
 942             "in": "path",
 943             "description": "Consistency level",
 944             "required": true,
 945             "type": "string"
 946           }
 947         ],
 948         "responses": {
 949           "200": {
 950             "description": "successful operation",
 951             "schema": {
 952               "type": "object",
 953               "additionalProperties": {
 954                 "type": "object"
 955               }
 956             }
 957           }
 958         }
 959       }
 960     },
 961     "/v2/locks/create/{lockname}": {
 962       "post": {
 963         "tags": [
 964           "Lock Api"
 965         ],
 966         "summary": "Create Lock",
 967         "description": "Puts the requesting process in the q for this lock. The corresponding lock will be created if it did not already exist. Lock Name is the \"key\" of the form keyspaceName.tableName.rowId",
 968         "operationId": "createLockReference",
 969         "produces": [
 970           "application/json"
 971         ],
 972         "parameters": [
 973           {
 974             "name": "lockname",
 975             "in": "path",
 976             "description": "Lock Name",
 977             "required": true,
 978             "type": "string"
 979           },
 980           {
 981             "name": "X-minorVersion",
 982             "in": "header",
 983             "description": "Minor Version",
 984             "required": false,
 985             "type": "string"
 986           },
 987           {
 988             "name": "X-patchVersion",
 989             "in": "header",
 990             "description": "Patch Version",
 991             "required": false,
 992             "type": "string"
 993           },
 994           {
 995             "name": "Authorization",
 996             "in": "header",
 997             "description": "Authorization",
 998             "required": true,
 999             "type": "string"
1000           },
1001           {
1002             "name": "aid",
1003             "in": "header",
1004             "description": "AID",
1005             "required": true,
1006             "type": "string"
1007           },
1008           {
1009             "name": "ns",
1010             "in": "header",
1011             "description": "Application namespace",
1012             "required": true,
1013             "type": "string"
1014           }
1015         ],
1016         "responses": {
1017           "200": {
1018             "description": "successful operation",
1019             "schema": {
1020               "type": "object",
1021               "additionalProperties": {
1022                 "type": "object"
1023               }
1024             }
1025           }
1026         }
1027       }
1028     },
1029     "/v2/locks/acquire/{lockreference}": {
1030       "get": {
1031         "tags": [
1032           "Lock Api"
1033         ],
1034         "summary": "Aquire Lock",
1035         "description": "Checks if the node is in the top of the queue and hence acquires the lock",
1036         "operationId": "accquireLock",
1037         "produces": [
1038           "application/json"
1039         ],
1040         "parameters": [
1041           {
1042             "name": "lockreference",
1043             "in": "path",
1044             "description": "Lock Reference",
1045             "required": true,
1046             "type": "string"
1047           },
1048           {
1049             "name": "X-minorVersion",
1050             "in": "header",
1051             "description": "Minor Version",
1052             "required": false,
1053             "type": "string"
1054           },
1055           {
1056             "name": "X-patchVersion",
1057             "in": "header",
1058             "description": "Patch Version",
1059             "required": false,
1060             "type": "string"
1061           },
1062           {
1063             "name": "Authorization",
1064             "in": "header",
1065             "description": "Authorization",
1066             "required": true,
1067             "type": "string"
1068           },
1069           {
1070             "name": "aid",
1071             "in": "header",
1072             "description": "AID",
1073             "required": true,
1074             "type": "string"
1075           },
1076           {
1077             "name": "ns",
1078             "in": "header",
1079             "description": "Application namespace",
1080             "required": true,
1081             "type": "string"
1082           }
1083         ],
1084         "responses": {
1085           "200": {
1086             "description": "successful operation",
1087             "schema": {
1088               "type": "object",
1089               "additionalProperties": {
1090                 "type": "object"
1091               }
1092             }
1093           }
1094         }
1095       }
1096     },
1097     "/v2/locks/acquire-with-lease/{lockreference}": {
1098       "post": {
1099         "tags": [
1100           "Lock Api"
1101         ],
1102         "summary": "Aquire Lock with Lease",
1103         "description": "",
1104         "operationId": "accquireLockWithLease",
1105         "consumes": [
1106           "application/json"
1107         ],
1108         "produces": [
1109           "application/json"
1110         ],
1111         "parameters": [
1112           {
1113             "in": "body",
1114             "name": "body",
1115             "required": false,
1116             "schema": {
1117               "$ref": "#/definitions/JsonTable"
1118             }
1119           },
1120           {
1121             "name": "lockreference",
1122             "in": "path",
1123             "description": "Lock Reference",
1124             "required": true,
1125             "type": "string"
1126           },
1127           {
1128             "name": "X-minorVersion",
1129             "in": "header",
1130             "description": "Minor Version",
1131             "required": false,
1132             "type": "string"
1133           },
1134           {
1135             "name": "X-patchVersion",
1136             "in": "header",
1137             "description": "Patch Version",
1138             "required": false,
1139             "type": "string"
1140           },
1141           {
1142             "name": "Authorization",
1143             "in": "header",
1144             "description": "Authorization",
1145             "required": true,
1146             "type": "string"
1147           },
1148           {
1149             "name": "aid",
1150             "in": "header",
1151             "description": "AID",
1152             "required": true,
1153             "type": "string"
1154           },
1155           {
1156             "name": "ns",
1157             "in": "header",
1158             "description": "Application namespace",
1159             "required": true,
1160             "type": "string"
1161           }
1162         ],
1163         "responses": {
1164           "200": {
1165             "description": "successful operation",
1166             "schema": {
1167               "type": "object",
1168               "additionalProperties": {
1169                 "type": "object"
1170               }
1171             }
1172           }
1173         }
1174       }
1175     },
1176     "/v2/locks/enquire/{lockname}": {
1177       "get": {
1178         "tags": [
1179           "Lock Api"
1180         ],
1181         "summary": "Get Lock Holder",
1182         "description": "Gets the current Lock Holder",
1183         "operationId": "currentLockHolder",
1184         "produces": [
1185           "application/json"
1186         ],
1187         "parameters": [
1188           {
1189             "name": "lockname",
1190             "in": "path",
1191             "description": "Lock Name",
1192             "required": true,
1193             "type": "string"
1194           },
1195           {
1196             "name": "X-minorVersion",
1197             "in": "header",
1198             "description": "Minor Version",
1199             "required": false,
1200             "type": "string"
1201           },
1202           {
1203             "name": "X-patchVersion",
1204             "in": "header",
1205             "description": "Patch Version",
1206             "required": false,
1207             "type": "string"
1208           },
1209           {
1210             "name": "Authorization",
1211             "in": "header",
1212             "description": "Authorization",
1213             "required": true,
1214             "type": "string"
1215           },
1216           {
1217             "name": "aid",
1218             "in": "header",
1219             "description": "AID",
1220             "required": true,
1221             "type": "string"
1222           },
1223           {
1224             "name": "ns",
1225             "in": "header",
1226             "description": "Application namespace",
1227             "required": true,
1228             "type": "string"
1229           }
1230         ],
1231         "responses": {
1232           "200": {
1233             "description": "successful operation",
1234             "schema": {
1235               "type": "object",
1236               "additionalProperties": {
1237                 "type": "object"
1238               }
1239             }
1240           }
1241         }
1242       }
1243     },
1244     "/v2/locks/{lockname}": {
1245       "get": {
1246         "tags": [
1247           "Lock Api"
1248         ],
1249         "summary": "Lock State",
1250         "description": "Returns current Lock State and Holder.",
1251         "operationId": "currentLockState",
1252         "produces": [
1253           "application/json"
1254         ],
1255         "parameters": [
1256           {
1257             "name": "lockname",
1258             "in": "path",
1259             "description": "Lock Name",
1260             "required": true,
1261             "type": "string"
1262           },
1263           {
1264             "name": "X-minorVersion",
1265             "in": "header",
1266             "description": "Minor Version",
1267             "required": false,
1268             "type": "string"
1269           },
1270           {
1271             "name": "X-patchVersion",
1272             "in": "header",
1273             "description": "Patch Version",
1274             "required": false,
1275             "type": "string"
1276           },
1277           {
1278             "name": "Authorization",
1279             "in": "header",
1280             "description": "Authorization",
1281             "required": true,
1282             "type": "string"
1283           },
1284           {
1285             "name": "aid",
1286             "in": "header",
1287             "description": "AID",
1288             "required": true,
1289             "type": "string"
1290           },
1291           {
1292             "name": "ns",
1293             "in": "header",
1294             "description": "Application namespace",
1295             "required": true,
1296             "type": "string"
1297           }
1298         ],
1299         "responses": {
1300           "200": {
1301             "description": "successful operation",
1302             "schema": {
1303               "type": "object",
1304               "additionalProperties": {
1305                 "type": "object"
1306               }
1307             }
1308           }
1309         }
1310       }
1311     },
1312     "/v2/locks/release/{lockreference}": {
1313       "delete": {
1314         "tags": [
1315           "Lock Api"
1316         ],
1317         "summary": "Release Lock",
1318         "description": "deletes the process from the zk queue",
1319         "operationId": "unLock",
1320         "produces": [
1321           "application/json"
1322         ],
1323         "parameters": [
1324           {
1325             "name": "lockreference",
1326             "in": "path",
1327             "required": true,
1328             "type": "string"
1329           },
1330           {
1331             "name": "X-minorVersion",
1332             "in": "header",
1333             "description": "Minor Version",
1334             "required": false,
1335             "type": "string"
1336           },
1337           {
1338             "name": "X-patchVersion",
1339             "in": "header",
1340             "description": "Patch Version",
1341             "required": false,
1342             "type": "string"
1343           },
1344           {
1345             "name": "Authorization",
1346             "in": "header",
1347             "description": "Authorization",
1348             "required": true,
1349             "type": "string"
1350           },
1351           {
1352             "name": "aid",
1353             "in": "header",
1354             "description": "AID",
1355             "required": true,
1356             "type": "string"
1357           },
1358           {
1359             "name": "ns",
1360             "in": "header",
1361             "description": "Application namespace",
1362             "required": true,
1363             "type": "string"
1364           }
1365         ],
1366         "responses": {
1367           "200": {
1368             "description": "successful operation",
1369             "schema": {
1370               "type": "object",
1371               "additionalProperties": {
1372                 "type": "object"
1373               }
1374             }
1375           }
1376         }
1377       }
1378     },
1379     "/v2/locks/delete/{lockname}": {
1380       "delete": {
1381         "tags": [
1382           "Lock Api"
1383         ],
1384         "summary": "Delete Lock",
1385         "description": "",
1386         "operationId": "deleteLock",
1387         "produces": [
1388           "application/json"
1389         ],
1390         "parameters": [
1391           {
1392             "name": "lockname",
1393             "in": "path",
1394             "required": true,
1395             "type": "string"
1396           },
1397           {
1398             "name": "X-minorVersion",
1399             "in": "header",
1400             "description": "Minor Version",
1401             "required": false,
1402             "type": "string"
1403           },
1404           {
1405             "name": "X-patchVersion",
1406             "in": "header",
1407             "description": "Patch Version",
1408             "required": false,
1409             "type": "string"
1410           },
1411           {
1412             "name": "aid",
1413             "in": "header",
1414             "description": "AID",
1415             "required": true,
1416             "type": "string"
1417           },
1418           {
1419             "name": "Authorization",
1420             "in": "header",
1421             "description": "Authorization",
1422             "required": true,
1423             "type": "string"
1424           },
1425           {
1426             "name": "ns",
1427             "in": "header",
1428             "description": "Application namespace",
1429             "required": true,
1430             "type": "string"
1431           }
1432         ],
1433         "responses": {
1434           "200": {
1435             "description": "successful operation",
1436             "schema": {
1437               "type": "object",
1438               "additionalProperties": {
1439                 "type": "object"
1440               }
1441             }
1442           }
1443         }
1444       }
1445     },
1446     "/{version}/priorityq/keyspaces/{keyspace}/{qname}": {
1447       "post": {
1448         "tags": [
1449           "Q Api"
1450         ],
1451         "summary": "Create Q",
1452         "description": "",
1453         "operationId": "createQ",
1454         "consumes": [
1455           "application/json"
1456         ],
1457         "produces": [
1458           "application/json"
1459         ],
1460         "parameters": [
1461           {
1462             "name": "version",
1463             "in": "path",
1464             "description": "Major Version",
1465             "required": true,
1466             "type": "string"
1467           },
1468           {
1469             "name": "X-minorVersion",
1470             "in": "header",
1471             "description": "Minor Version",
1472             "required": false,
1473             "type": "string"
1474           },
1475           {
1476             "name": "X-patchVersion",
1477             "in": "header",
1478             "description": "Patch Version",
1479             "required": false,
1480             "type": "string"
1481           },
1482           {
1483             "name": "aid",
1484             "in": "header",
1485             "description": "AID",
1486             "required": true,
1487             "type": "string"
1488           },
1489           {
1490             "name": "ns",
1491             "in": "header",
1492             "description": "Application namespace",
1493             "required": true,
1494             "type": "string"
1495           },
1496           {
1497             "name": "Authorization",
1498             "in": "header",
1499             "description": "Authorization",
1500             "required": true,
1501             "type": "string"
1502           },
1503           {
1504             "in": "body",
1505             "name": "body",
1506             "required": false,
1507             "schema": {
1508               "$ref": "#/definitions/JsonTable"
1509             }
1510           },
1511           {
1512             "name": "keyspace",
1513             "in": "path",
1514             "description": "Key Space",
1515             "required": true,
1516             "type": "string"
1517           },
1518           {
1519             "name": "qname",
1520             "in": "path",
1521             "description": "Table Name",
1522             "required": true,
1523             "type": "string"
1524           }
1525         ],
1526         "responses": {
1527           "200": {
1528             "description": "successful operation",
1529             "schema": {
1530               "type": "string"
1531             }
1532           }
1533         }
1534       },
1535       "delete": {
1536         "tags": [
1537           "Q Api"
1538         ],
1539         "summary": "DropQ",
1540         "description": "",
1541         "operationId": "dropQ",
1542         "produces": [
1543           "application/json"
1544         ],
1545         "parameters": [
1546           {
1547             "name": "version",
1548             "in": "path",
1549             "description": "Major Version",
1550             "required": true,
1551             "type": "string"
1552           },
1553           {
1554             "name": "X-minorVersion",
1555             "in": "header",
1556             "description": "Minor Version",
1557             "required": false,
1558             "type": "string"
1559           },
1560           {
1561             "name": "X-patchVersion",
1562             "in": "header",
1563             "description": "Patch Version",
1564             "required": false,
1565             "type": "string"
1566           },
1567           {
1568             "name": "aid",
1569             "in": "header",
1570             "description": "AID",
1571             "required": true,
1572             "type": "string"
1573           },
1574           {
1575             "name": "ns",
1576             "in": "header",
1577             "description": "Application namespace",
1578             "required": true,
1579             "type": "string"
1580           },
1581           {
1582             "name": "Authorization",
1583             "in": "header",
1584             "description": "Authorization",
1585             "required": true,
1586             "type": "string"
1587           },
1588           {
1589             "name": "keyspace",
1590             "in": "path",
1591             "description": "Key Space",
1592             "required": true,
1593             "type": "string"
1594           },
1595           {
1596             "name": "qname",
1597             "in": "path",
1598             "description": "Table Name",
1599             "required": true,
1600             "type": "string"
1601           }
1602         ],
1603         "responses": {
1604           "200": {
1605             "description": "successful operation",
1606             "schema": {
1607               "type": "string"
1608             }
1609           }
1610         }
1611       }
1612     },
1613     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/rows": {
1614       "post": {
1615         "tags": [
1616           "Q Api"
1617         ],
1618         "summary": "",
1619         "description": "",
1620         "operationId": "insertIntoQ",
1621         "consumes": [
1622           "application/json"
1623         ],
1624         "produces": [
1625           "application/json"
1626         ],
1627         "parameters": [
1628           {
1629             "name": "version",
1630             "in": "path",
1631             "description": "Major Version",
1632             "required": true,
1633             "type": "string"
1634           },
1635           {
1636             "name": "X-minorVersion",
1637             "in": "header",
1638             "description": "Minor Version",
1639             "required": false,
1640             "type": "string"
1641           },
1642           {
1643             "name": "X-patchVersion",
1644             "in": "header",
1645             "description": "Patch Version",
1646             "required": false,
1647             "type": "string"
1648           },
1649           {
1650             "name": "aid",
1651             "in": "header",
1652             "description": "AID",
1653             "required": true,
1654             "type": "string"
1655           },
1656           {
1657             "name": "ns",
1658             "in": "header",
1659             "description": "Application namespace",
1660             "required": true,
1661             "type": "string"
1662           },
1663           {
1664             "name": "Authorization",
1665             "in": "header",
1666             "description": "Authorization",
1667             "required": true,
1668             "type": "string"
1669           },
1670           {
1671             "in": "body",
1672             "name": "body",
1673             "required": false,
1674             "schema": {
1675               "$ref": "#/definitions/JsonTable"
1676             }
1677           },
1678           {
1679             "name": "keyspace",
1680             "in": "path",
1681             "description": "Key Space",
1682             "required": true,
1683             "type": "string"
1684           },
1685           {
1686             "name": "qname",
1687             "in": "path",
1688             "description": "Table Name",
1689             "required": true,
1690             "type": "string"
1691           }
1692         ],
1693         "responses": {
1694           "default": {
1695             "description": "successful operation"
1696           }
1697         }
1698       },
1699       "put": {
1700         "tags": [
1701           "Q Api"
1702         ],
1703         "summary": "updateQ",
1704         "description": "",
1705         "operationId": "updateQ",
1706         "consumes": [
1707           "application/json"
1708         ],
1709         "produces": [
1710           "application/json"
1711         ],
1712         "parameters": [
1713           {
1714             "name": "version",
1715             "in": "path",
1716             "description": "Major Version",
1717             "required": true,
1718             "type": "string"
1719           },
1720           {
1721             "name": "X-minorVersion",
1722             "in": "header",
1723             "description": "Minor Version",
1724             "required": false,
1725             "type": "string"
1726           },
1727           {
1728             "name": "X-patchVersion",
1729             "in": "header",
1730             "description": "Patch Version",
1731             "required": false,
1732             "type": "string"
1733           },
1734           {
1735             "name": "aid",
1736             "in": "header",
1737             "description": "AID",
1738             "required": true,
1739             "type": "string"
1740           },
1741           {
1742             "name": "ns",
1743             "in": "header",
1744             "description": "Application namespace",
1745             "required": true,
1746             "type": "string"
1747           },
1748           {
1749             "name": "Authorization",
1750             "in": "header",
1751             "description": "Authorization",
1752             "required": true,
1753             "type": "string"
1754           },
1755           {
1756             "in": "body",
1757             "name": "body",
1758             "required": false,
1759             "schema": {
1760               "$ref": "#/definitions/JsonTable"
1761             }
1762           },
1763           {
1764             "name": "keyspace",
1765             "in": "path",
1766             "description": "Key Space",
1767             "required": true,
1768             "type": "string"
1769           },
1770           {
1771             "name": "qname",
1772             "in": "path",
1773             "description": "Table Name",
1774             "required": true,
1775             "type": "string"
1776           }
1777         ],
1778         "responses": {
1779           "200": {
1780             "description": "successful operation",
1781             "schema": {
1782               "type": "string"
1783             }
1784           }
1785         }
1786       },
1787       "delete": {
1788         "tags": [
1789           "Q Api"
1790         ],
1791         "summary": "deleteQ",
1792         "description": "",
1793         "operationId": "deleteFromQ",
1794         "consumes": [
1795           "application/json"
1796         ],
1797         "produces": [
1798           "application/json"
1799         ],
1800         "parameters": [
1801           {
1802             "name": "version",
1803             "in": "path",
1804             "description": "Major Version",
1805             "required": true,
1806             "type": "string"
1807           },
1808           {
1809             "name": "X-minorVersion",
1810             "in": "header",
1811             "description": "Minor Version",
1812             "required": false,
1813             "type": "string"
1814           },
1815           {
1816             "name": "X-patchVersion",
1817             "in": "header",
1818             "description": "Patch Version",
1819             "required": false,
1820             "type": "string"
1821           },
1822           {
1823             "name": "aid",
1824             "in": "header",
1825             "description": "AID",
1826             "required": true,
1827             "type": "string"
1828           },
1829           {
1830             "name": "ns",
1831             "in": "header",
1832             "description": "Application namespace",
1833             "required": true,
1834             "type": "string"
1835           },
1836           {
1837             "name": "Authorization",
1838             "in": "header",
1839             "description": "Authorization",
1840             "required": true,
1841             "type": "string"
1842           },
1843           {
1844             "in": "body",
1845             "name": "body",
1846             "required": false,
1847             "schema": {
1848               "$ref": "#/definitions/JsonTable"
1849             }
1850           },
1851           {
1852             "name": "keyspace",
1853             "in": "path",
1854             "description": "Key Space",
1855             "required": true,
1856             "type": "string"
1857           },
1858           {
1859             "name": "qname",
1860             "in": "path",
1861             "description": "Table Name",
1862             "required": true,
1863             "type": "string"
1864           }
1865         ],
1866         "responses": {
1867           "200": {
1868             "description": "successful operation",
1869             "schema": {
1870               "type": "string"
1871             }
1872           }
1873         }
1874       }
1875     },
1876     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/peek": {
1877       "get": {
1878         "tags": [
1879           "Q Api"
1880         ],
1881         "summary": "",
1882         "description": "",
1883         "operationId": "peek",
1884         "produces": [
1885           "application/json"
1886         ],
1887         "parameters": [
1888           {
1889             "name": "version",
1890             "in": "path",
1891             "description": "Major Version",
1892             "required": true,
1893             "type": "string"
1894           },
1895           {
1896             "name": "X-minorVersion",
1897             "in": "header",
1898             "description": "Minor Version",
1899             "required": false,
1900             "type": "string"
1901           },
1902           {
1903             "name": "X-patchVersion",
1904             "in": "header",
1905             "description": "Patch Version",
1906             "required": false,
1907             "type": "string"
1908           },
1909           {
1910             "name": "aid",
1911             "in": "header",
1912             "description": "AID",
1913             "required": true,
1914             "type": "string"
1915           },
1916           {
1917             "name": "ns",
1918             "in": "header",
1919             "description": "Application namespace",
1920             "required": true,
1921             "type": "string"
1922           },
1923           {
1924             "name": "Authorization",
1925             "in": "header",
1926             "description": "Authorization",
1927             "required": true,
1928             "type": "string"
1929           },
1930           {
1931             "name": "keyspace",
1932             "in": "path",
1933             "description": "Key Space",
1934             "required": true,
1935             "type": "string"
1936           },
1937           {
1938             "name": "qname",
1939             "in": "path",
1940             "description": "Table Name",
1941             "required": true,
1942             "type": "string"
1943           }
1944         ],
1945         "responses": {
1946           "200": {
1947             "description": "successful operation",
1948             "schema": {
1949               "type": "object",
1950               "additionalProperties": {
1951                 "type": "object"
1952               }
1953             }
1954           }
1955         }
1956       }
1957     },
1958     "/{version}/priorityq/keyspaces/{keyspace}/{qname}/filter": {
1959       "get": {
1960         "tags": [
1961           "Q Api"
1962         ],
1963         "summary": "filter",
1964         "description": "",
1965         "operationId": "filter",
1966         "produces": [
1967           "application/json"
1968         ],
1969         "parameters": [
1970           {
1971             "name": "version",
1972             "in": "path",
1973             "description": "Major Version",
1974             "required": true,
1975             "type": "string"
1976           },
1977           {
1978             "name": "X-minorVersion",
1979             "in": "header",
1980             "description": "Minor Version",
1981             "required": false,
1982             "type": "string"
1983           },
1984           {
1985             "name": "X-patchVersion",
1986             "in": "header",
1987             "description": "Patch Version",
1988             "required": false,
1989             "type": "string"
1990           },
1991           {
1992             "name": "aid",
1993             "in": "header",
1994             "description": "AID",
1995             "required": true,
1996             "type": "string"
1997           },
1998           {
1999             "name": "ns",
2000             "in": "header",
2001             "description": "Application namespace",
2002             "required": true,
2003             "type": "string"
2004           },
2005           {
2006             "name": "Authorization",
2007             "in": "header",
2008             "description": "Authorization",
2009             "required": true,
2010             "type": "string"
2011           },
2012           {
2013             "name": "keyspace",
2014             "in": "path",
2015             "description": "Key Space",
2016             "required": true,
2017             "type": "string"
2018           },
2019           {
2020             "name": "qname",
2021             "in": "path",
2022             "description": "Table Name",
2023             "required": true,
2024             "type": "string"
2025           }
2026         ],
2027         "responses": {
2028           "200": {
2029             "description": "successful operation",
2030             "schema": {
2031               "type": "object",
2032               "additionalProperties": {
2033                 "type": "object"
2034               }
2035             }
2036           }
2037         }
2038       }
2039     },
2040     "/v{version}/test": {
2041       "get": {
2042         "tags": [
2043           "Test Api"
2044         ],
2045         "summary": "Get Test",
2046         "description": "",
2047         "operationId": "simpleTests",
2048         "produces": [
2049           "application/json"
2050         ],
2051         "parameters": [],
2052         "responses": {
2053           "200": {
2054             "description": "successful operation",
2055             "schema": {
2056               "type": "object",
2057               "additionalProperties": {
2058                 "type": "object"
2059               }
2060             }
2061           }
2062         }
2063       }
2064     },
2065     "/v{version}/version": {
2066       "get": {
2067         "tags": [
2068           "Version Api"
2069         ],
2070         "summary": "Get Version",
2071         "description": "",
2072         "operationId": "version",
2073         "produces": [
2074           "application/json"
2075         ],
2076         "parameters": [],
2077         "responses": {
2078           "200": {
2079             "description": "successful operation",
2080             "schema": {
2081               "type": "object",
2082               "additionalProperties": {
2083                 "type": "object"
2084               }
2085             }
2086           }
2087         }
2088       }
2089     }
2090   },
2091   "definitions": {
2092     "JsonTable": {
2093       "type": "object",
2094       "properties": {
2095         "columns": {
2096           "type": "array",
2097           "description": "Column values",
2098           "items": {
2099             "type": "string"
2100           }
2101         },
2102         "consistencyInfo": {
2103           "type": "object",
2104           "description": "Consistency level",
2105           "additionalProperties": {
2106             "type": "string"
2107           }
2108         },
2109         "conditions": {
2110           "type": "object",
2111           "description": "Conditions",
2112           "additionalProperties": {
2113             "type": "object"
2114           }
2115         },
2116         "ttl": {
2117           "type": "string",
2118           "description": "Time to live information"
2119         },
2120         "timestamp": {
2121           "type": "string",
2122           "description": "Time stamp"
2123         }
2124       },
2125       "description": "Json model for delete"
2126     }
2127   }
2128 }