docs/clamp/acm/api-protocol/swagger/controlloop-comissioning.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/commission": {
  16       "get": {
  17         "tags": [
  18           "Clamp Control Loop Commissioning API"
  19         ],
  20         "summary": "Query details of the requested commissioned control loop definitions",
  21         "description": "Queries details of the requested commissioned control loop definitions, returning all control loop details",
  22         "operationId": "queryUsingGET",
  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               "type": "array",
  56               "items": {
  57                 "$ref": "#/definitions/ToscaNodeTemplateRes",
  58                 "originalRef": "ToscaNodeTemplateRes"
  59               }
  60             }
  61           },
  62           "401": {
  63             "description": "Authentication Error",
  64             "headers": {
  65               "X-LatestVersion": {
  66                 "type": "string"
  67               },
  68               "X-PatchVersion": {
  69                 "type": "string"
  70               },
  71               "X-MinorVersion": {
  72                 "type": "string"
  73               },
  74               "X-ONAP-RequestID": {
  75                 "type": "string",
  76                 "format": "uuid"
  77               }
  78             }
  79           },
  80           "403": {
  81             "description": "Authorization Error",
  82             "headers": {
  83               "X-LatestVersion": {
  84                 "type": "string"
  85               },
  86               "X-PatchVersion": {
  87                 "type": "string"
  88               },
  89               "X-MinorVersion": {
  90                 "type": "string"
  91               },
  92               "X-ONAP-RequestID": {
  93                 "type": "string",
  94                 "format": "uuid"
  95               }
  96             }
  97           },
  98           "404": {
  99             "description": "Not Found"
 100           },
 101           "500": {
 102             "description": "Internal Server Error",
 103             "headers": {
 104               "X-LatestVersion": {
 105                 "type": "string"
 106               },
 107               "X-PatchVersion": {
 108                 "type": "string"
 109               },
 110               "X-MinorVersion": {
 111                 "type": "string"
 112               },
 113               "X-ONAP-RequestID": {
 114                 "type": "string",
 115                 "format": "uuid"
 116               }
 117             }
 118           }
 119         },
 120         "security": [
 121           {
 122             "basicAuth": []
 123           }
 124         ],
 125         "x-interface info": {
 126           "api-version": "1.0.0",
 127           "last-mod-release": "Dublin"
 128         }
 129       },
 130       "post": {
 131         "tags": [
 132           "Clamp Control Loop Commissioning API"
 133         ],
 134         "summary": "Commissions control loop definitions",
 135         "description": "Commissions control loop definitions, returning the commissioned control loop definition IDs",
 136         "operationId": "createUsingPOST",
 137         "consumes": [
 138           "application/json",
 139           "application/yaml"
 140         ],
 141         "produces": [
 142           "application/json",
 143           "application/yaml"
 144         ],
 145         "parameters": [
 146           {
 147             "in": "body",
 148             "name": "body",
 149             "description": "Entity Body of Control Loop",
 150             "required": true,
 151             "schema": {
 152               "$ref": "#/definitions/ToscaServiceTemplateReq",
 153               "originalRef": "ToscaServiceTemplateReq"
 154             }
 155           },
 156           {
 157             "name": "X-ONAP-RequestID",
 158             "in": "header",
 159             "description": "RequestID for http transaction",
 160             "required": false,
 161             "type": "string",
 162             "format": "uuid"
 163           }
 164         ],
 165         "responses": {
 166           "200": {
 167             "description": "OK",
 168             "schema": {
 169               "$ref": "#/definitions/CommissioningResponse",
 170               "originalRef": "CommissioningResponse"
 171             }
 172           },
 173           "201": {
 174             "description": "Created"
 175           },
 176           "401": {
 177             "description": "Authentication Error",
 178             "headers": {
 179               "X-LatestVersion": {
 180                 "type": "string"
 181               },
 182               "X-PatchVersion": {
 183                 "type": "string"
 184               },
 185               "X-MinorVersion": {
 186                 "type": "string"
 187               },
 188               "X-ONAP-RequestID": {
 189                 "type": "string",
 190                 "format": "uuid"
 191               }
 192             }
 193           },
 194           "403": {
 195             "description": "Authorization Error",
 196             "headers": {
 197               "X-LatestVersion": {
 198                 "type": "string"
 199               },
 200               "X-PatchVersion": {
 201                 "type": "string"
 202               },
 203               "X-MinorVersion": {
 204                 "type": "string"
 205               },
 206               "X-ONAP-RequestID": {
 207                 "type": "string",
 208                 "format": "uuid"
 209               }
 210             }
 211           },
 212           "404": {
 213             "description": "Not Found"
 214           },
 215           "500": {
 216             "description": "Internal Server Error",
 217             "headers": {
 218               "X-LatestVersion": {
 219                 "type": "string"
 220               },
 221               "X-PatchVersion": {
 222                 "type": "string"
 223               },
 224               "X-MinorVersion": {
 225                 "type": "string"
 226               },
 227               "X-ONAP-RequestID": {
 228                 "type": "string",
 229                 "format": "uuid"
 230               }
 231             }
 232           }
 233         },
 234         "security": [
 235           {
 236             "basicAuth": []
 237           }
 238         ],
 239         "x-interface info": {
 240           "api-version": "1.0.0",
 241           "last-mod-release": "Dublin"
 242         }
 243       },
 244       "delete": {
 245         "tags": [
 246           "Clamp Control Loop Commissioning API"
 247         ],
 248         "summary": "Delete a commissioned control loop",
 249         "description": "Deletes a Commissioned Control Loop, returning optional error details",
 250         "operationId": "deleteUsingDELETE",
 251         "produces": [
 252           "application/json",
 253           "application/yaml"
 254         ],
 255         "parameters": [
 256           {
 257             "name": "name",
 258             "in": "query",
 259             "description": "Control Loop definition name",
 260             "required": true,
 261             "type": "string"
 262           },
 263           {
 264             "name": "version",
 265             "in": "query",
 266             "description": "Control Loop definition version",
 267             "required": true,
 268             "type": "string"
 269           },
 270           {
 271             "name": "X-ONAP-RequestID",
 272             "in": "header",
 273             "description": "RequestID for http transaction",
 274             "required": false,
 275             "type": "string",
 276             "format": "uuid"
 277           }
 278         ],
 279         "responses": {
 280           "200": {
 281             "description": "OK",
 282             "schema": {
 283               "$ref": "#/definitions/CommissioningResponse",
 284               "originalRef": "CommissioningResponse"
 285             }
 286           },
 287           "204": {
 288             "description": "No Content"
 289           },
 290           "401": {
 291             "description": "Authentication Error",
 292             "headers": {
 293               "X-LatestVersion": {
 294                 "type": "string"
 295               },
 296               "X-PatchVersion": {
 297                 "type": "string"
 298               },
 299               "X-MinorVersion": {
 300                 "type": "string"
 301               },
 302               "X-ONAP-RequestID": {
 303                 "type": "string",
 304                 "format": "uuid"
 305               }
 306             }
 307           },
 308           "403": {
 309             "description": "Authorization Error",
 310             "headers": {
 311               "X-LatestVersion": {
 312                 "type": "string"
 313               },
 314               "X-PatchVersion": {
 315                 "type": "string"
 316               },
 317               "X-MinorVersion": {
 318                 "type": "string"
 319               },
 320               "X-ONAP-RequestID": {
 321                 "type": "string",
 322                 "format": "uuid"
 323               }
 324             }
 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     },
 356     "/onap/controlloop/v2/commission/elements": {
 357       "get": {
 358         "tags": [
 359           "Clamp Control Loop Commissioning API"
 360         ],
 361         "summary": "Query details of the requested commissioned control loop element definitions",
 362         "description": "Queries details of the requested commissioned control loop element definitions, returning all control loop elements' details",
 363         "operationId": "queryElementsUsingGET",
 364         "produces": [
 365           "application/json",
 366           "application/yaml"
 367         ],
 368         "parameters": [
 369           {
 370             "name": "name",
 371             "in": "query",
 372             "description": "Control Loop definition name",
 373             "required": false,
 374             "type": "string"
 375           },
 376           {
 377             "name": "version",
 378             "in": "query",
 379             "description": "Control Loop definition version",
 380             "required": false,
 381             "type": "string"
 382           },
 383           {
 384             "name": "X-ONAP-RequestID",
 385             "in": "header",
 386             "description": "RequestID for http transaction",
 387             "required": false,
 388             "type": "string",
 389             "format": "uuid"
 390           }
 391         ],
 392         "responses": {
 393           "200": {
 394             "description": "OK",
 395             "schema": {
 396               "type": "array",
 397               "items": {
 398                 "$ref": "#/definitions/ToscaNodeTemplateRes",
 399                 "originalRef": "ToscaNodeTemplateRes"
 400               }
 401             }
 402           },
 403           "401": {
 404             "description": "Authentication Error",
 405             "headers": {
 406               "X-LatestVersion": {
 407                 "type": "string"
 408               },
 409               "X-PatchVersion": {
 410                 "type": "string"
 411               },
 412               "X-MinorVersion": {
 413                 "type": "string"
 414               },
 415               "X-ONAP-RequestID": {
 416                 "type": "string",
 417                 "format": "uuid"
 418               }
 419             }
 420           },
 421           "403": {
 422             "description": "Authorization Error",
 423             "headers": {
 424               "X-LatestVersion": {
 425                 "type": "string"
 426               },
 427               "X-PatchVersion": {
 428                 "type": "string"
 429               },
 430               "X-MinorVersion": {
 431                 "type": "string"
 432               },
 433               "X-ONAP-RequestID": {
 434                 "type": "string",
 435                 "format": "uuid"
 436               }
 437             }
 438           },
 439           "404": {
 440             "description": "Not Found"
 441           },
 442           "500": {
 443             "description": "Internal Server Error",
 444             "headers": {
 445               "X-LatestVersion": {
 446                 "type": "string"
 447               },
 448               "X-PatchVersion": {
 449                 "type": "string"
 450               },
 451               "X-MinorVersion": {
 452                 "type": "string"
 453               },
 454               "X-ONAP-RequestID": {
 455                 "type": "string",
 456                 "format": "uuid"
 457               }
 458             }
 459           }
 460         },
 461         "security": [
 462           {
 463             "basicAuth": []
 464           }
 465         ],
 466         "x-interface info": {
 467           "api-version": "1.0.0",
 468           "last-mod-release": "Dublin"
 469         }
 470       }
 471     }
 472   }
 473 }