docs/sections/apis/swagger_vescollector.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "version": "1.5.4",
   5     "title": "Api Documentation",
   6     "description": "Virtual Event Streaming (VES) Collector is RESTful collector for processing JSON messages. The collector verifies the source and validates the events against VES schema before distributing to DMAAP MR topics\n",
   7     "termsOfService": "urn:tos",
   8     "contact": {},
   9     "license": {
  10       "name": "Apache 2.0",
  11       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  12     }
  13   },
  14   "host": "localhost:8443",
  15   "basePath": "/",
  16   "tags": [{
  17     "name": "basic-error-controller",
  18     "description": "Basic Error Controller"
  19   }, {
  20     "name": "ves-rest-controller",
  21     "description": "Ves Rest Controller"
  22   }],
  23   "paths": {
  24     "/": {
  25       "get": {
  26         "tags": ["ves-rest-controller"],
  27         "summary": "mainPage",
  28         "operationId": "mainPageUsingGET",
  29         "produces": ["*/*"],
  30         "responses": {
  31           "200": {
  32             "description": "OK",
  33             "schema": {
  34               "type": "string"
  35             }
  36           },
  37           "401": {
  38             "description": "Unauthorized"
  39           },
  40           "403": {
  41             "description": "Forbidden"
  42           },
  43           "404": {
  44             "description": "Not Found"
  45           }
  46         }
  47       }
  48     },
  49     "/error": {
  50       "get": {
  51         "tags": ["basic-error-controller"],
  52         "summary": "error",
  53         "operationId": "errorUsingGET",
  54         "produces": ["*/*"],
  55         "responses": {
  56           "200": {
  57             "description": "OK",
  58             "schema": {
  59               "type": "object",
  60               "additionalProperties": {
  61                 "type": "object"
  62               }
  63             }
  64           },
  65           "401": {
  66             "description": "Unauthorized"
  67           },
  68           "403": {
  69             "description": "Forbidden"
  70           },
  71           "404": {
  72             "description": "Not Found"
  73           }
  74         }
  75       },
  76       "head": {
  77         "tags": ["basic-error-controller"],
  78         "summary": "error",
  79         "operationId": "errorUsingHEAD",
  80         "consumes": ["application/json"],
  81         "produces": ["*/*"],
  82         "responses": {
  83           "200": {
  84             "description": "OK",
  85             "schema": {
  86               "type": "object",
  87               "additionalProperties": {
  88                 "type": "object"
  89               }
  90             }
  91           },
  92           "204": {
  93             "description": "No Content"
  94           },
  95           "401": {
  96             "description": "Unauthorized"
  97           },
  98           "403": {
  99             "description": "Forbidden"
 100           }
 101         }
 102       },
 103       "post": {
 104         "tags": ["basic-error-controller"],
 105         "summary": "error",
 106         "operationId": "errorUsingPOST",
 107         "consumes": ["application/json"],
 108         "produces": ["*/*"],
 109         "responses": {
 110           "200": {
 111             "description": "OK",
 112             "schema": {
 113               "type": "object",
 114               "additionalProperties": {
 115                 "type": "object"
 116               }
 117             }
 118           },
 119           "202": {
 120             "description": "Accepted"
 121           },
 122           "401": {
 123             "description": "Unauthorized"
 124           },
 125           "403": {
 126             "description": "Forbidden"
 127           },
 128           "404": {
 129             "description": "Not Found"
 130           }
 131         }
 132       },
 133       "put": {
 134         "tags": ["basic-error-controller"],
 135         "summary": "error",
 136         "operationId": "errorUsingPUT",
 137         "consumes": ["application/json"],
 138         "produces": ["*/*"],
 139         "responses": {
 140           "200": {
 141             "description": "OK",
 142             "schema": {
 143               "type": "object",
 144               "additionalProperties": {
 145                 "type": "object"
 146               }
 147             }
 148           },
 149           "202": {
 150             "description": "Accepted"
 151           },
 152           "401": {
 153             "description": "Unauthorized"
 154           },
 155           "403": {
 156             "description": "Forbidden"
 157           },
 158           "404": {
 159             "description": "Not Found"
 160           }
 161         }
 162       },
 163       "delete": {
 164         "tags": ["basic-error-controller"],
 165         "summary": "error",
 166         "operationId": "errorUsingDELETE",
 167         "produces": ["*/*"],
 168         "responses": {
 169           "200": {
 170             "description": "OK",
 171             "schema": {
 172               "type": "object",
 173               "additionalProperties": {
 174                 "type": "object"
 175               }
 176             }
 177           },
 178           "204": {
 179             "description": "No Content"
 180           },
 181           "401": {
 182             "description": "Unauthorized"
 183           },
 184           "403": {
 185             "description": "Forbidden"
 186           }
 187         }
 188       },
 189       "options": {
 190         "tags": ["basic-error-controller"],
 191         "summary": "error",
 192         "operationId": "errorUsingOPTIONS",
 193         "consumes": ["application/json"],
 194         "produces": ["*/*"],
 195         "responses": {
 196           "200": {
 197             "description": "OK",
 198             "schema": {
 199               "type": "object",
 200               "additionalProperties": {
 201                 "type": "object"
 202               }
 203             }
 204           },
 205           "204": {
 206             "description": "No Content"
 207           },
 208           "401": {
 209             "description": "Unauthorized"
 210           },
 211           "403": {
 212             "description": "Forbidden"
 213           }
 214         }
 215       },
 216       "patch": {
 217         "tags": ["basic-error-controller"],
 218         "summary": "error",
 219         "operationId": "errorUsingPATCH",
 220         "consumes": ["application/json"],
 221         "produces": ["*/*"],
 222         "responses": {
 223           "200": {
 224             "description": "OK",
 225             "schema": {
 226               "type": "object",
 227               "additionalProperties": {
 228                 "type": "object"
 229               }
 230             }
 231           },
 232           "204": {
 233             "description": "No Content"
 234           },
 235           "401": {
 236             "description": "Unauthorized"
 237           },
 238           "403": {
 239             "description": "Forbidden"
 240           }
 241         }
 242       }
 243     },
 244     "/eventListener/v1": {
 245       "post": {
 246         "tags": ["ves-rest-controller"],
 247         "summary": "receiveEvent",
 248         "operationId": "receiveEventUsingPOST",
 249         "consumes": ["application/json"],
 250         "produces": ["*/*"],
 251         "parameters": [{
 252           "in": "body",
 253           "name": "jsonPayload",
 254           "description": "jsonPayload",
 255           "required": true,
 256           "schema": {
 257             "type": "string"
 258           }
 259         }],
 260         "responses": {
 261           "200": {
 262             "description": "OK",
 263             "schema": {
 264               "type": "string"
 265             }
 266           },
 267           "202": {
 268             "description": "Accepted"
 269           },
 270           "401": {
 271             "description": "Unauthorized"
 272           },
 273           "403": {
 274             "description": "Forbidden"
 275           },
 276           "404": {
 277             "description": "Not Found"
 278           }
 279         }
 280       }
 281     },
 282     "/eventListener/v1/eventBatch": {
 283       "post": {
 284         "tags": ["ves-rest-controller"],
 285         "summary": "receiveEvent",
 286         "operationId": "receiveEventUsingPOST_1",
 287         "consumes": ["application/json"],
 288         "produces": ["*/*"],
 289         "parameters": [{
 290           "in": "body",
 291           "name": "jsonPayload",
 292           "description": "jsonPayload",
 293           "required": true,
 294           "schema": {
 295             "type": "string"
 296           }
 297         }],
 298         "responses": {
 299           "200": {
 300             "description": "OK",
 301             "schema": {
 302               "type": "string"
 303             }
 304           },
 305           "202": {
 306             "description": "Accepted"
 307           },
 308           "401": {
 309             "description": "Unauthorized"
 310           },
 311           "403": {
 312             "description": "Forbidden"
 313           },
 314           "404": {
 315             "description": "Not Found"
 316           }
 317         }
 318       }
 319     },
 320     "/eventListener/v2": {
 321       "post": {
 322         "tags": ["ves-rest-controller"],
 323         "summary": "receiveEvent",
 324         "operationId": "receiveEventUsingPOST_2",
 325         "consumes": ["application/json"],
 326         "produces": ["*/*"],
 327         "parameters": [{
 328           "in": "body",
 329           "name": "jsonPayload",
 330           "description": "jsonPayload",
 331           "required": true,
 332           "schema": {
 333             "type": "string"
 334           }
 335         }],
 336         "responses": {
 337           "200": {
 338             "description": "OK",
 339             "schema": {
 340               "type": "string"
 341             }
 342           },
 343           "202": {
 344             "description": "Accepted"
 345           },
 346           "401": {
 347             "description": "Unauthorized"
 348           },
 349           "403": {
 350             "description": "Forbidden"
 351           },
 352           "404": {
 353             "description": "Not Found"
 354           }
 355         }
 356       }
 357     },
 358     "/eventListener/v2/eventBatch": {
 359       "post": {
 360         "tags": ["ves-rest-controller"],
 361         "summary": "receiveEvent",
 362         "operationId": "receiveEventUsingPOST_3",
 363         "consumes": ["application/json"],
 364         "produces": ["*/*"],
 365         "parameters": [{
 366           "in": "body",
 367           "name": "jsonPayload",
 368           "description": "jsonPayload",
 369           "required": true,
 370           "schema": {
 371             "type": "string"
 372           }
 373         }],
 374         "responses": {
 375           "200": {
 376             "description": "OK",
 377             "schema": {
 378               "type": "string"
 379             }
 380           },
 381           "202": {
 382             "description": "Accepted"
 383           },
 384           "401": {
 385             "description": "Unauthorized"
 386           },
 387           "403": {
 388             "description": "Forbidden"
 389           },
 390           "404": {
 391             "description": "Not Found"
 392           }
 393         }
 394       }
 395     },
 396     "/eventListener/v3": {
 397       "post": {
 398         "tags": ["ves-rest-controller"],
 399         "summary": "receiveEvent",
 400         "operationId": "receiveEventUsingPOST_4",
 401         "consumes": ["application/json"],
 402         "produces": ["*/*"],
 403         "parameters": [{
 404           "in": "body",
 405           "name": "jsonPayload",
 406           "description": "jsonPayload",
 407           "required": true,
 408           "schema": {
 409             "type": "string"
 410           }
 411         }],
 412         "responses": {
 413           "200": {
 414             "description": "OK",
 415             "schema": {
 416               "type": "string"
 417             }
 418           },
 419           "202": {
 420             "description": "Accepted"
 421           },
 422           "401": {
 423             "description": "Unauthorized"
 424           },
 425           "403": {
 426             "description": "Forbidden"
 427           },
 428           "404": {
 429             "description": "Not Found"
 430           }
 431         }
 432       }
 433     },
 434     "/eventListener/v3/eventBatch": {
 435       "post": {
 436         "tags": ["ves-rest-controller"],
 437         "summary": "receiveEvent",
 438         "operationId": "receiveEventUsingPOST_5",
 439         "consumes": ["application/json"],
 440         "produces": ["*/*"],
 441         "parameters": [{
 442           "in": "body",
 443           "name": "jsonPayload",
 444           "description": "jsonPayload",
 445           "required": true,
 446           "schema": {
 447             "type": "string"
 448           }
 449         }],
 450         "responses": {
 451           "200": {
 452             "description": "OK",
 453             "schema": {
 454               "type": "string"
 455             }
 456           },
 457           "202": {
 458             "description": "Accepted"
 459           },
 460           "401": {
 461             "description": "Unauthorized"
 462           },
 463           "403": {
 464             "description": "Forbidden"
 465           },
 466           "404": {
 467             "description": "Not Found"
 468           }
 469         }
 470       }
 471     },
 472     "/eventListener/v4": {
 473       "post": {
 474         "tags": ["ves-rest-controller"],
 475         "summary": "receiveEvent",
 476         "operationId": "receiveEventUsingPOST_6",
 477         "consumes": ["application/json"],
 478         "produces": ["*/*"],
 479         "parameters": [{
 480           "in": "body",
 481           "name": "jsonPayload",
 482           "description": "jsonPayload",
 483           "required": true,
 484           "schema": {
 485             "type": "string"
 486           }
 487         }],
 488         "responses": {
 489           "200": {
 490             "description": "OK",
 491             "schema": {
 492               "type": "string"
 493             }
 494           },
 495           "202": {
 496             "description": "Accepted"
 497           },
 498           "401": {
 499             "description": "Unauthorized"
 500           },
 501           "403": {
 502             "description": "Forbidden"
 503           },
 504           "404": {
 505             "description": "Not Found"
 506           }
 507         }
 508       }
 509     },
 510     "/eventListener/v4/eventBatch": {
 511       "post": {
 512         "tags": ["ves-rest-controller"],
 513         "summary": "receiveEvent",
 514         "operationId": "receiveEventUsingPOST_7",
 515         "consumes": ["application/json"],
 516         "produces": ["*/*"],
 517         "parameters": [{
 518           "in": "body",
 519           "name": "jsonPayload",
 520           "description": "jsonPayload",
 521           "required": true,
 522           "schema": {
 523             "type": "string"
 524           }
 525         }],
 526         "responses": {
 527           "200": {
 528             "description": "OK",
 529             "schema": {
 530               "type": "string"
 531             }
 532           },
 533           "202": {
 534             "description": "Accepted"
 535           },
 536           "401": {
 537             "description": "Unauthorized"
 538           },
 539           "403": {
 540             "description": "Forbidden"
 541           },
 542           "404": {
 543             "description": "Not Found"
 544           }
 545         }
 546       }
 547     },
 548     "/eventListener/v5": {
 549       "post": {
 550         "tags": ["ves-rest-controller"],
 551         "summary": "receiveEvent",
 552         "operationId": "receiveEventUsingPOST_8",
 553         "consumes": ["application/json"],
 554         "produces": ["*/*"],
 555         "parameters": [{
 556           "in": "body",
 557           "name": "jsonPayload",
 558           "description": "jsonPayload",
 559           "required": true,
 560           "schema": {
 561             "type": "string"
 562           }
 563         }],
 564         "responses": {
 565           "200": {
 566             "description": "OK",
 567             "schema": {
 568               "type": "string"
 569             }
 570           },
 571           "202": {
 572             "description": "Accepted"
 573           },
 574           "401": {
 575             "description": "Unauthorized"
 576           },
 577           "403": {
 578             "description": "Forbidden"
 579           },
 580           "404": {
 581             "description": "Not Found"
 582           }
 583         }
 584       }
 585     },
 586     "/eventListener/v5/eventBatch": {
 587       "post": {
 588         "tags": ["ves-rest-controller"],
 589         "summary": "receiveEvent",
 590         "operationId": "receiveEventUsingPOST_9",
 591         "consumes": ["application/json"],
 592         "produces": ["*/*"],
 593         "parameters": [{
 594           "in": "body",
 595           "name": "jsonPayload",
 596           "description": "jsonPayload",
 597           "required": true,
 598           "schema": {
 599             "type": "string"
 600           }
 601         }],
 602         "responses": {
 603           "200": {
 604             "description": "OK",
 605             "schema": {
 606               "type": "string"
 607             }
 608           },
 609           "202": {
 610             "description": "Accepted"
 611           },
 612           "401": {
 613             "description": "Unauthorized"
 614           },
 615           "403": {
 616             "description": "Forbidden"
 617           },
 618           "404": {
 619             "description": "Not Found"
 620           }
 621         }
 622       }
 623     },
 624     "/eventListener/v7": {
 625       "post": {
 626         "tags": ["ves-rest-controller"],
 627         "summary": "receiveEvent",
 628         "operationId": "receiveEventUsingPOST_10",
 629         "consumes": ["application/json"],
 630         "produces": ["*/*"],
 631         "parameters": [{
 632           "in": "body",
 633           "name": "jsonPayload",
 634           "description": "jsonPayload",
 635           "required": true,
 636           "schema": {
 637             "type": "string"
 638           }
 639         }],
 640         "responses": {
 641           "200": {
 642             "description": "OK",
 643             "schema": {
 644               "type": "string"
 645             }
 646           },
 647           "202": {
 648             "description": "Accepted"
 649           },
 650           "400": {
 651             "description": "Bad Request"
 652           },
 653           "401": {
 654             "description": "Unauthorized"
 655           },
 656           "403": {
 657             "description": "Forbidden"
 658           },
 659           "404": {
 660             "description": "Not Found"
 661           },
 662           "500": {
 663             "description": "Internal Server Error"
 664           }
 665         }
 666       }
 667     },
 668     "/eventListener/v7/eventBatch": {
 669       "post": {
 670         "tags": ["ves-rest-controller"],
 671         "summary": "receiveEvent",
 672         "operationId": "receiveEventUsingPOST_11",
 673         "consumes": ["application/json"],
 674         "produces": ["*/*"],
 675         "parameters": [{
 676           "in": "body",
 677           "name": "jsonPayload",
 678           "description": "jsonPayload",
 679           "required": true,
 680           "schema": {
 681             "type": "string"
 682           }
 683         }],
 684         "responses": {
 685           "200": {
 686             "description": "OK",
 687             "schema": {
 688               "type": "string"
 689             }
 690           },
 691           "202": {
 692             "description": "Accepted"
 693           },
 694           "400": {
 695             "description": "Bad Request"
 696           },
 697           "401": {
 698             "description": "Unauthorized"
 699           },
 700           "403": {
 701             "description": "Forbidden"
 702           },
 703           "404": {
 704             "description": "Not Found"
 705           },
 706           "500": {
 707             "description": "Internal Server Error"
 708           }
 709         }
 710       }
 711     }
 712   },
 713   "definitions": {
 714     "ModelAndView": {
 715       "type": "object",
 716       "properties": {
 717         "empty": {
 718           "type": "boolean"
 719         },
 720         "model": {
 721           "type": "object"
 722         },
 723         "modelMap": {
 724           "type": "object",
 725           "additionalProperties": {
 726             "type": "object"
 727           }
 728         },
 729         "reference": {
 730           "type": "boolean"
 731         },
 732         "status": {
 733           "type": "string",
 734           "enum": ["100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511"]
 735         },
 736         "view": {
 737           "$ref": "#/definitions/View"
 738         },
 739         "viewName": {
 740           "type": "string"
 741         }
 742       },
 743       "title": "ModelAndView"
 744     },
 745     "View": {
 746       "type": "object",
 747       "properties": {
 748         "contentType": {
 749           "type": "string"
 750         }
 751       },
 752       "title": "View"
 753     }
 754   }
 755 }