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:34219",
   8   "basePath" : "/restservices/clds/",
   9   "schemes" : [ "http" ],
  10   "paths" : {
  11     "/v2/loop/{loopName}" : {
  12       "get" : {
  13         "operationId" : "route3",
  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-1",
  30         "x-routeId" : "route3"
  31       }
  32     },
  33     "/v2/loop/delete/{loopName}" : {
  34       "put" : {
  35         "operationId" : "route13",
  36         "parameters" : [ {
  37           "name" : "loopName",
  38           "in" : "path",
  39           "required" : true,
  40           "type" : "string"
  41         } ],
  42         "responses" : {
  43           "200" : { }
  44         },
  45         "x-camelContextId" : "camel-1",
  46         "x-routeId" : "route13"
  47       }
  48     },
  49     "/v2/loop/deploy/{loopName}" : {
  50       "put" : {
  51         "operationId" : "route8",
  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-1",
  68         "x-routeId" : "route8"
  69       }
  70     },
  71     "/v2/loop/getAllNames" : {
  72       "get" : {
  73         "operationId" : "route2",
  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-1",
  87         "x-routeId" : "route2"
  88       }
  89     },
  90     "/v2/loop/getstatus/{loopName}" : {
  91       "get" : {
  92         "operationId" : "route14",
  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-1",
 109         "x-routeId" : "route14"
 110       }
 111     },
 112     "/v2/loop/restart/{loopName}" : {
 113       "put" : {
 114         "operationId" : "route11",
 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-1",
 131         "x-routeId" : "route11"
 132       }
 133     },
 134     "/v2/loop/stop/{loopName}" : {
 135       "put" : {
 136         "operationId" : "route10",
 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-1",
 153         "x-routeId" : "route10"
 154       }
 155     },
 156     "/v2/loop/submit/{loopName}" : {
 157       "put" : {
 158         "operationId" : "route12",
 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-1",
 175         "x-routeId" : "route12"
 176       }
 177     },
 178     "/v2/loop/svgRepresentation/{loopName}" : {
 179       "get" : {
 180         "operationId" : "route4",
 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-1",
 197         "x-routeId" : "route4"
 198       }
 199     },
 200     "/v2/loop/undeploy/{loopName}" : {
 201       "put" : {
 202         "operationId" : "route9",
 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-1",
 219         "x-routeId" : "route9"
 220       }
 221     },
 222     "/v2/loop/updateGlobalProperties/{loopName}" : {
 223       "post" : {
 224         "operationId" : "route5",
 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-1",
 249         "x-routeId" : "route5"
 250       }
 251     },
 252     "/v2/loop/updateMicroservicePolicy/{loopName}" : {
 253       "post" : {
 254         "operationId" : "route7",
 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-1",
 279         "x-routeId" : "route7"
 280       }
 281     },
 282     "/v2/loop/updateOperationalPolicies/{loopName}" : {
 283       "post" : {
 284         "operationId" : "route6",
 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-1",
 309         "x-routeId" : "route6"
 310       }
 311     },
 312     "/v1/clds/cldsInfo" : {
 313       "get" : {
 314         "operationId" : "route15",
 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-1",
 325         "x-routeId" : "route15"
 326       }
 327     },
 328     "/v1/healthcheck" : {
 329       "get" : {
 330         "operationId" : "route16",
 331         "produces" : [ "application/json" ],
 332         "responses" : {
 333           "200" : {
 334             "description" : "Output type",
 335             "schema" : {
 336               "$ref" : "#/definitions/CldsHealthCheck"
 337             }
 338           }
 339         },
 340         "x-camelContextId" : "camel-1",
 341         "x-routeId" : "route16"
 342       }
 343     },
 344     "/v1/user/getUser" : {
 345       "get" : {
 346         "operationId" : "route17",
 347         "produces" : [ "text/plain" ],
 348         "responses" : {
 349           "200" : { }
 350         },
 351         "x-camelContextId" : "camel-1",
 352         "x-routeId" : "route17"
 353       }
 354     }
 355   },
 356   "definitions" : {
 357     "Loop" : {
 358       "type" : "object",
 359       "properties" : {
 360         "name" : {
 361           "type" : "string"
 362         },
 363         "dcaeDeploymentId" : {
 364           "type" : "string"
 365         },
 366         "dcaeDeploymentStatusUrl" : {
 367           "type" : "string"
 368         },
 369         "dcaeBlueprintId" : {
 370           "type" : "string"
 371         },
 372         "svgRepresentation" : {
 373           "type" : "string"
 374         },
 375         "globalPropertiesJson" : {
 376           "$ref" : "#/definitions/JsonObject"
 377         },
 378         "modelPropertiesJson" : {
 379           "$ref" : "#/definitions/JsonObject"
 380         },
 381         "blueprint" : {
 382           "type" : "string"
 383         },
 384         "lastComputedState" : {
 385           "type" : "string",
 386           "enum" : [ "DESIGN", "SUBMITTED", "DEPLOYED", "RUNNING", "STOPPED", "IN_ERROR", "WAITING" ]
 387         },
 388         "components" : {
 389           "type" : "object",
 390           "additionalProperties" : {
 391             "$ref" : "#/definitions/ExternalComponent"
 392           }
 393         },
 394         "operationalPolicies" : {
 395           "type" : "array",
 396           "uniqueItems" : true,
 397           "items" : {
 398             "$ref" : "#/definitions/OperationalPolicy"
 399           }
 400         },
 401         "microServicePolicies" : {
 402           "type" : "array",
 403           "uniqueItems" : true,
 404           "items" : {
 405             "$ref" : "#/definitions/MicroServicePolicy"
 406           }
 407         },
 408         "loopLogs" : {
 409           "type" : "array",
 410           "uniqueItems" : true,
 411           "items" : {
 412             "$ref" : "#/definitions/LoopLog"
 413           }
 414         }
 415       },
 416       "x-className" : {
 417         "type" : "string",
 418         "format" : "org.onap.clamp.loop.Loop"
 419       }
 420     },
 421     "JsonArray" : {
 422       "type" : "object",
 423       "properties" : {
 424         "asBoolean" : {
 425           "type" : "boolean"
 426         },
 427         "asNumber" : {
 428           "$ref" : "#/definitions/Number"
 429         },
 430         "asString" : {
 431           "type" : "string"
 432         },
 433         "asDouble" : {
 434           "type" : "number",
 435           "format" : "double"
 436         },
 437         "asFloat" : {
 438           "type" : "number",
 439           "format" : "float"
 440         },
 441         "asLong" : {
 442           "type" : "integer",
 443           "format" : "int64"
 444         },
 445         "asInt" : {
 446           "type" : "integer",
 447           "format" : "int32"
 448         },
 449         "asByte" : {
 450           "type" : "string",
 451           "format" : "byte"
 452         },
 453         "asCharacter" : {
 454           "type" : "string"
 455         },
 456         "asBigDecimal" : {
 457           "type" : "number"
 458         },
 459         "asBigInteger" : {
 460           "type" : "integer"
 461         },
 462         "asShort" : {
 463           "type" : "integer",
 464           "format" : "int32"
 465         },
 466         "asJsonPrimitive" : {
 467           "$ref" : "#/definitions/JsonPrimitive"
 468         },
 469         "asJsonNull" : {
 470           "$ref" : "#/definitions/JsonNull"
 471         },
 472         "jsonArray" : {
 473           "type" : "boolean"
 474         },
 475         "jsonObject" : {
 476           "type" : "boolean"
 477         },
 478         "jsonNull" : {
 479           "type" : "boolean"
 480         },
 481         "jsonPrimitive" : {
 482           "type" : "boolean"
 483         },
 484         "asJsonObject" : {
 485           "$ref" : "#/definitions/JsonObject"
 486         },
 487         "asJsonArray" : {
 488           "$ref" : "#/definitions/JsonArray"
 489         }
 490       },
 491       "x-className" : {
 492         "type" : "string",
 493         "format" : "com.google.gson.JsonArray"
 494       }
 495     },
 496     "LoopLog" : {
 497       "type" : "object",
 498       "properties" : {
 499         "id" : {
 500           "type" : "integer",
 501           "format" : "int64"
 502         },
 503         "logType" : {
 504           "type" : "string",
 505           "enum" : [ "INFO", "WARNING", "ERROR" ]
 506         },
 507         "logComponent" : {
 508           "type" : "string"
 509         },
 510         "message" : {
 511           "type" : "string"
 512         },
 513         "loop" : {
 514           "$ref" : "#/definitions/Loop"
 515         },
 516         "logInstant" : {
 517           "type" : "integer",
 518           "format" : "int64"
 519         }
 520       }
 521     },
 522     "Number" : {
 523       "type" : "object"
 524     },
 525     "JsonPrimitive" : {
 526       "type" : "object",
 527       "properties" : {
 528         "boolean" : {
 529           "type" : "boolean"
 530         },
 531         "number" : {
 532           "type" : "boolean"
 533         },
 534         "asBoolean" : {
 535           "type" : "boolean"
 536         },
 537         "asNumber" : {
 538           "$ref" : "#/definitions/Number"
 539         },
 540         "asString" : {
 541           "type" : "string"
 542         },
 543         "asDouble" : {
 544           "type" : "number",
 545           "format" : "double"
 546         },
 547         "asFloat" : {
 548           "type" : "number",
 549           "format" : "float"
 550         },
 551         "asLong" : {
 552           "type" : "integer",
 553           "format" : "int64"
 554         },
 555         "asInt" : {
 556           "type" : "integer",
 557           "format" : "int32"
 558         },
 559         "asByte" : {
 560           "type" : "string",
 561           "format" : "byte"
 562         },
 563         "asCharacter" : {
 564           "type" : "string"
 565         },
 566         "asBigDecimal" : {
 567           "type" : "number"
 568         },
 569         "asBigInteger" : {
 570           "type" : "integer"
 571         },
 572         "asShort" : {
 573           "type" : "integer",
 574           "format" : "int32"
 575         },
 576         "string" : {
 577           "type" : "boolean"
 578         },
 579         "asJsonPrimitive" : {
 580           "$ref" : "#/definitions/JsonPrimitive"
 581         },
 582         "asJsonNull" : {
 583           "$ref" : "#/definitions/JsonNull"
 584         },
 585         "jsonArray" : {
 586           "type" : "boolean"
 587         },
 588         "jsonObject" : {
 589           "type" : "boolean"
 590         },
 591         "jsonNull" : {
 592           "type" : "boolean"
 593         },
 594         "jsonPrimitive" : {
 595           "type" : "boolean"
 596         },
 597         "asJsonObject" : {
 598           "$ref" : "#/definitions/JsonObject"
 599         },
 600         "asJsonArray" : {
 601           "$ref" : "#/definitions/JsonArray"
 602         }
 603       }
 604     },
 605     "MicroServicePolicy" : {
 606       "type" : "object",
 607       "properties" : {
 608         "name" : {
 609           "type" : "string"
 610         },
 611         "modelType" : {
 612           "type" : "string"
 613         },
 614         "properties" : {
 615           "$ref" : "#/definitions/JsonObject"
 616         },
 617         "shared" : {
 618           "type" : "boolean"
 619         },
 620         "policyTosca" : {
 621           "type" : "string"
 622         },
 623         "jsonRepresentation" : {
 624           "$ref" : "#/definitions/JsonObject"
 625         },
 626         "usedByLoops" : {
 627           "type" : "array",
 628           "uniqueItems" : true,
 629           "items" : {
 630             "$ref" : "#/definitions/Loop"
 631           }
 632         }
 633       },
 634       "x-className" : {
 635         "type" : "string",
 636         "format" : "org.onap.clamp.policy.microservice.MicroServicePolicy"
 637       }
 638     },
 639     "JsonObject" : {
 640       "type" : "object",
 641       "properties" : {
 642         "asJsonPrimitive" : {
 643           "$ref" : "#/definitions/JsonPrimitive"
 644         },
 645         "asJsonNull" : {
 646           "$ref" : "#/definitions/JsonNull"
 647         },
 648         "asBoolean" : {
 649           "type" : "boolean"
 650         },
 651         "asNumber" : {
 652           "$ref" : "#/definitions/Number"
 653         },
 654         "asString" : {
 655           "type" : "string"
 656         },
 657         "asDouble" : {
 658           "type" : "number",
 659           "format" : "double"
 660         },
 661         "asFloat" : {
 662           "type" : "number",
 663           "format" : "float"
 664         },
 665         "asLong" : {
 666           "type" : "integer",
 667           "format" : "int64"
 668         },
 669         "asInt" : {
 670           "type" : "integer",
 671           "format" : "int32"
 672         },
 673         "asByte" : {
 674           "type" : "string",
 675           "format" : "byte"
 676         },
 677         "asCharacter" : {
 678           "type" : "string"
 679         },
 680         "asBigDecimal" : {
 681           "type" : "number"
 682         },
 683         "asBigInteger" : {
 684           "type" : "integer"
 685         },
 686         "asShort" : {
 687           "type" : "integer",
 688           "format" : "int32"
 689         },
 690         "jsonArray" : {
 691           "type" : "boolean"
 692         },
 693         "jsonObject" : {
 694           "type" : "boolean"
 695         },
 696         "jsonNull" : {
 697           "type" : "boolean"
 698         },
 699         "jsonPrimitive" : {
 700           "type" : "boolean"
 701         },
 702         "asJsonObject" : {
 703           "$ref" : "#/definitions/JsonObject"
 704         },
 705         "asJsonArray" : {
 706           "$ref" : "#/definitions/JsonArray"
 707         }
 708       },
 709       "x-className" : {
 710         "type" : "string",
 711         "format" : "com.google.gson.JsonObject"
 712       }
 713     },
 714     "ExternalComponent" : {
 715       "type" : "object",
 716       "properties" : {
 717         "state" : {
 718           "$ref" : "#/definitions/ExternalComponentState"
 719         },
 720         "componentName" : {
 721           "type" : "string"
 722         }
 723       }
 724     },
 725     "OperationalPolicy" : {
 726       "type" : "object",
 727       "properties" : {
 728         "name" : {
 729           "type" : "string"
 730         },
 731         "configurationsJson" : {
 732           "$ref" : "#/definitions/JsonObject"
 733         },
 734         "loop" : {
 735           "$ref" : "#/definitions/Loop"
 736         },
 737         "jsonRepresentation" : {
 738           "$ref" : "#/definitions/JsonObject"
 739         }
 740       }
 741     },
 742     "ExternalComponentState" : {
 743       "type" : "object",
 744       "properties" : {
 745         "stateName" : {
 746           "type" : "string"
 747         },
 748         "description" : {
 749           "type" : "string"
 750         },
 751         "level" : {
 752           "type" : "integer",
 753           "format" : "int32"
 754         }
 755       }
 756     },
 757     "JsonNull" : {
 758       "type" : "object",
 759       "properties" : {
 760         "asJsonPrimitive" : {
 761           "$ref" : "#/definitions/JsonPrimitive"
 762         },
 763         "asJsonNull" : {
 764           "$ref" : "#/definitions/JsonNull"
 765         },
 766         "asBoolean" : {
 767           "type" : "boolean"
 768         },
 769         "asNumber" : {
 770           "$ref" : "#/definitions/Number"
 771         },
 772         "asString" : {
 773           "type" : "string"
 774         },
 775         "asDouble" : {
 776           "type" : "number",
 777           "format" : "double"
 778         },
 779         "asFloat" : {
 780           "type" : "number",
 781           "format" : "float"
 782         },
 783         "asLong" : {
 784           "type" : "integer",
 785           "format" : "int64"
 786         },
 787         "asInt" : {
 788           "type" : "integer",
 789           "format" : "int32"
 790         },
 791         "asByte" : {
 792           "type" : "string",
 793           "format" : "byte"
 794         },
 795         "asCharacter" : {
 796           "type" : "string"
 797         },
 798         "asBigDecimal" : {
 799           "type" : "number"
 800         },
 801         "asBigInteger" : {
 802           "type" : "integer"
 803         },
 804         "asShort" : {
 805           "type" : "integer",
 806           "format" : "int32"
 807         },
 808         "jsonArray" : {
 809           "type" : "boolean"
 810         },
 811         "jsonObject" : {
 812           "type" : "boolean"
 813         },
 814         "jsonNull" : {
 815           "type" : "boolean"
 816         },
 817         "jsonPrimitive" : {
 818           "type" : "boolean"
 819         },
 820         "asJsonObject" : {
 821           "$ref" : "#/definitions/JsonObject"
 822         },
 823         "asJsonArray" : {
 824           "$ref" : "#/definitions/JsonArray"
 825         }
 826       }
 827     },
 828     "CldsInfo" : {
 829       "type" : "object",
 830       "properties" : {
 831         "userName" : {
 832           "type" : "string"
 833         },
 834         "cldsVersion" : {
 835           "type" : "string"
 836         },
 837         "permissionReadCl" : {
 838           "type" : "boolean"
 839         },
 840         "permissionUpdateCl" : {
 841           "type" : "boolean"
 842         },
 843         "permissionReadTemplate" : {
 844           "type" : "boolean"
 845         },
 846         "permissionUpdateTemplate" : {
 847           "type" : "boolean"
 848         },
 849         "permissionReadTosca" : {
 850           "type" : "boolean"
 851         },
 852         "permissionUpdateTosca" : {
 853           "type" : "boolean"
 854         }
 855       },
 856       "x-className" : {
 857         "type" : "string",
 858         "format" : "org.onap.clamp.clds.model.CldsInfo"
 859       }
 860     },
 861     "CldsHealthCheck" : {
 862       "type" : "object",
 863       "properties" : {
 864         "healthCheckComponent" : {
 865           "type" : "string"
 866         },
 867         "healthCheckStatus" : {
 868           "type" : "string"
 869         },
 870         "description" : {
 871           "type" : "string"
 872         }
 873       },
 874       "x-className" : {
 875         "type" : "string",
 876         "format" : "org.onap.clamp.clds.model.CldsHealthCheck"
 877       }
 878     }
 879   }
 880 }