docs/clamp/controlloop/api-protocol/swagger/controlloop-instantiation.json

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "description": "Api Documentation",
   5     "version": "1.0",
   6     "title": "Api Documentation",
   7     "termsOfService": "urn:tos",
   8     "contact": {},
   9     "license": {
  10       "name": "Apache 2.0",
  11       "url": "http://www.apache.org/licenses/LICENSE-2.0"
  12     }
  13   },
  14   "paths": {
  15     "/onap/controlloop/v2/instantiation": {
  16       "get": {
  17         "tags": [
  18           "Clamp Control Loop Instantiation API"
  19         ],
  20         "summary": "Query details of the requested control loops",
  21         "description": "Queries details of the requested control loops, returning all control loop details",
  22         "operationId": "queryUsingGET_1",
  23         "produces": [
  24           "application/json",
  25           "application/yaml"
  26         ],
  27         "parameters": [
  28           {
  29             "name": "name",
  30             "in": "query",
  31             "description": "Control Loop definition name",
  32             "required": false,
  33             "type": "string"
  34           },
  35           {
  36             "name": "version",
  37             "in": "query",
  38             "description": "Control Loop definition version",
  39             "required": false,
  40             "type": "string"
  41           },
  42           {
  43             "name": "X-ONAP-RequestID",
  44             "in": "header",
  45             "description": "RequestID for http transaction",
  46             "required": false,
  47             "type": "string",
  48             "format": "uuid"
  49           }
  50         ],
  51         "responses": {
  52           "200": {
  53             "description": "OK",
  54             "schema": {
  55               "$ref": "#/definitions/ControlLoopsRes",
  56               "originalRef": "ControlLoopsRes"
  57             }
  58           },
  59           "401": {
  60             "description": "Authentication Error",
  61             "headers": {
  62               "X-LatestVersion": {
  63                 "type": "string"
  64               },
  65               "X-PatchVersion": {
  66                 "type": "string"
  67               },
  68               "X-MinorVersion": {
  69                 "type": "string"
  70               },
  71               "X-ONAP-RequestID": {
  72                 "type": "string",
  73                 "format": "uuid"
  74               }
  75             }
  76           },
  77           "403": {
  78             "description": "Authorization Error",
  79             "headers": {
  80               "X-LatestVersion": {
  81                 "type": "string"
  82               },
  83               "X-PatchVersion": {
  84                 "type": "string"
  85               },
  86               "X-MinorVersion": {
  87                 "type": "string"
  88               },
  89               "X-ONAP-RequestID": {
  90                 "type": "string",
  91                 "format": "uuid"
  92               }
  93             }
  94           },
  95           "404": {
  96             "description": "Not Found"
  97           },
  98           "500": {
  99             "description": "Internal Server Error",
 100             "headers": {
 101               "X-LatestVersion": {
 102                 "type": "string"
 103               },
 104               "X-PatchVersion": {
 105                 "type": "string"
 106               },
 107               "X-MinorVersion": {
 108                 "type": "string"
 109               },
 110               "X-ONAP-RequestID": {
 111                 "type": "string",
 112                 "format": "uuid"
 113               }
 114             }
 115           }
 116         },
 117         "security": [
 118           {
 119             "basicAuth": []
 120           }
 121         ],
 122         "x-interface info": {
 123           "api-version": "1.0.0",
 124           "last-mod-release": "Dublin"
 125         }
 126       },
 127       "post": {
 128         "tags": [
 129           "Clamp Control Loop Instantiation API"
 130         ],
 131         "summary": "Commissions control loop definitions",
 132         "description": "Commissions control loop definitions, returning the control loop IDs",
 133         "operationId": "createUsingPOST_1",
 134         "consumes": [
 135           "application/json",
 136           "application/yaml"
 137         ],
 138         "produces": [
 139           "application/json",
 140           "application/yaml"
 141         ],
 142         "parameters": [
 143           {
 144             "in": "body",
 145             "name": "controlLoops",
 146             "description": "Entity Body of Control Loop",
 147             "required": true,
 148             "schema": {
 149               "$ref": "#/definitions/ControlLoopsReq",
 150               "originalRef": "ControlLoopsReq"
 151             }
 152           },
 153           {
 154             "name": "X-ONAP-RequestID",
 155             "in": "header",
 156             "description": "RequestID for http transaction",
 157             "required": false,
 158             "type": "string",
 159             "format": "uuid"
 160           }
 161         ],
 162         "responses": {
 163           "200": {
 164             "description": "OK",
 165             "schema": {
 166               "$ref": "#/definitions/InstantiationResponse",
 167               "originalRef": "InstantiationResponse"
 168             }
 169           },
 170           "201": {
 171             "description": "Created"
 172           },
 173           "401": {
 174             "description": "Authentication Error",
 175             "headers": {
 176               "X-LatestVersion": {
 177                 "type": "string"
 178               },
 179               "X-PatchVersion": {
 180                 "type": "string"
 181               },
 182               "X-MinorVersion": {
 183                 "type": "string"
 184               },
 185               "X-ONAP-RequestID": {
 186                 "type": "string",
 187                 "format": "uuid"
 188               }
 189             }
 190           },
 191           "403": {
 192             "description": "Authorization Error",
 193             "headers": {
 194               "X-LatestVersion": {
 195                 "type": "string"
 196               },
 197               "X-PatchVersion": {
 198                 "type": "string"
 199               },
 200               "X-MinorVersion": {
 201                 "type": "string"
 202               },
 203               "X-ONAP-RequestID": {
 204                 "type": "string",
 205                 "format": "uuid"
 206               }
 207             }
 208           },
 209           "404": {
 210             "description": "Not Found"
 211           },
 212           "500": {
 213             "description": "Internal Server Error",
 214             "headers": {
 215               "X-LatestVersion": {
 216                 "type": "string"
 217               },
 218               "X-PatchVersion": {
 219                 "type": "string"
 220               },
 221               "X-MinorVersion": {
 222                 "type": "string"
 223               },
 224               "X-ONAP-RequestID": {
 225                 "type": "string",
 226                 "format": "uuid"
 227               }
 228             }
 229           }
 230         },
 231         "security": [
 232           {
 233             "basicAuth": []
 234           }
 235         ],
 236         "x-interface info": {
 237           "api-version": "1.0.0",
 238           "last-mod-release": "Dublin"
 239         }
 240       },
 241       "put": {
 242         "tags": [
 243           "Clamp Control Loop Instantiation API"
 244         ],
 245         "summary": "Updates control loop definitions",
 246         "description": "Updates control loop definitions, returning the updated control loop definition IDs",
 247         "operationId": "updateUsingPUT",
 248         "consumes": [
 249           "application/json",
 250           "application/yaml"
 251         ],
 252         "produces": [
 253           "application/json",
 254           "application/yaml"
 255         ],
 256         "parameters": [
 257           {
 258             "in": "body",
 259             "name": "controlLoops",
 260             "description": "Entity Body of Control Loop",
 261             "required": true,
 262             "schema": {
 263               "$ref": "#/definitions/ControlLoopsReq",
 264               "originalRef": "ControlLoopsReq"
 265             }
 266           },
 267           {
 268             "name": "X-ONAP-RequestID",
 269             "in": "header",
 270             "description": "RequestID for http transaction",
 271             "required": false,
 272             "type": "string",
 273             "format": "uuid"
 274           }
 275         ],
 276         "responses": {
 277           "200": {
 278             "description": "OK",
 279             "schema": {
 280               "$ref": "#/definitions/InstantiationResponse",
 281               "originalRef": "InstantiationResponse"
 282             }
 283           },
 284           "201": {
 285             "description": "Created"
 286           },
 287           "401": {
 288             "description": "Authentication Error",
 289             "headers": {
 290               "X-LatestVersion": {
 291                 "type": "string"
 292               },
 293               "X-PatchVersion": {
 294                 "type": "string"
 295               },
 296               "X-MinorVersion": {
 297                 "type": "string"
 298               },
 299               "X-ONAP-RequestID": {
 300                 "type": "string",
 301                 "format": "uuid"
 302               }
 303             }
 304           },
 305           "403": {
 306             "description": "Authorization Error",
 307             "headers": {
 308               "X-LatestVersion": {
 309                 "type": "string"
 310               },
 311               "X-PatchVersion": {
 312                 "type": "string"
 313               },
 314               "X-MinorVersion": {
 315                 "type": "string"
 316               },
 317               "X-ONAP-RequestID": {
 318                 "type": "string",
 319                 "format": "uuid"
 320               }
 321             }
 322           },
 323           "404": {
 324             "description": "Not Found"
 325           },
 326           "500": {
 327             "description": "Internal Server Error",
 328             "headers": {
 329               "X-LatestVersion": {
 330                 "type": "string"
 331               },
 332               "X-PatchVersion": {
 333                 "type": "string"
 334               },
 335               "X-MinorVersion": {
 336                 "type": "string"
 337               },
 338               "X-ONAP-RequestID": {
 339                 "type": "string",
 340                 "format": "uuid"
 341               }
 342             }
 343           }
 344         },
 345         "security": [
 346           {
 347             "basicAuth": []
 348           }
 349         ],
 350         "x-interface info": {
 351           "api-version": "1.0.0",
 352           "last-mod-release": "Dublin"
 353         }
 354       },
 355       "delete": {
 356         "tags": [
 357           "Clamp Control Loop Instantiation API"
 358         ],
 359         "summary": "Delete a control loop",
 360         "description": "Deletes a control loop, returning optional error details",
 361         "operationId": "deleteUsingDELETE_1",
 362         "produces": [
 363           "application/json",
 364           "application/yaml"
 365         ],
 366         "parameters": [
 367           {
 368             "name": "name",
 369             "in": "query",
 370             "description": "Control Loop definition name",
 371             "required": true,
 372             "type": "string"
 373           },
 374           {
 375             "name": "version",
 376             "in": "query",
 377             "description": "Control Loop definition version",
 378             "required": false,
 379             "type": "string"
 380           },
 381           {
 382             "name": "X-ONAP-RequestID",
 383             "in": "header",
 384             "description": "RequestID for http transaction",
 385             "required": false,
 386             "type": "string",
 387             "format": "uuid"
 388           }
 389         ],
 390         "responses": {
 391           "200": {
 392             "description": "OK",
 393             "schema": {
 394               "$ref": "#/definitions/InstantiationResponse",
 395               "originalRef": "InstantiationResponse"
 396             }
 397           },
 398           "204": {
 399             "description": "No Content"
 400           },
 401           "401": {
 402             "description": "Authentication Error",
 403             "headers": {
 404               "X-LatestVersion": {
 405                 "type": "string"
 406               },
 407               "X-PatchVersion": {
 408                 "type": "string"
 409               },
 410               "X-MinorVersion": {
 411                 "type": "string"
 412               },
 413               "X-ONAP-RequestID": {
 414                 "type": "string",
 415                 "format": "uuid"
 416               }
 417             }
 418           },
 419           "403": {
 420             "description": "Authorization Error",
 421             "headers": {
 422               "X-LatestVersion": {
 423                 "type": "string"
 424               },
 425               "X-PatchVersion": {
 426                 "type": "string"
 427               },
 428               "X-MinorVersion": {
 429                 "type": "string"
 430               },
 431               "X-ONAP-RequestID": {
 432                 "type": "string",
 433                 "format": "uuid"
 434               }
 435             }
 436           },
 437           "500": {
 438             "description": "Internal Server Error",
 439             "headers": {
 440               "X-LatestVersion": {
 441                 "type": "string"
 442               },
 443               "X-PatchVersion": {
 444                 "type": "string"
 445               },
 446               "X-MinorVersion": {
 447                 "type": "string"
 448               },
 449               "X-ONAP-RequestID": {
 450                 "type": "string",
 451                 "format": "uuid"
 452               }
 453             }
 454           }
 455         },
 456         "security": [
 457           {
 458             "basicAuth": []
 459           }
 460         ],
 461         "x-interface info": {
 462           "api-version": "1.0.0",
 463           "last-mod-release": "Dublin"
 464         }
 465       }
 466     },
 467     "/onap/controlloop/v2/instantiation/command": {
 468       "put": {
 469         "tags": [
 470           "Clamp Control Loop Instantiation API"
 471         ],
 472         "summary": "Issue a command to the requested control loops",
 473         "description": "Issues a command to a control loop, ordering a state change on the control loop",
 474         "operationId": "issueControlLoopCommandUsingPUT",
 475         "consumes": [
 476           "application/json",
 477           "application/yaml"
 478         ],
 479         "produces": [
 480           "application/json",
 481           "application/yaml"
 482         ],
 483         "parameters": [
 484           {
 485             "in": "body",
 486             "name": "command",
 487             "description": "Entity Body of control loop command",
 488             "required": true,
 489             "schema": {
 490               "$ref": "#/definitions/InstantiationCommand",
 491               "originalRef": "InstantiationCommand"
 492             }
 493           },
 494           {
 495             "name": "X-ONAP-RequestID",
 496             "in": "header",
 497             "description": "RequestID for http transaction",
 498             "required": false,
 499             "type": "string",
 500             "format": "uuid"
 501           }
 502         ],
 503         "responses": {
 504           "200": {
 505             "description": "OK",
 506             "schema": {
 507               "$ref": "#/definitions/InstantiationResponse",
 508               "originalRef": "InstantiationResponse"
 509             }
 510           },
 511           "201": {
 512             "description": "Created"
 513           },
 514           "401": {
 515             "description": "Authentication Error",
 516             "headers": {
 517               "X-LatestVersion": {
 518                 "type": "string"
 519               },
 520               "X-PatchVersion": {
 521                 "type": "string"
 522               },
 523               "X-MinorVersion": {
 524                 "type": "string"
 525               },
 526               "X-ONAP-RequestID": {
 527                 "type": "string",
 528                 "format": "uuid"
 529               }
 530             }
 531           },
 532           "403": {
 533             "description": "Authorization Error",
 534             "headers": {
 535               "X-LatestVersion": {
 536                 "type": "string"
 537               },
 538               "X-PatchVersion": {
 539                 "type": "string"
 540               },
 541               "X-MinorVersion": {
 542                 "type": "string"
 543               },
 544               "X-ONAP-RequestID": {
 545                 "type": "string",
 546                 "format": "uuid"
 547               }
 548             }
 549           },
 550           "404": {
 551             "description": "Not Found"
 552           },
 553           "500": {
 554             "description": "Internal Server Error",
 555             "headers": {
 556               "X-LatestVersion": {
 557                 "type": "string"
 558               },
 559               "X-PatchVersion": {
 560                 "type": "string"
 561               },
 562               "X-MinorVersion": {
 563                 "type": "string"
 564               },
 565               "X-ONAP-RequestID": {
 566                 "type": "string",
 567                 "format": "uuid"
 568               }
 569             }
 570           }
 571         },
 572         "security": [
 573           {
 574             "basicAuth": []
 575           }
 576         ],
 577         "x-interface info": {
 578           "api-version": "1.0.0",
 579           "last-mod-release": "Dublin"
 580         }
 581       }
 582     }
 583   }
 584 }