docs/sections/apis/swagger_vescollector.yaml

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