docs/clamp/acm/api-protocol/swagger/acm-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/automationcomposition/v2/commission": {
  16             "get": {
  17                 "tags": [
  18                     "Clamp Automation Composition Commissioning API"
  19                 ],
  20                 "summary": "Query details of the requested commissioned automation composition definitions",
  21                 "description": "Queries details of the requested commissioned automation composition definitions, returning all automation composition details",
  22                 "operationId": "queryUsingGET",
  23                 "produces": [
  24                     "application/json",
  25                     "application/yaml"
  26                 ],
  27                 "parameters": [
  28                     {
  29                         "name": "name",
  30                         "in": "query",
  31                         "description": "Automation composition  definition name",
  32                         "required": false,
  33                         "type": "string"
  34                     },
  35                     {
  36                         "name": "version",
  37                         "in": "query",
  38                         "description": "Automation composition  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": "Istanbul"
 128                 }
 129             },
 130             "post": {
 131                 "tags": [
 132                     "Clamp Automation Composition Commissioning API"
 133                 ],
 134                 "summary": "Commissions automation composition definitions",
 135                 "description": "Commissions automation composition definitions, returning commissioned 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 Automation Composition",
 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": "Istanbul"
 242                 }
 243             },
 244             "delete": {
 245                 "tags": [
 246                     "Clamp Automation Composition Commissioning API"
 247                 ],
 248                 "summary": "Delete a commissioned automation composition",
 249                 "description": "Deletes a Commissioned Automation Composition, 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": "Automation composition  definition name",
 260                         "required": true,
 261                         "type": "string"
 262                     },
 263                     {
 264                         "name": "version",
 265                         "in": "query",
 266                         "description": "Automation composition  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": "Istanbul"
 353                 }
 354             }
 355         },
 356         "/onap/automationcomposition/v2/commission/elements": {
 357             "get": {
 358                 "tags": [
 359                     "Clamp Automation Composition Commissioning API"
 360                 ],
 361                 "summary": "Query details of the requested commissioned automation composition element definitions",
 362                 "description": "Queries details of the requested commissioned automation composition element definitions, returning all automation composition 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": "Automation composition  definition name",
 373                         "required": false,
 374                         "type": "string"
 375                     },
 376                     {
 377                         "name": "version",
 378                         "in": "query",
 379                         "description": "Automation composition  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": "Istanbul"
 469                 }
 470             }
 471         },
 472         "/onap/automationcomposition/v2/commission/getCommonOrInstanceProperties": {
 473             "get": {
 474                 "tags": [
 475                     "Clamp Automation Composition Commissioning API"
 476                 ],
 477                 "summary": "Query details of the requested tosca service template common or instance properties",
 478                 "description": "Queries details of the requested commissioned tosca service template json commonor instance properties, returning all tosca service template common or instance property details",
 479                 "operationId": "queryToscaServiceCommonOrInstancePropertiesUsingGET",
 480                 "produces": [
 481                     "application/json",
 482                     "application/yaml"
 483                 ],
 484                 "parameters": [
 485                     {
 486                         "name": "common",
 487                         "in": "query",
 488                         "description": "Flag, true for common properties, false for instance",
 489                         "required": false,
 490                         "type": "boolean",
 491                         "default": false
 492                     },
 493                     {
 494                         "name": "name",
 495                         "in": "query",
 496                         "description": "Tosca service template name",
 497                         "required": false,
 498                         "type": "string"
 499                     },
 500                     {
 501                         "name": "version",
 502                         "in": "query",
 503                         "description": "Tosca service template version",
 504                         "required": false,
 505                         "type": "string"
 506                     },
 507                     {
 508                         "name": "X-ONAP-RequestID",
 509                         "in": "header",
 510                         "description": "RequestID for http transaction",
 511                         "required": false,
 512                         "type": "string",
 513                         "format": "uuid"
 514                     }
 515                 ],
 516                 "responses": {
 517                     "200": {
 518                         "description": "OK",
 519                         "schema": {
 520                             "type": "object",
 521                             "additionalProperties": {
 522                                 "$ref": "#/definitions/ToscaNodeTemplateRes",
 523                                 "originalRef": "ToscaNodeTemplateRes"
 524                             }
 525                         }
 526                     },
 527                     "401": {
 528                         "description": "Authentication Error",
 529                         "headers": {
 530                             "X-LatestVersion": {
 531                                 "type": "string"
 532                             },
 533                             "X-PatchVersion": {
 534                                 "type": "string"
 535                             },
 536                             "X-MinorVersion": {
 537                                 "type": "string"
 538                             },
 539                             "X-ONAP-RequestID": {
 540                                 "type": "string",
 541                                 "format": "uuid"
 542                             }
 543                         }
 544                     },
 545                     "403": {
 546                         "description": "Authorization Error",
 547                         "headers": {
 548                             "X-LatestVersion": {
 549                                 "type": "string"
 550                             },
 551                             "X-PatchVersion": {
 552                                 "type": "string"
 553                             },
 554                             "X-MinorVersion": {
 555                                 "type": "string"
 556                             },
 557                             "X-ONAP-RequestID": {
 558                                 "type": "string",
 559                                 "format": "uuid"
 560                             }
 561                         }
 562                     },
 563                     "404": {
 564                         "description": "Not Found"
 565                     },
 566                     "500": {
 567                         "description": "Internal Server Error",
 568                         "headers": {
 569                             "X-LatestVersion": {
 570                                 "type": "string"
 571                             },
 572                             "X-PatchVersion": {
 573                                 "type": "string"
 574                             },
 575                             "X-MinorVersion": {
 576                                 "type": "string"
 577                             },
 578                             "X-ONAP-RequestID": {
 579                                 "type": "string",
 580                                 "format": "uuid"
 581                             }
 582                         }
 583                     }
 584                 },
 585                 "security": [
 586                     {
 587                         "basicAuth": []
 588                     }
 589                 ],
 590                 "x-interface info": {
 591                     "api-version": "1.0.0",
 592                     "last-mod-release": "Istanbul"
 593                 }
 594             }
 595         },
 596         "/onap/automationcomposition/v2/commission/toscaServiceTemplateSchema": {
 597             "get": {
 598                 "tags": [
 599                     "Clamp Automation Composition Commissioning API"
 600                 ],
 601                 "summary": "Query details of the requested tosca service template json schema",
 602                 "description": "Queries details of the requested commissioned tosca service template json schema, returning all tosca service template json schema details",
 603                 "operationId": "queryToscaServiceTemplateJsonSchemaUsingGET",
 604                 "produces": [
 605                     "application/json",
 606                     "application/yaml"
 607                 ],
 608                 "parameters": [
 609                     {
 610                         "name": "section",
 611                         "in": "query",
 612                         "description": "Section of Template schema is desired for",
 613                         "required": false,
 614                         "type": "string",
 615                         "default": "all"
 616                     },
 617                     {
 618                         "name": "X-ONAP-RequestID",
 619                         "in": "header",
 620                         "description": "RequestID for http transaction",
 621                         "required": false,
 622                         "type": "string",
 623                         "format": "uuid"
 624                     }
 625                 ],
 626                 "responses": {
 627                     "200": {
 628                         "description": "OK",
 629                         "schema": {
 630                             "type": "string"
 631                         }
 632                     },
 633                     "401": {
 634                         "description": "Authentication Error",
 635                         "headers": {
 636                             "X-LatestVersion": {
 637                                 "type": "string"
 638                             },
 639                             "X-PatchVersion": {
 640                                 "type": "string"
 641                             },
 642                             "X-MinorVersion": {
 643                                 "type": "string"
 644                             },
 645                             "X-ONAP-RequestID": {
 646                                 "type": "string",
 647                                 "format": "uuid"
 648                             }
 649                         }
 650                     },
 651                     "403": {
 652                         "description": "Authorization Error",
 653                         "headers": {
 654                             "X-LatestVersion": {
 655                                 "type": "string"
 656                             },
 657                             "X-PatchVersion": {
 658                                 "type": "string"
 659                             },
 660                             "X-MinorVersion": {
 661                                 "type": "string"
 662                             },
 663                             "X-ONAP-RequestID": {
 664                                 "type": "string",
 665                                 "format": "uuid"
 666                             }
 667                         }
 668                     },
 669                     "404": {
 670                         "description": "Not Found"
 671                     },
 672                     "500": {
 673                         "description": "Internal Server Error",
 674                         "headers": {
 675                             "X-LatestVersion": {
 676                                 "type": "string"
 677                             },
 678                             "X-PatchVersion": {
 679                                 "type": "string"
 680                             },
 681                             "X-MinorVersion": {
 682                                 "type": "string"
 683                             },
 684                             "X-ONAP-RequestID": {
 685                                 "type": "string",
 686                                 "format": "uuid"
 687                             }
 688                         }
 689                     }
 690                 },
 691                 "security": [
 692                     {
 693                         "basicAuth": []
 694                     }
 695                 ],
 696                 "x-interface info": {
 697                     "api-version": "1.0.0",
 698                     "last-mod-release": "Istanbul"
 699                 }
 700             }
 701         },
 702         "/onap/automationcomposition/v2/commission/toscaservicetemplate": {
 703             "get": {
 704                 "tags": [
 705                     "Clamp Automation Composition Commissioning API"
 706                 ],
 707                 "summary": "Query details of the requested tosca service templates",
 708                 "description": "Queries details of the requested commissioned tosca service template, returning all tosca service template details",
 709                 "operationId": "queryToscaServiceTemplateUsingGET",
 710                 "produces": [
 711                     "application/json",
 712                     "application/yaml"
 713                 ],
 714                 "parameters": [
 715                     {
 716                         "name": "name",
 717                         "in": "query",
 718                         "description": "Tosca service template name",
 719                         "required": false,
 720                         "type": "string"
 721                     },
 722                     {
 723                         "name": "version",
 724                         "in": "query",
 725                         "description": "Tosca service template version",
 726                         "required": false,
 727                         "type": "string"
 728                     },
 729                     {
 730                         "name": "X-ONAP-RequestID",
 731                         "in": "header",
 732                         "description": "RequestID for http transaction",
 733                         "required": false,
 734                         "type": "string",
 735                         "format": "uuid"
 736                     }
 737                 ],
 738                 "responses": {
 739                     "200": {
 740                         "description": "OK",
 741                         "schema": {
 742                             "type": "string"
 743                         }
 744                     },
 745                     "401": {
 746                         "description": "Authentication Error",
 747                         "headers": {
 748                             "X-LatestVersion": {
 749                                 "type": "string"
 750                             },
 751                             "X-PatchVersion": {
 752                                 "type": "string"
 753                             },
 754                             "X-MinorVersion": {
 755                                 "type": "string"
 756                             },
 757                             "X-ONAP-RequestID": {
 758                                 "type": "string",
 759                                 "format": "uuid"
 760                             }
 761                         }
 762                     },
 763                     "403": {
 764                         "description": "Authorization Error",
 765                         "headers": {
 766                             "X-LatestVersion": {
 767                                 "type": "string"
 768                             },
 769                             "X-PatchVersion": {
 770                                 "type": "string"
 771                             },
 772                             "X-MinorVersion": {
 773                                 "type": "string"
 774                             },
 775                             "X-ONAP-RequestID": {
 776                                 "type": "string",
 777                                 "format": "uuid"
 778                             }
 779                         }
 780                     },
 781                     "404": {
 782                         "description": "Not Found"
 783                     },
 784                     "500": {
 785                         "description": "Internal Server Error",
 786                         "headers": {
 787                             "X-LatestVersion": {
 788                                 "type": "string"
 789                             },
 790                             "X-PatchVersion": {
 791                                 "type": "string"
 792                             },
 793                             "X-MinorVersion": {
 794                                 "type": "string"
 795                             },
 796                             "X-ONAP-RequestID": {
 797                                 "type": "string",
 798                                 "format": "uuid"
 799                             }
 800                         }
 801                     }
 802                 },
 803                 "security": [
 804                     {
 805                         "basicAuth": []
 806                     }
 807                 ],
 808                 "x-interface info": {
 809                     "api-version": "1.0.0",
 810                     "last-mod-release": "Istanbul"
 811                 }
 812             }
 813         }
 814     }
 815 }