swagger_vescollector_1.3.1.yaml

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