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