Gitiles
Code Review Sign In
gerrit.nordix.org / onap / policy / clamp / 74533a8b7abb3f9181a175d80847e651dedda586 / . / docs / swagger / swagger.json
blob: 5a117ae61105814df97b1d5579efa856b7461d9d [file] [log] [blame]
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]1{
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]2 "swagger" : "2.0",
3 "info" : {
4 "version" : "3.0.0-SNAPSHOT",
5 "title" : "Clamp Rest API"
6 },
7 "host" : "0.0.0.0",
8 "basePath" : "/restservices/clds/v1/",
9 "schemes" : [ "http" ],
10 "paths" : {
11 "/clds/action/{action}/{modelName}?test={test}" : {
12 "put" : {
13 "operationId" : "route10",
14 "consumes" : [ "application/json" ],
15 "produces" : [ "application/json" ],
16 "parameters" : [ {
17 "name" : "action",
18 "in" : "path",
19 "required" : true,
20 "type" : "string"
21 }, {
22 "name" : "modelName}?test={test",
23 "in" : "path",
24 "required" : true,
25 "type" : "string"
26 }, {
27 "in" : "body",
28 "name" : "body",
29 "required" : true,
30 "schema" : {
31 "$ref" : "#/definitions/CldsModel"
32 }
33 } ],
34 "responses" : {
35 "200" : { }
36 },
37 "x-camelContextId" : "camel-1",
38 "x-routeId" : "route10"
39 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]40 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]41 "/clds/cldsDetails" : {
42 "get" : {
43 "operationId" : "route2",
44 "produces" : [ "application/json" ],
45 "responses" : {
46 "200" : {
47 "description" : "Output type",
48 "responseSchema" : {
49 "$ref" : "#/definitions/CldsMonitoringDetails"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]50 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]51 "schema" : {
52 "$ref" : "#/definitions/CldsMonitoringDetails"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]53 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]54 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]55 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]56 "x-camelContextId" : "camel-1",
57 "x-routeId" : "route2"
58 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]59 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]60 "/clds/cldsInfo" : {
61 "get" : {
62 "operationId" : "route3",
63 "produces" : [ "application/json" ],
64 "responses" : {
65 "200" : {
66 "description" : "Output type",
67 "responseSchema" : {
68 "$ref" : "#/definitions/CldsInfo"
69 },
70 "schema" : {
71 "$ref" : "#/definitions/CldsInfo"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]72 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]73 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]74 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]75 "x-camelContextId" : "camel-1",
76 "x-routeId" : "route3"
77 }
78 },
79 "/clds/dcae/event?test={test}" : {
80 "post" : {
81 "operationId" : "route11",
82 "consumes" : [ "application/json" ],
83 "produces" : [ "application/json" ],
84 "parameters" : [ {
85 "in" : "body",
86 "name" : "body",
87 "required" : true,
88 "schema" : {
89 "$ref" : "#/definitions/DcaeEvent"
90 }
91 } ],
92 "responses" : {
93 "200" : { }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]94 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]95 "x-camelContextId" : "camel-1",
96 "x-routeId" : "route11"
97 }
98 },
99 "/clds/deploy/{modelName}" : {
100 "put" : {
101 "operationId" : "route15",
102 "consumes" : [ "application/json" ],
103 "produces" : [ "application/json" ],
104 "parameters" : [ {
105 "name" : "modelName",
106 "in" : "path",
107 "required" : true,
108 "type" : "string"
109 }, {
110 "in" : "body",
111 "name" : "body",
112 "required" : true,
113 "schema" : {
114 "$ref" : "#/definitions/CldsModel"
115 }
116 } ],
117 "responses" : {
118 "200" : { }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]119 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]120 "x-camelContextId" : "camel-1",
121 "x-routeId" : "route15"
122 }
123 },
124 "/clds/model-names" : {
125 "get" : {
126 "operationId" : "route9",
127 "produces" : [ "application/json" ],
128 "responses" : {
129 "200" : {
130 "description" : "Output type",
131 "responseSchema" : {
132 "$ref" : "#/definitions/ValueItem"
133 },
134 "schema" : {
135 "$ref" : "#/definitions/ValueItem"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]136 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]137 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]138 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]139 "x-camelContextId" : "camel-1",
140 "x-routeId" : "route9"
141 }
142 },
143 "/clds/model/{modelName}" : {
144 "get" : {
145 "operationId" : "route7",
146 "produces" : [ "application/json" ],
147 "parameters" : [ {
148 "name" : "modelName",
149 "in" : "path",
150 "required" : true,
151 "type" : "string"
152 } ],
153 "responses" : {
154 "200" : {
155 "description" : "Output type",
156 "responseSchema" : {
157 "$ref" : "#/definitions/CldsModel"
158 },
159 "schema" : {
160 "$ref" : "#/definitions/CldsModel"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]161 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]162 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]163 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]164 "x-camelContextId" : "camel-1",
165 "x-routeId" : "route7"
166 },
167 "put" : {
168 "operationId" : "route8",
169 "consumes" : [ "application/json" ],
170 "produces" : [ "application/json" ],
171 "parameters" : [ {
172 "name" : "modelName",
173 "in" : "path",
174 "required" : true,
175 "type" : "string"
176 }, {
177 "in" : "body",
178 "name" : "body",
179 "required" : true,
180 "schema" : {
181 "$ref" : "#/definitions/CldsModel"
182 }
183 } ],
184 "responses" : {
185 "200" : {
186 "description" : "Output type",
187 "responseSchema" : {
188 "$ref" : "#/definitions/CldsModel"
189 },
190 "schema" : {
191 "$ref" : "#/definitions/CldsModel"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]192 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]193 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]194 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]195 "x-camelContextId" : "camel-1",
196 "x-routeId" : "route8"
197 }
198 },
199 "/clds/model/bpmn/{modelName}" : {
200 "get" : {
201 "operationId" : "route5",
202 "produces" : [ "text/xml" ],
203 "parameters" : [ {
204 "name" : "modelName",
205 "in" : "path",
206 "required" : true,
207 "type" : "string"
208 } ],
209 "responses" : {
210 "200" : { }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]211 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]212 "x-camelContextId" : "camel-1",
213 "x-routeId" : "route5"
214 }
215 },
216 "/clds/model/image/{modelName}" : {
217 "get" : {
218 "operationId" : "route6",
219 "produces" : [ "text/xml" ],
220 "parameters" : [ {
221 "name" : "modelName",
222 "in" : "path",
223 "required" : true,
224 "type" : "string"
225 } ],
226 "responses" : {
227 "200" : { }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]228 },
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]229 "x-camelContextId" : "camel-1",
230 "x-routeId" : "route6"
231 }
232 },
233 "/clds/properties" : {
234 "get" : {
235 "operationId" : "route13",
236 "produces" : [ "application/json" ],
237 "responses" : {
238 "200" : { }
239 },
240 "x-camelContextId" : "camel-1",
241 "x-routeId" : "route13"
242 }
243 },
244 "/clds/properties/{serviceInvariantUUID}?refresh={refresh}" : {
245 "get" : {
246 "operationId" : "route14",
247 "produces" : [ "application/json" ],
248 "parameters" : [ {
249 "name" : "serviceInvariantUUID}?refresh={refresh",
250 "in" : "path",
251 "required" : true,
252 "type" : "string"
253 } ],
254 "responses" : {
255 "200" : { }
256 },
257 "x-camelContextId" : "camel-1",
258 "x-routeId" : "route14"
259 }
260 },
261 "/clds/sdc/services" : {
262 "get" : {
263 "operationId" : "route12",
264 "produces" : [ "application/json" ],
265 "responses" : {
266 "200" : { }
267 },
268 "x-camelContextId" : "camel-1",
269 "x-routeId" : "route12"
270 }
271 },
272 "/clds/undeploy/{modelName}" : {
273 "put" : {
274 "operationId" : "route16",
275 "consumes" : [ "application/json" ],
276 "produces" : [ "application/json" ],
277 "parameters" : [ {
278 "name" : "modelName",
279 "in" : "path",
280 "required" : true,
281 "type" : "string"
282 }, {
283 "in" : "body",
284 "name" : "body",
285 "required" : true,
286 "schema" : {
287 "$ref" : "#/definitions/CldsModel"
288 }
289 } ],
290 "responses" : {
291 "200" : { }
292 },
293 "x-camelContextId" : "camel-1",
294 "x-routeId" : "route16"
295 }
296 },
297 "/cldsTempate/template-names" : {
298 "get" : {
299 "operationId" : "route21",
300 "produces" : [ "application/json" ],
301 "responses" : {
302 "200" : {
303 "description" : "Output type",
304 "responseSchema" : {
305 "$ref" : "#/definitions/ValueItem"
306 },
307 "schema" : {
308 "$ref" : "#/definitions/ValueItem"
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]309 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]310 }
311 },
312 "x-camelContextId" : "camel-1",
313 "x-routeId" : "route21"
314 }
315 },
316 "/cldsTempate/template/{templateName}" : {
317 "get" : {
318 "operationId" : "route19",
319 "produces" : [ "application/json" ],
320 "parameters" : [ {
321 "name" : "templateName",
322 "in" : "path",
323 "required" : true,
324 "type" : "string"
325 } ],
326 "responses" : {
327 "200" : {
328 "description" : "Output type",
329 "responseSchema" : {
330 "$ref" : "#/definitions/CldsTemplate"
331 },
332 "schema" : {
333 "$ref" : "#/definitions/CldsTemplate"
334 }
335 }
336 },
337 "x-camelContextId" : "camel-1",
338 "x-routeId" : "route19"
339 },
340 "put" : {
341 "operationId" : "route20",
342 "consumes" : [ "application/json" ],
343 "produces" : [ "application/json" ],
344 "parameters" : [ {
345 "name" : "templateName",
346 "in" : "path",
347 "required" : true,
348 "type" : "string"
349 }, {
350 "in" : "body",
351 "name" : "body",
352 "required" : true,
353 "schema" : {
354 "$ref" : "#/definitions/CldsTemplate"
355 }
356 } ],
357 "responses" : {
358 "200" : {
359 "description" : "Output type",
360 "responseSchema" : {
361 "$ref" : "#/definitions/CldsTemplate"
362 },
363 "schema" : {
364 "$ref" : "#/definitions/CldsTemplate"
365 }
366 }
367 },
368 "x-camelContextId" : "camel-1",
369 "x-routeId" : "route20"
370 }
371 },
372 "/cldsTempate/template/bpmn/{templateName}" : {
373 "get" : {
374 "operationId" : "route17",
375 "produces" : [ "text/xml" ],
376 "parameters" : [ {
377 "name" : "templateName",
378 "in" : "path",
379 "required" : true,
380 "type" : "string"
381 } ],
382 "responses" : {
383 "200" : { }
384 },
385 "x-camelContextId" : "camel-1",
386 "x-routeId" : "route17"
387 }
388 },
389 "/cldsTempate/template/image/{templateName}" : {
390 "get" : {
391 "operationId" : "route18",
392 "produces" : [ "text/xml" ],
393 "parameters" : [ {
394 "name" : "templateName",
395 "in" : "path",
396 "required" : true,
397 "type" : "string"
398 } ],
399 "responses" : {
400 "200" : { }
401 },
402 "x-camelContextId" : "camel-1",
403 "x-routeId" : "route18"
404 }
405 },
406 "/healthcheck" : {
407 "get" : {
408 "operationId" : "route4",
409 "produces" : [ "application/json" ],
410 "responses" : {
411 "200" : { }
412 },
413 "x-camelContextId" : "camel-1",
414 "x-routeId" : "route4"
415 }
416 },
417 "/user/getUser" : {
418 "get" : {
419 "operationId" : "route22",
420 "produces" : [ "text/plain" ],
421 "responses" : {
422 "200" : { }
423 },
424 "x-camelContextId" : "camel-1",
425 "x-routeId" : "route22"
426 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]427 }
Determe, Sebastien (sd378r)f7442472018-08-03 15:52:19 +0200[diff] [blame]428 },
429 "definitions" : {
430 "CldsModelInstance" : {
431 "type" : "object",
432 "properties" : {
433 "modelInstanceId" : {
434 "type" : "string"
435 },
436 "location" : {
437 "type" : "string"
438 },
439 "vmName" : {
440 "type" : "string"
441 }
442 }
443 },
444 "CldsModel" : {
445 "type" : "object",
446 "properties" : {
447 "id" : {
448 "type" : "string"
449 },
450 "templateId" : {
451 "type" : "string"
452 },
453 "templateName" : {
454 "type" : "string"
455 },
456 "name" : {
457 "type" : "string"
458 },
459 "controlNamePrefix" : {
460 "type" : "string"
461 },
462 "controlNameUuid" : {
463 "type" : "string"
464 },
465 "bpmnText" : {
466 "type" : "string"
467 },
468 "propText" : {
469 "type" : "string"
470 },
471 "imageText" : {
472 "type" : "string"
473 },
474 "docText" : {
475 "type" : "string"
476 },
477 "blueprintText" : {
478 "type" : "string"
479 },
480 "event" : {
481 "$ref" : "#/definitions/CldsEvent"
482 },
483 "status" : {
484 "type" : "string"
485 },
486 "permittedActionCd" : {
487 "type" : "array",
488 "items" : {
489 "type" : "string"
490 }
491 },
492 "cldsModelInstanceList" : {
493 "type" : "array",
494 "items" : {
495 "$ref" : "#/definitions/CldsModelInstance"
496 }
497 },
498 "typeId" : {
499 "type" : "string"
500 },
501 "typeName" : {
502 "type" : "string"
503 },
504 "deploymentId" : {
505 "type" : "string"
506 },
507 "controlName" : {
508 "type" : "string"
509 }
510 },
511 "x-className" : {
512 "type" : "string",
513 "format" : "org.onap.clamp.clds.model.CldsModel"
514 }
515 },
516 "CldsEvent" : {
517 "type" : "object",
518 "properties" : {
519 "id" : {
520 "type" : "string"
521 },
522 "actionCd" : {
523 "type" : "string"
524 },
525 "actionStateCd" : {
526 "type" : "string"
527 },
528 "processInstanceId" : {
529 "type" : "string"
530 },
531 "userid" : {
532 "type" : "string"
533 }
534 }
535 },
536 "CldsMonitoringDetails" : {
537 "type" : "object",
538 "properties" : {
539 "closeloopName" : {
540 "type" : "string"
541 },
542 "modelName" : {
543 "type" : "string"
544 },
545 "serviceTypeId" : {
546 "type" : "string"
547 },
548 "deploymentId" : {
549 "type" : "string"
550 },
551 "templateName" : {
552 "type" : "string"
553 },
554 "action" : {
555 "type" : "string"
556 },
557 "userid" : {
558 "type" : "string"
559 },
560 "timestamp" : {
561 "type" : "string"
562 }
563 },
564 "x-className" : {
565 "type" : "string",
566 "format" : "org.onap.clamp.clds.model.CldsMonitoringDetails"
567 }
568 },
569 "CldsInfo" : {
570 "type" : "object",
571 "properties" : {
572 "userName" : {
573 "type" : "string"
574 },
575 "cldsVersion" : {
576 "type" : "string"
577 },
578 "permissionReadCl" : {
579 "type" : "boolean"
580 },
581 "permissionUpdateCl" : {
582 "type" : "boolean"
583 },
584 "permissionReadTemplate" : {
585 "type" : "boolean"
586 },
587 "permissionUpdateTemplate" : {
588 "type" : "boolean"
589 }
590 },
591 "x-className" : {
592 "type" : "string",
593 "format" : "org.onap.clamp.clds.model.CldsInfo"
594 }
595 },
596 "DcaeEvent" : {
597 "type" : "object",
598 "properties" : {
599 "event" : {
600 "type" : "string"
601 },
602 "serviceUUID" : {
603 "type" : "string"
604 },
605 "resourceUUID" : {
606 "type" : "string"
607 },
608 "artifactName" : {
609 "type" : "string"
610 },
611 "instances" : {
612 "type" : "array",
613 "items" : {
614 "$ref" : "#/definitions/CldsModelInstance"
615 }
616 },
617 "controlName" : {
618 "type" : "string"
619 },
620 "cldsActionCd" : {
621 "type" : "string"
622 }
623 },
624 "x-className" : {
625 "type" : "string",
626 "format" : "org.onap.clamp.clds.model.DcaeEvent"
627 }
628 },
629 "ValueItem" : {
630 "type" : "object",
631 "properties" : {
632 "value" : {
633 "type" : "string"
634 }
635 },
636 "x-className" : {
637 "type" : "string",
638 "format" : "org.onap.clamp.clds.model.ValueItem"
639 }
640 },
641 "CldsTemplate" : {
642 "type" : "object",
643 "properties" : {
644 "id" : {
645 "type" : "string"
646 },
647 "name" : {
648 "type" : "string"
649 },
650 "controlNamePrefix" : {
651 "type" : "string"
652 },
653 "controlNameUuid" : {
654 "type" : "string"
655 },
656 "bpmnId" : {
657 "type" : "string"
658 },
659 "bpmnUserid" : {
660 "type" : "string"
661 },
662 "bpmnText" : {
663 "type" : "string"
664 },
665 "imageId" : {
666 "type" : "string"
667 },
668 "imageUserid" : {
669 "type" : "string"
670 },
671 "imageText" : {
672 "type" : "string"
673 },
674 "propId" : {
675 "type" : "string"
676 },
677 "propUserid" : {
678 "type" : "string"
679 },
680 "propText" : {
681 "type" : "string"
682 },
683 "userAuthorizedToUpdate" : {
684 "type" : "boolean"
685 }
686 },
687 "x-className" : {
688 "type" : "string",
689 "format" : "org.onap.clamp.clds.model.CldsTemplate"
690 }
691 }
692 }
xg353y2aad6d62018-05-18 17:59:06 +0200[diff] [blame]693}