Merge "Remove SDC query"
[clamp.git] / docs / swagger / swagger.json
1 {
2   "swagger" : "2.0",
3   "info" : {
4     "version" : "4.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" : "route66",
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-3",
38         "x-routeId" : "route66"
39       }
40     },
41     "/clds/cldsDetails" : {
42       "get" : {
43         "operationId" : "route58",
44         "produces" : [ "application/json" ],
45         "responses" : {
46           "200" : {
47             "description" : "Output type",
48             "responseSchema" : {
49               "$ref" : "#/definitions/CldsMonitoringDetails"
50             },
51             "schema" : {
52               "$ref" : "#/definitions/CldsMonitoringDetails"
53             }
54           }
55         },
56         "x-camelContextId" : "camel-3",
57         "x-routeId" : "route58"
58       }
59     },
60     "/clds/cldsInfo" : {
61       "get" : {
62         "operationId" : "route59",
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"
72             }
73           }
74         },
75         "x-camelContextId" : "camel-3",
76         "x-routeId" : "route59"
77       }
78     },
79     "/clds/dcae/event?test={test}" : {
80       "post" : {
81         "operationId" : "route67",
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" : { }
94         },
95         "x-camelContextId" : "camel-3",
96         "x-routeId" : "route67"
97       }
98     },
99     "/clds/deploy/{modelName}" : {
100       "put" : {
101         "operationId" : "route69",
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" : { }
119         },
120         "x-camelContextId" : "camel-3",
121         "x-routeId" : "route69"
122       }
123     },
124     "/clds/model-names" : {
125       "get" : {
126         "operationId" : "route65",
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"
136             }
137           }
138         },
139         "x-camelContextId" : "camel-3",
140         "x-routeId" : "route65"
141       }
142     },
143     "/clds/model/{modelName}" : {
144       "get" : {
145         "operationId" : "route63",
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"
161             }
162           }
163         },
164         "x-camelContextId" : "camel-3",
165         "x-routeId" : "route63"
166       },
167       "put" : {
168         "operationId" : "route64",
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"
192             }
193           }
194         },
195         "x-camelContextId" : "camel-3",
196         "x-routeId" : "route64"
197       }
198     },
199     "/clds/model/bpmn/{modelName}" : {
200       "get" : {
201         "operationId" : "route61",
202         "produces" : [ "text/xml" ],
203         "parameters" : [ {
204           "name" : "modelName",
205           "in" : "path",
206           "required" : true,
207           "type" : "string"
208         } ],
209         "responses" : {
210           "200" : { }
211         },
212         "x-camelContextId" : "camel-3",
213         "x-routeId" : "route61"
214       }
215     },
216     "/clds/model/image/{modelName}" : {
217       "get" : {
218         "operationId" : "route62",
219         "produces" : [ "text/xml" ],
220         "parameters" : [ {
221           "name" : "modelName",
222           "in" : "path",
223           "required" : true,
224           "type" : "string"
225         } ],
226         "responses" : {
227           "200" : { }
228         },
229         "x-camelContextId" : "camel-3",
230         "x-routeId" : "route62"
231       }
232     },
233     "/clds/properties" : {
234       "get" : {
235         "operationId" : "route68",
236         "produces" : [ "application/json" ],
237         "responses" : {
238           "200" : { }
239         },
240         "x-camelContextId" : "camel-3",
241         "x-routeId" : "route68"
242       }
243     },
244     "/clds/undeploy/{modelName}" : {
245       "put" : {
246         "operationId" : "route70",
247         "consumes" : [ "application/json" ],
248         "produces" : [ "application/json" ],
249         "parameters" : [ {
250           "name" : "modelName",
251           "in" : "path",
252           "required" : true,
253           "type" : "string"
254         }, {
255           "in" : "body",
256           "name" : "body",
257           "required" : true,
258           "schema" : {
259             "$ref" : "#/definitions/CldsModel"
260           }
261         } ],
262         "responses" : {
263           "200" : { }
264         },
265         "x-camelContextId" : "camel-3",
266         "x-routeId" : "route70"
267       }
268     },
269     "/cldsTempate/template-names" : {
270       "get" : {
271         "operationId" : "route75",
272         "produces" : [ "application/json" ],
273         "responses" : {
274           "200" : {
275             "description" : "Output type",
276             "responseSchema" : {
277               "$ref" : "#/definitions/ValueItem"
278             },
279             "schema" : {
280               "$ref" : "#/definitions/ValueItem"
281             }
282           }
283         },
284         "x-camelContextId" : "camel-3",
285         "x-routeId" : "route75"
286       }
287     },
288     "/cldsTempate/template/{templateName}" : {
289       "get" : {
290         "operationId" : "route73",
291         "produces" : [ "application/json" ],
292         "parameters" : [ {
293           "name" : "templateName",
294           "in" : "path",
295           "required" : true,
296           "type" : "string"
297         } ],
298         "responses" : {
299           "200" : {
300             "description" : "Output type",
301             "responseSchema" : {
302               "$ref" : "#/definitions/CldsTemplate"
303             },
304             "schema" : {
305               "$ref" : "#/definitions/CldsTemplate"
306             }
307           }
308         },
309         "x-camelContextId" : "camel-3",
310         "x-routeId" : "route73"
311       },
312       "put" : {
313         "operationId" : "route74",
314         "consumes" : [ "application/json" ],
315         "produces" : [ "application/json" ],
316         "parameters" : [ {
317           "name" : "templateName",
318           "in" : "path",
319           "required" : true,
320           "type" : "string"
321         }, {
322           "in" : "body",
323           "name" : "body",
324           "required" : true,
325           "schema" : {
326             "$ref" : "#/definitions/CldsTemplate"
327           }
328         } ],
329         "responses" : {
330           "200" : {
331             "description" : "Output type",
332             "responseSchema" : {
333               "$ref" : "#/definitions/CldsTemplate"
334             },
335             "schema" : {
336               "$ref" : "#/definitions/CldsTemplate"
337             }
338           }
339         },
340         "x-camelContextId" : "camel-3",
341         "x-routeId" : "route74"
342       }
343     },
344     "/cldsTempate/template/bpmn/{templateName}" : {
345       "get" : {
346         "operationId" : "route71",
347         "produces" : [ "text/xml" ],
348         "parameters" : [ {
349           "name" : "templateName",
350           "in" : "path",
351           "required" : true,
352           "type" : "string"
353         } ],
354         "responses" : {
355           "200" : { }
356         },
357         "x-camelContextId" : "camel-3",
358         "x-routeId" : "route71"
359       }
360     },
361     "/cldsTempate/template/image/{templateName}" : {
362       "get" : {
363         "operationId" : "route72",
364         "produces" : [ "text/xml" ],
365         "parameters" : [ {
366           "name" : "templateName",
367           "in" : "path",
368           "required" : true,
369           "type" : "string"
370         } ],
371         "responses" : {
372           "200" : { }
373         },
374         "x-camelContextId" : "camel-3",
375         "x-routeId" : "route72"
376       }
377     },
378     "/dictionary" : {
379       "get" : {
380         "operationId" : "route81",
381         "produces" : [ "application/json" ],
382         "responses" : {
383           "200" : {
384             "description" : "Output type",
385             "responseSchema" : {
386               "$ref" : "#/definitions/CldsDictionary"
387             },
388             "schema" : {
389               "$ref" : "#/definitions/CldsDictionary"
390             }
391           }
392         },
393         "x-camelContextId" : "camel-3",
394         "x-routeId" : "route81"
395       }
396     },
397     "/dictionary/{dictionaryName}" : {
398       "put" : {
399         "operationId" : "route80",
400         "consumes" : [ "application/json" ],
401         "produces" : [ "application/json" ],
402         "parameters" : [ {
403           "name" : "dictionaryName",
404           "in" : "path",
405           "required" : true,
406           "type" : "string"
407         }, {
408           "in" : "body",
409           "name" : "body",
410           "required" : true,
411           "schema" : {
412             "$ref" : "#/definitions/CldsDictionary"
413           }
414         } ],
415         "responses" : {
416           "200" : {
417             "description" : "Output type",
418             "responseSchema" : {
419               "$ref" : "#/definitions/CldsDictionary"
420             },
421             "schema" : {
422               "$ref" : "#/definitions/CldsDictionary"
423             }
424           }
425         },
426         "x-camelContextId" : "camel-3",
427         "x-routeId" : "route80"
428       }
429     },
430     "/dictionary/{dictionaryName}/items" : {
431       "get" : {
432         "operationId" : "route83",
433         "produces" : [ "application/json" ],
434         "parameters" : [ {
435           "name" : "dictionaryName",
436           "in" : "path",
437           "required" : true,
438           "type" : "string"
439         } ],
440         "responses" : {
441           "200" : {
442             "description" : "Output type",
443             "responseSchema" : {
444               "$ref" : "#/definitions/CldsDictionary"
445             },
446             "schema" : {
447               "$ref" : "#/definitions/CldsDictionary"
448             }
449           }
450         },
451         "x-camelContextId" : "camel-3",
452         "x-routeId" : "route83"
453       },
454       "put" : {
455         "operationId" : "route82",
456         "consumes" : [ "application/json" ],
457         "produces" : [ "application/json" ],
458         "parameters" : [ {
459           "name" : "dictionaryName",
460           "in" : "path",
461           "required" : true,
462           "type" : "string"
463         }, {
464           "in" : "body",
465           "name" : "body",
466           "required" : true,
467           "schema" : {
468             "$ref" : "#/definitions/CldsDictionaryItem"
469           }
470         } ],
471         "responses" : {
472           "200" : {
473             "description" : "Output type",
474             "responseSchema" : {
475               "$ref" : "#/definitions/CldsDictionaryItem"
476             },
477             "schema" : {
478               "$ref" : "#/definitions/CldsDictionaryItem"
479             }
480           }
481         },
482         "x-camelContextId" : "camel-3",
483         "x-routeId" : "route82"
484       }
485     },
486     "/healthcheck" : {
487       "get" : {
488         "operationId" : "route60",
489         "produces" : [ "application/json" ],
490         "responses" : {
491           "200" : { }
492         },
493         "x-camelContextId" : "camel-3",
494         "x-routeId" : "route60"
495       }
496     },
497     "/tosca/models" : {
498       "get" : {
499         "operationId" : "route78",
500         "produces" : [ "application/json" ],
501         "responses" : {
502           "200" : {
503             "description" : "Output type",
504             "responseSchema" : {
505               "$ref" : "#/definitions/CldsToscaModel"
506             },
507             "schema" : {
508               "$ref" : "#/definitions/CldsToscaModel"
509             }
510           }
511         },
512         "x-camelContextId" : "camel-3",
513         "x-routeId" : "route78"
514       }
515     },
516     "/tosca/models/{toscaModelName}" : {
517       "get" : {
518         "operationId" : "route79",
519         "produces" : [ "application/json" ],
520         "parameters" : [ {
521           "name" : "toscaModelName",
522           "in" : "path",
523           "required" : true,
524           "type" : "string"
525         } ],
526         "responses" : {
527           "200" : {
528             "description" : "Output type",
529             "responseSchema" : {
530               "$ref" : "#/definitions/CldsToscaModel"
531             },
532             "schema" : {
533               "$ref" : "#/definitions/CldsToscaModel"
534             }
535           }
536         },
537         "x-camelContextId" : "camel-3",
538         "x-routeId" : "route79"
539       },
540       "put" : {
541         "operationId" : "route76",
542         "consumes" : [ "application/json" ],
543         "produces" : [ "application/json" ],
544         "parameters" : [ {
545           "name" : "toscaModelName",
546           "in" : "path",
547           "required" : true,
548           "type" : "string"
549         }, {
550           "in" : "body",
551           "name" : "body",
552           "required" : true,
553           "schema" : {
554             "$ref" : "#/definitions/CldsToscaModel"
555           }
556         } ],
557         "responses" : {
558           "200" : { }
559         },
560         "x-camelContextId" : "camel-3",
561         "x-routeId" : "route76"
562       }
563     },
564     "/tosca/models/policyType/{policyType}" : {
565       "get" : {
566         "operationId" : "route77",
567         "produces" : [ "application/json" ],
568         "parameters" : [ {
569           "name" : "policyType",
570           "in" : "path",
571           "required" : true,
572           "type" : "string"
573         } ],
574         "responses" : {
575           "200" : { }
576         },
577         "x-camelContextId" : "camel-3",
578         "x-routeId" : "route77"
579       }
580     },
581     "/user/getUser" : {
582       "get" : {
583         "operationId" : "route84",
584         "produces" : [ "text/plain" ],
585         "responses" : {
586           "200" : { }
587         },
588         "x-camelContextId" : "camel-3",
589         "x-routeId" : "route84"
590       }
591     }
592   },
593   "definitions" : {
594     "CldsModelInstance" : {
595       "type" : "object",
596       "properties" : {
597         "modelInstanceId" : {
598           "type" : "string"
599         },
600         "location" : {
601           "type" : "string"
602         },
603         "vmName" : {
604           "type" : "string"
605         }
606       }
607     },
608     "CldsModel" : {
609       "type" : "object",
610       "properties" : {
611         "id" : {
612           "type" : "string"
613         },
614         "templateId" : {
615           "type" : "string"
616         },
617         "templateName" : {
618           "type" : "string"
619         },
620         "name" : {
621           "type" : "string"
622         },
623         "controlNamePrefix" : {
624           "type" : "string"
625         },
626         "controlNameUuid" : {
627           "type" : "string"
628         },
629         "bpmnText" : {
630           "type" : "string"
631         },
632         "propText" : {
633           "type" : "string"
634         },
635         "imageText" : {
636           "type" : "string"
637         },
638         "docText" : {
639           "type" : "string"
640         },
641         "blueprintText" : {
642           "type" : "string"
643         },
644         "event" : {
645           "$ref" : "#/definitions/CldsEvent"
646         },
647         "status" : {
648           "type" : "string"
649         },
650         "permittedActionCd" : {
651           "type" : "array",
652           "items" : {
653             "type" : "string"
654           }
655         },
656         "cldsModelInstanceList" : {
657           "type" : "array",
658           "items" : {
659             "$ref" : "#/definitions/CldsModelInstance"
660           }
661         },
662         "errorMessageForUi" : {
663           "type" : "string"
664         },
665         "typeId" : {
666           "type" : "string"
667         },
668         "typeName" : {
669           "type" : "string"
670         },
671         "deploymentId" : {
672           "type" : "string"
673         },
674         "deploymentStatusUrl" : {
675           "type" : "string"
676         },
677         "controlName" : {
678           "type" : "string"
679         }
680       },
681       "x-className" : {
682         "type" : "string",
683         "format" : "org.onap.clamp.clds.model.CldsModel"
684       }
685     },
686     "CldsEvent" : {
687       "type" : "object",
688       "properties" : {
689         "id" : {
690           "type" : "string"
691         },
692         "actionCd" : {
693           "type" : "string"
694         },
695         "actionStateCd" : {
696           "type" : "string"
697         },
698         "processInstanceId" : {
699           "type" : "string"
700         },
701         "userid" : {
702           "type" : "string"
703         }
704       }
705     },
706     "CldsMonitoringDetails" : {
707       "type" : "object",
708       "properties" : {
709         "closeloopName" : {
710           "type" : "string"
711         },
712         "modelId" : {
713           "type" : "string"
714         },
715         "modelName" : {
716           "type" : "string"
717         },
718         "serviceTypeId" : {
719           "type" : "string"
720         },
721         "deploymentId" : {
722           "type" : "string"
723         },
724         "templateName" : {
725           "type" : "string"
726         },
727         "action" : {
728           "type" : "string"
729         },
730         "userid" : {
731           "type" : "string"
732         },
733         "timestamp" : {
734           "type" : "string"
735         }
736       },
737       "x-className" : {
738         "type" : "string",
739         "format" : "org.onap.clamp.clds.model.CldsMonitoringDetails"
740       }
741     },
742     "CldsInfo" : {
743       "type" : "object",
744       "properties" : {
745         "userName" : {
746           "type" : "string"
747         },
748         "cldsVersion" : {
749           "type" : "string"
750         },
751         "permissionReadCl" : {
752           "type" : "boolean"
753         },
754         "permissionUpdateCl" : {
755           "type" : "boolean"
756         },
757         "permissionReadTemplate" : {
758           "type" : "boolean"
759         },
760         "permissionUpdateTemplate" : {
761           "type" : "boolean"
762         },
763         "permissionReadTosca" : {
764           "type" : "boolean"
765         },
766         "permissionUpdateTosca" : {
767           "type" : "boolean"
768         }
769       },
770       "x-className" : {
771         "type" : "string",
772         "format" : "org.onap.clamp.clds.model.CldsInfo"
773       }
774     },
775     "DcaeEvent" : {
776       "type" : "object",
777       "properties" : {
778         "event" : {
779           "type" : "string"
780         },
781         "serviceUUID" : {
782           "type" : "string"
783         },
784         "resourceUUID" : {
785           "type" : "string"
786         },
787         "artifactName" : {
788           "type" : "string"
789         },
790         "instances" : {
791           "type" : "array",
792           "items" : {
793             "$ref" : "#/definitions/CldsModelInstance"
794           }
795         },
796         "controlName" : {
797           "type" : "string"
798         },
799         "cldsActionCd" : {
800           "type" : "string"
801         }
802       },
803       "x-className" : {
804         "type" : "string",
805         "format" : "org.onap.clamp.clds.model.DcaeEvent"
806       }
807     },
808     "ValueItem" : {
809       "type" : "object",
810       "properties" : {
811         "value" : {
812           "type" : "string"
813         }
814       },
815       "x-className" : {
816         "type" : "string",
817         "format" : "org.onap.clamp.clds.model.ValueItem"
818       }
819     },
820     "CldsTemplate" : {
821       "type" : "object",
822       "properties" : {
823         "id" : {
824           "type" : "string"
825         },
826         "name" : {
827           "type" : "string"
828         },
829         "controlNamePrefix" : {
830           "type" : "string"
831         },
832         "controlNameUuid" : {
833           "type" : "string"
834         },
835         "bpmnId" : {
836           "type" : "string"
837         },
838         "bpmnUserid" : {
839           "type" : "string"
840         },
841         "bpmnText" : {
842           "type" : "string"
843         },
844         "imageId" : {
845           "type" : "string"
846         },
847         "imageUserid" : {
848           "type" : "string"
849         },
850         "imageText" : {
851           "type" : "string"
852         },
853         "propId" : {
854           "type" : "string"
855         },
856         "propUserid" : {
857           "type" : "string"
858         },
859         "propText" : {
860           "type" : "string"
861         },
862         "userAuthorizedToUpdate" : {
863           "type" : "boolean"
864         }
865       },
866       "x-className" : {
867         "type" : "string",
868         "format" : "org.onap.clamp.clds.model.CldsTemplate"
869       }
870     },
871     "CldsDictionary" : {
872       "type" : "object",
873       "properties" : {
874         "dictionaryId" : {
875           "type" : "string"
876         },
877         "dictionaryName" : {
878           "type" : "string"
879         },
880         "createdBy" : {
881           "type" : "string"
882         },
883         "updatedBy" : {
884           "type" : "string"
885         },
886         "lastUpdatedDate" : {
887           "type" : "string"
888         },
889         "cldsDictionaryItems" : {
890           "type" : "array",
891           "items" : {
892             "$ref" : "#/definitions/CldsDictionaryItem"
893           }
894         }
895       },
896       "x-className" : {
897         "type" : "string",
898         "format" : "org.onap.clamp.clds.model.CldsDictionary"
899       }
900     },
901     "CldsDictionaryItem" : {
902       "type" : "object",
903       "properties" : {
904         "dictElementId" : {
905           "type" : "string"
906         },
907         "dictionaryId" : {
908           "type" : "string"
909         },
910         "dictElementName" : {
911           "type" : "string"
912         },
913         "dictElementShortName" : {
914           "type" : "string"
915         },
916         "dictElementDesc" : {
917           "type" : "string"
918         },
919         "dictElementType" : {
920           "type" : "string"
921         },
922         "createdBy" : {
923           "type" : "string"
924         },
925         "updatedBy" : {
926           "type" : "string"
927         },
928         "lastUpdatedDate" : {
929           "type" : "string"
930         }
931       },
932       "x-className" : {
933         "type" : "string",
934         "format" : "org.onap.clamp.clds.model.CldsDictionaryItem"
935       }
936     },
937     "CldsToscaModel" : {
938       "type" : "object",
939       "properties" : {
940         "revisionId" : {
941           "type" : "string"
942         },
943         "toscaModelYaml" : {
944           "type" : "string"
945         },
946         "version" : {
947           "type" : "number",
948           "format" : "double"
949         },
950         "toscaModelJson" : {
951           "type" : "string"
952         },
953         "userId" : {
954           "type" : "string"
955         },
956         "createdDate" : {
957           "type" : "string"
958         },
959         "lastUpdatedDate" : {
960           "type" : "string"
961         },
962         "id" : {
963           "type" : "string"
964         },
965         "policyType" : {
966           "type" : "string"
967         },
968         "toscaModelName" : {
969           "type" : "string"
970         }
971       },
972       "x-className" : {
973         "type" : "string",
974         "format" : "org.onap.clamp.clds.model.CldsToscaModel"
975       }
976     }
977   }
978 }