docs/clamp/acm/api-protocol/swagger/participant-sim.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/participantsim/v2/elements": {
  16       "put": {
  17         "tags": [
  18           "Clamp Automation Composition Participant Simulator API"
  19         ],
  20         "summary": "Updates simulated automation composition elements",
  21         "description": "Updates simulated automation composition elements, returning the updated automation composition definition IDs",
  22         "operationId": "updateUsingPUT",
  23         "consumes": [
  24           "application/json"
  25         ],
  26         "produces": [
  27           "application/json",
  28           "application/yaml"
  29         ],
  30         "parameters": [
  31           {
  32             "in": "body",
  33             "name": "body",
  34             "description": "Body of a automation composition element",
  35             "required": true,
  36             "schema": {
  37               "$ref": "#/definitions/AutomationCompositionElementReq",
  38               "originalRef": "AutomationCompositionElementReq"
  39             }
  40           },
  41           {
  42             "name": "X-ONAP-RequestID",
  43             "in": "header",
  44             "description": "RequestID for http transaction",
  45             "required": false,
  46             "type": "string",
  47             "format": "uuid"
  48           }
  49         ],
  50         "responses": {
  51           "200": {
  52             "description": "OK",
  53             "schema": {
  54               "$ref": "#/definitions/TypedSimpleResponse«AutomationCompositionElement»",
  55               "originalRef": "TypedSimpleResponse«AutomationCompositionElement»"
  56             }
  57           },
  58           "201": {
  59             "description": "Created"
  60           },
  61           "401": {
  62             "description": "Authentication Error",
  63             "headers": {
  64               "X-LatestVersion": {
  65                 "type": "string"
  66               },
  67               "X-PatchVersion": {
  68                 "type": "string"
  69               },
  70               "X-MinorVersion": {
  71                 "type": "string"
  72               },
  73               "X-ONAP-RequestID": {
  74                 "type": "string",
  75                 "format": "uuid"
  76               }
  77             }
  78           },
  79           "403": {
  80             "description": "Authorization Error",
  81             "headers": {
  82               "X-LatestVersion": {
  83                 "type": "string"
  84               },
  85               "X-PatchVersion": {
  86                 "type": "string"
  87               },
  88               "X-MinorVersion": {
  89                 "type": "string"
  90               },
  91               "X-ONAP-RequestID": {
  92                 "type": "string",
  93                 "format": "uuid"
  94               }
  95             }
  96           },
  97           "404": {
  98             "description": "Not Found"
  99           },
 100           "500": {
 101             "description": "Internal Server Error",
 102             "headers": {
 103               "X-LatestVersion": {
 104                 "type": "string"
 105               },
 106               "X-PatchVersion": {
 107                 "type": "string"
 108               },
 109               "X-MinorVersion": {
 110                 "type": "string"
 111               },
 112               "X-ONAP-RequestID": {
 113                 "type": "string",
 114                 "format": "uuid"
 115               }
 116             }
 117           }
 118         },
 119         "security": [
 120           {
 121             "basicAuth": []
 122           }
 123         ],
 124         "x-interface info": {
 125           "api-version": "1.0.0",
 126           "last-mod-release": "Dublin"
 127         }
 128       }
 129     },
 130     "/onap/participantsim/v2/elements/{name}/{version}": {
 131       "get": {
 132         "tags": [
 133           "Clamp Automation Composition Participant Simulator API"
 134         ],
 135         "summary": "Query details of the requested simulated automation composition elements",
 136         "description": "Queries details of the requested simulated automation composition elements, returning all automation composition element details",
 137         "operationId": "elementsUsingGET",
 138         "produces": [
 139           "application/json",
 140           "application/yaml"
 141         ],
 142         "parameters": [
 143           {
 144             "name": "name",
 145             "in": "path",
 146             "description": "Automation composition element name",
 147             "required": true,
 148             "type": "string"
 149           },
 150           {
 151             "name": "version",
 152             "in": "path",
 153             "description": "Automation composition element version",
 154             "required": true,
 155             "type": "string"
 156           },
 157           {
 158             "name": "X-ONAP-RequestID",
 159             "in": "header",
 160             "description": "RequestID for http transaction",
 161             "required": false,
 162             "type": "string",
 163             "format": "uuid"
 164           }
 165         ],
 166         "responses": {
 167           "200": {
 168             "description": "OK",
 169             "schema": {
 170               "type": "object",
 171               "additionalProperties": {
 172                 "$ref": "#/definitions/AutomationCompositionElementRes",
 173                 "originalRef": "AutomationCompositionElementRes"
 174               }
 175             }
 176           },
 177           "401": {
 178             "description": "Authentication Error",
 179             "headers": {
 180               "X-LatestVersion": {
 181                 "type": "string"
 182               },
 183               "X-PatchVersion": {
 184                 "type": "string"
 185               },
 186               "X-MinorVersion": {
 187                 "type": "string"
 188               },
 189               "X-ONAP-RequestID": {
 190                 "type": "string",
 191                 "format": "uuid"
 192               }
 193             }
 194           },
 195           "403": {
 196             "description": "Authorization Error",
 197             "headers": {
 198               "X-LatestVersion": {
 199                 "type": "string"
 200               },
 201               "X-PatchVersion": {
 202                 "type": "string"
 203               },
 204               "X-MinorVersion": {
 205                 "type": "string"
 206               },
 207               "X-ONAP-RequestID": {
 208                 "type": "string",
 209                 "format": "uuid"
 210               }
 211             }
 212           },
 213           "404": {
 214             "description": "Not Found"
 215           },
 216           "500": {
 217             "description": "Internal Server Error",
 218             "headers": {
 219               "X-LatestVersion": {
 220                 "type": "string"
 221               },
 222               "X-PatchVersion": {
 223                 "type": "string"
 224               },
 225               "X-MinorVersion": {
 226                 "type": "string"
 227               },
 228               "X-ONAP-RequestID": {
 229                 "type": "string",
 230                 "format": "uuid"
 231               }
 232             }
 233           }
 234         },
 235         "security": [
 236           {
 237             "basicAuth": []
 238           }
 239         ],
 240         "x-interface info": {
 241           "api-version": "1.0.0",
 242           "last-mod-release": "Dublin"
 243         }
 244       }
 245     },
 246     "/onap/participantsim/v2/participants": {
 247       "put": {
 248         "tags": [
 249           "Clamp Automation Composition Participant Simulator API"
 250         ],
 251         "summary": "Updates simulated participants",
 252         "description": "Updates simulated participants, returning the updated automation composition definition IDs",
 253         "operationId": "updateUsingPUT_1",
 254         "consumes": [
 255           "application/json"
 256         ],
 257         "produces": [
 258           "application/json",
 259           "application/yaml"
 260         ],
 261         "parameters": [
 262           {
 263             "in": "body",
 264             "name": "body",
 265             "description": "Body of a participant",
 266             "required": true,
 267             "schema": {
 268               "$ref": "#/definitions/ParticipantReq",
 269               "originalRef": "ParticipantReq"
 270             }
 271           },
 272           {
 273             "name": "X-ONAP-RequestID",
 274             "in": "header",
 275             "description": "RequestID for http transaction",
 276             "required": false,
 277             "type": "string",
 278             "format": "uuid"
 279           }
 280         ],
 281         "responses": {
 282           "200": {
 283             "description": "OK",
 284             "schema": {
 285               "$ref": "#/definitions/TypedSimpleResponse«Participant»",
 286               "originalRef": "TypedSimpleResponse«Participant»"
 287             }
 288           },
 289           "201": {
 290             "description": "Created"
 291           },
 292           "401": {
 293             "description": "Authentication Error",
 294             "headers": {
 295               "X-LatestVersion": {
 296                 "type": "string"
 297               },
 298               "X-PatchVersion": {
 299                 "type": "string"
 300               },
 301               "X-MinorVersion": {
 302                 "type": "string"
 303               },
 304               "X-ONAP-RequestID": {
 305                 "type": "string",
 306                 "format": "uuid"
 307               }
 308             }
 309           },
 310           "403": {
 311             "description": "Authorization Error",
 312             "headers": {
 313               "X-LatestVersion": {
 314                 "type": "string"
 315               },
 316               "X-PatchVersion": {
 317                 "type": "string"
 318               },
 319               "X-MinorVersion": {
 320                 "type": "string"
 321               },
 322               "X-ONAP-RequestID": {
 323                 "type": "string",
 324                 "format": "uuid"
 325               }
 326             }
 327           },
 328           "404": {
 329             "description": "Not Found"
 330           },
 331           "500": {
 332             "description": "Internal Server Error",
 333             "headers": {
 334               "X-LatestVersion": {
 335                 "type": "string"
 336               },
 337               "X-PatchVersion": {
 338                 "type": "string"
 339               },
 340               "X-MinorVersion": {
 341                 "type": "string"
 342               },
 343               "X-ONAP-RequestID": {
 344                 "type": "string",
 345                 "format": "uuid"
 346               }
 347             }
 348           }
 349         },
 350         "security": [
 351           {
 352             "basicAuth": []
 353           }
 354         ],
 355         "x-interface info": {
 356           "api-version": "1.0.0",
 357           "last-mod-release": "Dublin"
 358         }
 359       }
 360     },
 361     "/onap/participantsim/v2/participants/{name}/{version}": {
 362       "get": {
 363         "tags": [
 364           "Clamp Automation Composition Participant Simulator API"
 365         ],
 366         "summary": "Query details of the requested simulated participants",
 367         "description": "Queries details of the requested simulated participants, returning all participant details",
 368         "operationId": "participantsUsingGET",
 369         "produces": [
 370           "application/json",
 371           "application/yaml"
 372         ],
 373         "parameters": [
 374           {
 375             "name": "name",
 376             "in": "path",
 377             "description": "Participant name",
 378             "required": true,
 379             "type": "string"
 380           },
 381           {
 382             "name": "version",
 383             "in": "path",
 384             "description": "Participant version",
 385             "required": true,
 386             "type": "string"
 387           },
 388           {
 389             "name": "X-ONAP-RequestID",
 390             "in": "header",
 391             "description": "RequestID for http transaction",
 392             "required": false,
 393             "type": "string",
 394             "format": "uuid"
 395           }
 396         ],
 397         "responses": {
 398           "200": {
 399             "description": "OK",
 400             "schema": {
 401               "type": "array",
 402               "items": {
 403                 "$ref": "#/definitions/ParticipantRes",
 404                 "originalRef": "ParticipantRes"
 405               }
 406             }
 407           },
 408           "401": {
 409             "description": "Authentication Error",
 410             "headers": {
 411               "X-LatestVersion": {
 412                 "type": "string"
 413               },
 414               "X-PatchVersion": {
 415                 "type": "string"
 416               },
 417               "X-MinorVersion": {
 418                 "type": "string"
 419               },
 420               "X-ONAP-RequestID": {
 421                 "type": "string",
 422                 "format": "uuid"
 423               }
 424             }
 425           },
 426           "403": {
 427             "description": "Authorization Error",
 428             "headers": {
 429               "X-LatestVersion": {
 430                 "type": "string"
 431               },
 432               "X-PatchVersion": {
 433                 "type": "string"
 434               },
 435               "X-MinorVersion": {
 436                 "type": "string"
 437               },
 438               "X-ONAP-RequestID": {
 439                 "type": "string",
 440                 "format": "uuid"
 441               }
 442             }
 443           },
 444           "404": {
 445             "description": "Not Found"
 446           },
 447           "500": {
 448             "description": "Internal Server Error",
 449             "headers": {
 450               "X-LatestVersion": {
 451                 "type": "string"
 452               },
 453               "X-PatchVersion": {
 454                 "type": "string"
 455               },
 456               "X-MinorVersion": {
 457                 "type": "string"
 458               },
 459               "X-ONAP-RequestID": {
 460                 "type": "string",
 461                 "format": "uuid"
 462               }
 463             }
 464           }
 465         },
 466         "security": [
 467           {
 468             "basicAuth": []
 469           }
 470         ],
 471         "x-interface info": {
 472           "api-version": "1.0.0",
 473           "last-mod-release": "Dublin"
 474         }
 475       }
 476     }
 477   }
 478 }