docs/swagger/swagger.json

   1 {
   2   "swagger" : "2.0",
   3   "info" : {
   4     "version" : "4.1.2-SNAPSHOT",
   5     "title" : "Clamp Rest API"
   6   },
   7   "host" : "localhost:36829",
   8   "basePath" : "/restservices/clds/",
   9   "schemes" : [ "http" ],
  10   "paths" : {
  11     "/v2/loop/{loopName}" : {
  12       "get" : {
  13         "operationId" : "route20",
  14         "produces" : [ "application/json" ],
  15         "parameters" : [ {
  16           "name" : "loopName",
  17           "in" : "path",
  18           "required" : true,
  19           "type" : "string"
  20         } ],
  21         "responses" : {
  22           "200" : {
  23             "description" : "Output type",
  24             "schema" : {
  25               "$ref" : "#/definitions/Loop"
  26             }
  27           }
  28         },
  29         "x-camelContextId" : "camel-2",
  30         "x-routeId" : "route20"
  31       }
  32     },
  33     "/v2/loop/delete/{loopName}" : {
  34       "put" : {
  35         "operationId" : "route30",
  36         "parameters" : [ {
  37           "name" : "loopName",
  38           "in" : "path",
  39           "required" : true,
  40           "type" : "string"
  41         } ],
  42         "responses" : {
  43           "200" : { }
  44         },
  45         "x-camelContextId" : "camel-2",
  46         "x-routeId" : "route30"
  47       }
  48     },
  49     "/v2/loop/deploy/{loopName}" : {
  50       "put" : {
  51         "operationId" : "route25",
  52         "produces" : [ "application/json" ],
  53         "parameters" : [ {
  54           "name" : "loopName",
  55           "in" : "path",
  56           "required" : true,
  57           "type" : "string"
  58         } ],
  59         "responses" : {
  60           "200" : {
  61             "description" : "Output type",
  62             "schema" : {
  63               "$ref" : "#/definitions/Loop"
  64             }
  65           }
  66         },
  67         "x-camelContextId" : "camel-2",
  68         "x-routeId" : "route25"
  69       }
  70     },
  71     "/v2/loop/getAllNames" : {
  72       "get" : {
  73         "operationId" : "route19",
  74         "produces" : [ "application/json" ],
  75         "responses" : {
  76           "200" : {
  77             "description" : "Output type",
  78             "schema" : {
  79               "type" : "array",
  80               "items" : {
  81                 "type" : "string"
  82               }
  83             }
  84           }
  85         },
  86         "x-camelContextId" : "camel-2",
  87         "x-routeId" : "route19"
  88       }
  89     },
  90     "/v2/loop/getstatus/{loopName}" : {
  91       "get" : {
  92         "operationId" : "route31",
  93         "produces" : [ "application/json" ],
  94         "parameters" : [ {
  95           "name" : "loopName",
  96           "in" : "path",
  97           "required" : true,
  98           "type" : "string"
  99         } ],
 100         "responses" : {
 101           "200" : {
 102             "description" : "Output type",
 103             "schema" : {
 104               "$ref" : "#/definitions/Loop"
 105             }
 106           }
 107         },
 108         "x-camelContextId" : "camel-2",
 109         "x-routeId" : "route31"
 110       }
 111     },
 112     "/v2/loop/restart/{loopName}" : {
 113       "put" : {
 114         "operationId" : "route28",
 115         "produces" : [ "application/json" ],
 116         "parameters" : [ {
 117           "name" : "loopName",
 118           "in" : "path",
 119           "required" : true,
 120           "type" : "string"
 121         } ],
 122         "responses" : {
 123           "200" : {
 124             "description" : "Output type",
 125             "schema" : {
 126               "$ref" : "#/definitions/Loop"
 127             }
 128           }
 129         },
 130         "x-camelContextId" : "camel-2",
 131         "x-routeId" : "route28"
 132       }
 133     },
 134     "/v2/loop/stop/{loopName}" : {
 135       "put" : {
 136         "operationId" : "route27",
 137         "produces" : [ "application/json" ],
 138         "parameters" : [ {
 139           "name" : "loopName",
 140           "in" : "path",
 141           "required" : true,
 142           "type" : "string"
 143         } ],
 144         "responses" : {
 145           "200" : {
 146             "description" : "Output type",
 147             "schema" : {
 148               "$ref" : "#/definitions/Loop"
 149             }
 150           }
 151         },
 152         "x-camelContextId" : "camel-2",
 153         "x-routeId" : "route27"
 154       }
 155     },
 156     "/v2/loop/submit/{loopName}" : {
 157       "put" : {
 158         "operationId" : "route29",
 159         "produces" : [ "application/json" ],
 160         "parameters" : [ {
 161           "name" : "loopName",
 162           "in" : "path",
 163           "required" : true,
 164           "type" : "string"
 165         } ],
 166         "responses" : {
 167           "200" : {
 168             "description" : "Output type",
 169             "schema" : {
 170               "$ref" : "#/definitions/Loop"
 171             }
 172           }
 173         },
 174         "x-camelContextId" : "camel-2",
 175         "x-routeId" : "route29"
 176       }
 177     },
 178     "/v2/loop/svgRepresentation/{loopName}" : {
 179       "get" : {
 180         "operationId" : "route21",
 181         "produces" : [ "application/xml" ],
 182         "parameters" : [ {
 183           "name" : "loopName",
 184           "in" : "path",
 185           "required" : true,
 186           "type" : "string"
 187         } ],
 188         "responses" : {
 189           "200" : {
 190             "description" : "Output type",
 191             "schema" : {
 192               "type" : "string"
 193             }
 194           }
 195         },
 196         "x-camelContextId" : "camel-2",
 197         "x-routeId" : "route21"
 198       }
 199     },
 200     "/v2/loop/undeploy/{loopName}" : {
 201       "put" : {
 202         "operationId" : "route26",
 203         "produces" : [ "application/json" ],
 204         "parameters" : [ {
 205           "name" : "loopName",
 206           "in" : "path",
 207           "required" : true,
 208           "type" : "string"
 209         } ],
 210         "responses" : {
 211           "200" : {
 212             "description" : "Output type",
 213             "schema" : {
 214               "$ref" : "#/definitions/Loop"
 215             }
 216           }
 217         },
 218         "x-camelContextId" : "camel-2",
 219         "x-routeId" : "route26"
 220       }
 221     },
 222     "/v2/loop/updateGlobalProperties/{loopName}" : {
 223       "post" : {
 224         "operationId" : "route22",
 225         "consumes" : [ "application/json" ],
 226         "produces" : [ "application/json" ],
 227         "parameters" : [ {
 228           "name" : "loopName",
 229           "in" : "path",
 230           "required" : true,
 231           "type" : "string"
 232         }, {
 233           "in" : "body",
 234           "name" : "body",
 235           "required" : true,
 236           "schema" : {
 237             "$ref" : "#/definitions/JsonObject"
 238           }
 239         } ],
 240         "responses" : {
 241           "200" : {
 242             "description" : "Output type",
 243             "schema" : {
 244               "$ref" : "#/definitions/Loop"
 245             }
 246           }
 247         },
 248         "x-camelContextId" : "camel-2",
 249         "x-routeId" : "route22"
 250       }
 251     },
 252     "/v2/loop/updateMicroservicePolicy/{loopName}" : {
 253       "post" : {
 254         "operationId" : "route24",
 255         "consumes" : [ "application/json" ],
 256         "produces" : [ "application/json" ],
 257         "parameters" : [ {
 258           "name" : "loopName",
 259           "in" : "path",
 260           "required" : true,
 261           "type" : "string"
 262         }, {
 263           "in" : "body",
 264           "name" : "body",
 265           "required" : true,
 266           "schema" : {
 267             "$ref" : "#/definitions/MicroServicePolicy"
 268           }
 269         } ],
 270         "responses" : {
 271           "200" : {
 272             "description" : "Output type",
 273             "schema" : {
 274               "$ref" : "#/definitions/MicroServicePolicy"
 275             }
 276           }
 277         },
 278         "x-camelContextId" : "camel-2",
 279         "x-routeId" : "route24"
 280       }
 281     },
 282     "/v2/loop/updateOperationalPolicies/{loopName}" : {
 283       "post" : {
 284         "operationId" : "route23",
 285         "consumes" : [ "application/json" ],
 286         "produces" : [ "application/json" ],
 287         "parameters" : [ {
 288           "name" : "loopName",
 289           "in" : "path",
 290           "required" : true,
 291           "type" : "string"
 292         }, {
 293           "in" : "body",
 294           "name" : "body",
 295           "required" : true,
 296           "schema" : {
 297             "$ref" : "#/definitions/JsonArray"
 298           }
 299         } ],
 300         "responses" : {
 301           "200" : {
 302             "description" : "Output type",
 303             "schema" : {
 304               "$ref" : "#/definitions/Loop"
 305             }
 306           }
 307         },
 308         "x-camelContextId" : "camel-2",
 309         "x-routeId" : "route23"
 310       }
 311     },
 312     "/v1/clds/cldsInfo" : {
 313       "get" : {
 314         "operationId" : "route32",
 315         "produces" : [ "application/json" ],
 316         "responses" : {
 317           "200" : {
 318             "description" : "Output type",
 319             "schema" : {
 320               "$ref" : "#/definitions/CldsInfo"
 321             }
 322           }
 323         },
 324         "x-camelContextId" : "camel-2",
 325         "x-routeId" : "route32"
 326       }
 327     },
 328     "/v1/healthcheck" : {
 329       "get" : {
 330         "operationId" : "route33",
 331         "produces" : [ "application/json" ],
 332         "responses" : {
 333           "200" : { }
 334         },
 335         "x-camelContextId" : "camel-2",
 336         "x-routeId" : "route33"
 337       }
 338     },
 339     "/v1/user/getUser" : {
 340       "get" : {
 341         "operationId" : "route34",
 342         "produces" : [ "text/plain" ],
 343         "responses" : {
 344           "200" : { }
 345         },
 346         "x-camelContextId" : "camel-2",
 347         "x-routeId" : "route34"
 348       }
 349     }
 350   },
 351   "definitions" : {
 352     "Loop" : {
 353       "type" : "object",
 354       "properties" : {
 355         "name" : {
 356           "type" : "string"
 357         },
 358         "dcaeDeploymentId" : {
 359           "type" : "string"
 360         },
 361         "dcaeDeploymentStatusUrl" : {
 362           "type" : "string"
 363         },
 364         "dcaeBlueprintId" : {
 365           "type" : "string"
 366         },
 367         "svgRepresentation" : {
 368           "type" : "string"
 369         },
 370         "globalPropertiesJson" : {
 371           "$ref" : "#/definitions/JsonObject"
 372         },
 373         "modelPropertiesJson" : {
 374           "$ref" : "#/definitions/JsonObject"
 375         },
 376         "blueprint" : {
 377           "type" : "string"
 378         },
 379         "lastComputedState" : {
 380           "type" : "string",
 381           "enum" : [ "DESIGN", "SUBMITTED", "DEPLOYED", "RUNNING", "STOPPED", "IN_ERROR", "WAITING" ]
 382         },
 383         "components" : {
 384           "type" : "object",
 385           "additionalProperties" : {
 386             "$ref" : "#/definitions/ExternalComponent"
 387           }
 388         },
 389         "operationalPolicies" : {
 390           "type" : "array",
 391           "uniqueItems" : true,
 392           "items" : {
 393             "$ref" : "#/definitions/OperationalPolicy"
 394           }
 395         },
 396         "microServicePolicies" : {
 397           "type" : "array",
 398           "uniqueItems" : true,
 399           "items" : {
 400             "$ref" : "#/definitions/MicroServicePolicy"
 401           }
 402         },
 403         "loopLogs" : {
 404           "type" : "array",
 405           "uniqueItems" : true,
 406           "items" : {
 407             "$ref" : "#/definitions/LoopLog"
 408           }
 409         }
 410       },
 411       "x-className" : {
 412         "type" : "string",
 413         "format" : "org.onap.clamp.loop.Loop"
 414       }
 415     },
 416     "JsonArray" : {
 417       "type" : "object",
 418       "properties" : {
 419         "asString" : {
 420           "type" : "string"
 421         },
 422         "asNumber" : {
 423           "$ref" : "#/definitions/Number"
 424         },
 425         "asBoolean" : {
 426           "type" : "boolean"
 427         },
 428         "asDouble" : {
 429           "type" : "number",
 430           "format" : "double"
 431         },
 432         "asFloat" : {
 433           "type" : "number",
 434           "format" : "float"
 435         },
 436         "asLong" : {
 437           "type" : "integer",
 438           "format" : "int64"
 439         },
 440         "asInt" : {
 441           "type" : "integer",
 442           "format" : "int32"
 443         },
 444         "asByte" : {
 445           "type" : "string",
 446           "format" : "byte"
 447         },
 448         "asCharacter" : {
 449           "type" : "string"
 450         },
 451         "asBigDecimal" : {
 452           "type" : "number"
 453         },
 454         "asBigInteger" : {
 455           "type" : "integer"
 456         },
 457         "asShort" : {
 458           "type" : "integer",
 459           "format" : "int32"
 460         },
 461         "asJsonObject" : {
 462           "$ref" : "#/definitions/JsonObject"
 463         },
 464         "asJsonPrimitive" : {
 465           "$ref" : "#/definitions/JsonPrimitive"
 466         },
 467         "jsonPrimitive" : {
 468           "type" : "boolean"
 469         },
 470         "asJsonArray" : {
 471           "$ref" : "#/definitions/JsonArray"
 472         },
 473         "jsonObject" : {
 474           "type" : "boolean"
 475         },
 476         "jsonNull" : {
 477           "type" : "boolean"
 478         },
 479         "asJsonNull" : {
 480           "$ref" : "#/definitions/JsonNull"
 481         },
 482         "jsonArray" : {
 483           "type" : "boolean"
 484         }
 485       },
 486       "x-className" : {
 487         "type" : "string",
 488         "format" : "com.google.gson.JsonArray"
 489       }
 490     },
 491     "LoopLog" : {
 492       "type" : "object",
 493       "properties" : {
 494         "id" : {
 495           "type" : "integer",
 496           "format" : "int64"
 497         },
 498         "logType" : {
 499           "type" : "string",
 500           "enum" : [ "INFO", "WARNING", "ERROR" ]
 501         },
 502         "logComponent" : {
 503           "type" : "string"
 504         },
 505         "message" : {
 506           "type" : "string"
 507         },
 508         "loop" : {
 509           "$ref" : "#/definitions/Loop"
 510         },
 511         "logInstant" : {
 512           "type" : "integer",
 513           "format" : "int64"
 514         }
 515       }
 516     },
 517     "Number" : {
 518       "type" : "object"
 519     },
 520     "JsonPrimitive" : {
 521       "type" : "object",
 522       "properties" : {
 523         "boolean" : {
 524           "type" : "boolean"
 525         },
 526         "number" : {
 527           "type" : "boolean"
 528         },
 529         "asString" : {
 530           "type" : "string"
 531         },
 532         "asNumber" : {
 533           "$ref" : "#/definitions/Number"
 534         },
 535         "asBoolean" : {
 536           "type" : "boolean"
 537         },
 538         "asDouble" : {
 539           "type" : "number",
 540           "format" : "double"
 541         },
 542         "asFloat" : {
 543           "type" : "number",
 544           "format" : "float"
 545         },
 546         "asLong" : {
 547           "type" : "integer",
 548           "format" : "int64"
 549         },
 550         "asInt" : {
 551           "type" : "integer",
 552           "format" : "int32"
 553         },
 554         "asByte" : {
 555           "type" : "string",
 556           "format" : "byte"
 557         },
 558         "asCharacter" : {
 559           "type" : "string"
 560         },
 561         "asBigDecimal" : {
 562           "type" : "number"
 563         },
 564         "asBigInteger" : {
 565           "type" : "integer"
 566         },
 567         "asShort" : {
 568           "type" : "integer",
 569           "format" : "int32"
 570         },
 571         "string" : {
 572           "type" : "boolean"
 573         },
 574         "asJsonObject" : {
 575           "$ref" : "#/definitions/JsonObject"
 576         },
 577         "asJsonPrimitive" : {
 578           "$ref" : "#/definitions/JsonPrimitive"
 579         },
 580         "jsonPrimitive" : {
 581           "type" : "boolean"
 582         },
 583         "asJsonArray" : {
 584           "$ref" : "#/definitions/JsonArray"
 585         },
 586         "jsonObject" : {
 587           "type" : "boolean"
 588         },
 589         "jsonNull" : {
 590           "type" : "boolean"
 591         },
 592         "asJsonNull" : {
 593           "$ref" : "#/definitions/JsonNull"
 594         },
 595         "jsonArray" : {
 596           "type" : "boolean"
 597         }
 598       }
 599     },
 600     "MicroServicePolicy" : {
 601       "type" : "object",
 602       "properties" : {
 603         "name" : {
 604           "type" : "string"
 605         },
 606         "modelType" : {
 607           "type" : "string"
 608         },
 609         "properties" : {
 610           "$ref" : "#/definitions/JsonObject"
 611         },
 612         "shared" : {
 613           "type" : "boolean"
 614         },
 615         "policyTosca" : {
 616           "type" : "string"
 617         },
 618         "jsonRepresentation" : {
 619           "$ref" : "#/definitions/JsonObject"
 620         },
 621         "usedByLoops" : {
 622           "type" : "array",
 623           "uniqueItems" : true,
 624           "items" : {
 625             "$ref" : "#/definitions/Loop"
 626           }
 627         }
 628       },
 629       "x-className" : {
 630         "type" : "string",
 631         "format" : "org.onap.clamp.policy.microservice.MicroServicePolicy"
 632       }
 633     },
 634     "JsonObject" : {
 635       "type" : "object",
 636       "properties" : {
 637         "asJsonObject" : {
 638           "$ref" : "#/definitions/JsonObject"
 639         },
 640         "asJsonPrimitive" : {
 641           "$ref" : "#/definitions/JsonPrimitive"
 642         },
 643         "asString" : {
 644           "type" : "string"
 645         },
 646         "jsonPrimitive" : {
 647           "type" : "boolean"
 648         },
 649         "asJsonArray" : {
 650           "$ref" : "#/definitions/JsonArray"
 651         },
 652         "jsonObject" : {
 653           "type" : "boolean"
 654         },
 655         "asNumber" : {
 656           "$ref" : "#/definitions/Number"
 657         },
 658         "jsonNull" : {
 659           "type" : "boolean"
 660         },
 661         "asJsonNull" : {
 662           "$ref" : "#/definitions/JsonNull"
 663         },
 664         "jsonArray" : {
 665           "type" : "boolean"
 666         },
 667         "asBoolean" : {
 668           "type" : "boolean"
 669         },
 670         "asDouble" : {
 671           "type" : "number",
 672           "format" : "double"
 673         },
 674         "asFloat" : {
 675           "type" : "number",
 676           "format" : "float"
 677         },
 678         "asLong" : {
 679           "type" : "integer",
 680           "format" : "int64"
 681         },
 682         "asInt" : {
 683           "type" : "integer",
 684           "format" : "int32"
 685         },
 686         "asByte" : {
 687           "type" : "string",
 688           "format" : "byte"
 689         },
 690         "asCharacter" : {
 691           "type" : "string"
 692         },
 693         "asBigDecimal" : {
 694           "type" : "number"
 695         },
 696         "asBigInteger" : {
 697           "type" : "integer"
 698         },
 699         "asShort" : {
 700           "type" : "integer",
 701           "format" : "int32"
 702         }
 703       },
 704       "x-className" : {
 705         "type" : "string",
 706         "format" : "com.google.gson.JsonObject"
 707       }
 708     },
 709     "ExternalComponent" : {
 710       "type" : "object",
 711       "properties" : {
 712         "state" : {
 713           "$ref" : "#/definitions/ExternalComponentState"
 714         },
 715         "componentName" : {
 716           "type" : "string"
 717         }
 718       }
 719     },
 720     "OperationalPolicy" : {
 721       "type" : "object",
 722       "properties" : {
 723         "name" : {
 724           "type" : "string"
 725         },
 726         "configurationsJson" : {
 727           "$ref" : "#/definitions/JsonObject"
 728         },
 729         "loop" : {
 730           "$ref" : "#/definitions/Loop"
 731         },
 732         "jsonRepresentation" : {
 733           "$ref" : "#/definitions/JsonObject"
 734         }
 735       }
 736     },
 737     "ExternalComponentState" : {
 738       "type" : "object",
 739       "properties" : {
 740         "stateName" : {
 741           "type" : "string"
 742         },
 743         "description" : {
 744           "type" : "string"
 745         },
 746         "level" : {
 747           "type" : "integer",
 748           "format" : "int32"
 749         }
 750       }
 751     },
 752     "JsonNull" : {
 753       "type" : "object",
 754       "properties" : {
 755         "asJsonObject" : {
 756           "$ref" : "#/definitions/JsonObject"
 757         },
 758         "asJsonPrimitive" : {
 759           "$ref" : "#/definitions/JsonPrimitive"
 760         },
 761         "asString" : {
 762           "type" : "string"
 763         },
 764         "jsonPrimitive" : {
 765           "type" : "boolean"
 766         },
 767         "asJsonArray" : {
 768           "$ref" : "#/definitions/JsonArray"
 769         },
 770         "jsonObject" : {
 771           "type" : "boolean"
 772         },
 773         "asNumber" : {
 774           "$ref" : "#/definitions/Number"
 775         },
 776         "jsonNull" : {
 777           "type" : "boolean"
 778         },
 779         "asJsonNull" : {
 780           "$ref" : "#/definitions/JsonNull"
 781         },
 782         "jsonArray" : {
 783           "type" : "boolean"
 784         },
 785         "asBoolean" : {
 786           "type" : "boolean"
 787         },
 788         "asDouble" : {
 789           "type" : "number",
 790           "format" : "double"
 791         },
 792         "asFloat" : {
 793           "type" : "number",
 794           "format" : "float"
 795         },
 796         "asLong" : {
 797           "type" : "integer",
 798           "format" : "int64"
 799         },
 800         "asInt" : {
 801           "type" : "integer",
 802           "format" : "int32"
 803         },
 804         "asByte" : {
 805           "type" : "string",
 806           "format" : "byte"
 807         },
 808         "asCharacter" : {
 809           "type" : "string"
 810         },
 811         "asBigDecimal" : {
 812           "type" : "number"
 813         },
 814         "asBigInteger" : {
 815           "type" : "integer"
 816         },
 817         "asShort" : {
 818           "type" : "integer",
 819           "format" : "int32"
 820         }
 821       }
 822     },
 823     "CldsInfo" : {
 824       "type" : "object",
 825       "properties" : {
 826         "userName" : {
 827           "type" : "string"
 828         },
 829         "cldsVersion" : {
 830           "type" : "string"
 831         },
 832         "permissionReadCl" : {
 833           "type" : "boolean"
 834         },
 835         "permissionUpdateCl" : {
 836           "type" : "boolean"
 837         },
 838         "permissionReadTemplate" : {
 839           "type" : "boolean"
 840         },
 841         "permissionUpdateTemplate" : {
 842           "type" : "boolean"
 843         },
 844         "permissionReadTosca" : {
 845           "type" : "boolean"
 846         },
 847         "permissionUpdateTosca" : {
 848           "type" : "boolean"
 849         }
 850       },
 851       "x-className" : {
 852         "type" : "string",
 853         "format" : "org.onap.clamp.clds.model.CldsInfo"
 854       }
 855     }
 856   }
 857 }