multivimbroker/multivimbroker/swagger/multivim.image.swagger.json

   1 {
   2     "swagger": "2.0",
   3     "info": {
   4         "version": "1.0.0",
   5         "title": "MultiVIM Service rest API"
   6     },
   7     "basePath": "/openoapi/multivim/v1/",
   8     "tags": [
   9         {
  10             "name": "MultiVIM services"
  11         }
  12     ],
  13     "paths": {
  14         "/{vimid}/{tenantid}/images": {
  15             "post": {
  16                 "tags": [
  17                     "vim images"
  18                 ],
  19                 "summary": "create a image",
  20                 "description": "create a image",
  21                 "operationId": "create_vim_image",
  22                 "consumes": [
  23                     "application/json"
  24                 ],
  25                 "produces": [
  26                     "application/json"
  27                 ],
  28                 "parameters": [
  29                     {
  30                         "name": "vimid",
  31                         "in": "path",
  32                         "description": "vim instance id",
  33                         "required": true,
  34                         "type": "string"
  35                     },
  36                     {
  37                         "name": "tenantid",
  38                         "in": "path",
  39                         "description": "tenant UUID",
  40                         "required": true,
  41                         "type": "string"
  42                     },
  43                     {
  44                         "in": "body",
  45                         "name": "body",
  46                         "description": "create vim image request param",
  47                         "required": true,
  48                         "schema": {
  49                             "$ref": "#/definitions/CreateVimImage"
  50                         }
  51                     }
  52                 ],
  53                 "responses": {
  54                     "200": {
  55                         "description": "successful operation",
  56                         "schema": {
  57                             "$ref": "#/definitions/VimImageInfo"
  58                         }
  59                     },
  60                     "404": {
  61                         "description": "the vim id or tenant UUID is wrong"
  62                     },
  63                     "500": {
  64                         "description": "the vim image is not accessable"
  65                     }
  66                 }
  67             },
  68             "get": {
  69                 "tags": [
  70                     "vim images"
  71                 ],
  72                 "summary": "query vim images list",
  73                 "description": "query vim images list",
  74                 "operationId": "query_vim_images",
  75                 "consumes": [
  76                     "application/json"
  77                 ],
  78                 "produces": [
  79                     "application/json"
  80                 ],
  81                 "parameters": [
  82                     {
  83                         "name": "vimid",
  84                         "in": "path",
  85                         "description": "vim instance id",
  86                         "required": true,
  87                         "type": "string"
  88                     },
  89                     {
  90                         "name": "tenantid",
  91                         "in": "path",
  92                         "description": "tenant UUID",
  93                         "required": true,
  94                         "type": "string"
  95                     },
  96                     {
  97                         "in": "body",
  98                         "name": "body",
  99                         "description": "get a list of vim images request param",
 100                         "required": false,
 101                         "schema": {
 102                             "$ref": "#/definitions/ListVimImages"
 103                         }
 104                     }
 105                 ],
 106                 "responses": {
 107                     "200": {
 108                         "description": "successful operation",
 109                         "schema": {
 110                             "$ref": "#/definitions/VimImagesInfo"
 111                         }
 112                     },
 113                     "404": {
 114                         "description": "the vim id or tenant UUID is wrong"
 115                     },
 116                     "500": {
 117                         "description": "the vim image is not accessable"
 118                     }
 119                 }
 120             }
 121         },
 122         "/{vimid}/{tenantid}/images/{imageid}": {
 123             "delete": {
 124                 "tags": [
 125                     "vim images"
 126                  ],
 127                  "summary": "delete specific vim image",
 128                 "description": "delete specific vim image",
 129                 "operationId": "delete_vim_image",
 130                 "consumes": [
 131                     "application/json"
 132                 ],
 133                 "produces": [
 134                     "application/json"
 135                 ],
 136                 "parameters": [
 137                     {
 138                         "name": "vimid",
 139                         "in": "path",
 140                         "description": "vim instance id",
 141                         "required": true,
 142                         "type": "string"
 143                     },
 144                     {
 145                         "name": "tenantid",
 146                         "in": "path",
 147                         "description": "tenant UUID",
 148                         "required": true,
 149                         "type": "string"
 150                     },
 151                     {
 152                         "name": "imageid",
 153                         "in": "path",
 154                         "description": "vim image id",
 155                         "required": true,
 156                         "type": "string"
 157                     }
 158                 ],
 159                 "responses": {
 160                     "204": {
 161                         "description": "successful operation"
 162                     },
 163                     "404": {
 164                         "description": "the vim id or tenant UUID is wrong"
 165                     },
 166                     "500": {
 167                         "description": "the vim image is not accessable"
 168                     }
 169                 }
 170             },
 171             "get": {
 172                 "tags": [
 173                     "vim images"
 174                 ],
 175                 "summary": "query specific vim image",
 176                 "description": "query specific vim image",
 177                 "operationId": "query_vim_image",
 178                 "consumes": [
 179                     "application/json"
 180                 ],
 181                 "produces": [
 182                     "application/json"
 183                 ],
 184                 "parameters": [
 185                     {
 186                         "name": "vimid",
 187                         "in": "path",
 188                         "description": "vim instance id",
 189                         "required": true,
 190                         "type": "string"
 191                     },
 192                     {
 193                         "name": "tenantid",
 194                         "in": "path",
 195                         "description": "tenant UUID",
 196                         "required": true,
 197                         "type": "string"
 198                     },
 199                     {
 200                         "name": "imageid",
 201                         "in": "path",
 202                         "description": "vim image id",
 203                         "required": true,
 204                         "type": "string"
 205                     }
 206                 ],
 207                 "responses": {
 208                     "200": {
 209                         "description": "successful operation",
 210                         "schema": {
 211                             "$ref": "#/definitions/VimImageInfo"
 212                         }
 213                     },
 214                     "404": {
 215                         "description": "the vim id or tenant UUID is wrong"
 216                     },
 217                     "500": {
 218                         "description": "the vim image is not accessable"
 219                     }
 220                 }
 221             }
 222         }
 223     },
 224     "definitions": {
 225         "CreateVimImage": {
 226             "type": "object",
 227             "required": [
 228                 "imagePath",
 229                 "name",
 230                 "imageType",
 231                 "containerFormat"
 232             ],
 233             "properties": {
 234                 "name": {
 235                     "type": "string",
 236                     "description": "image name"
 237                 },
 238                 "imageType": {
 239                     "type": "string",
 240                     "description": "image type: ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso"
 241                 },
 242                 "imagePath": {
 243                     "type": "string",
 244                     "description": "image url to catalog"
 245                 },
 246                 "containerFormat": {
 247                     "type": "string",
 248                     "description": "image container format: ami, ari, aki, bare, ovf, ova,  docker"
 249                 },
 250                 "visibility": {
 251                     "type": "string",
 252                     "description": "public, private, shared, or community"
 253                 },
 254                 "properties": {
 255                     "type": "array",
 256                     "description": "list of properties",
 257                     "items": {
 258                        "$ref": "#/definitions/VimImagePropertyInfo"
 259                     }
 260                 }
 261             }
 262         },
 263         "VimImagePropertyInfo": {
 264             "type": "object",
 265             "properties": {
 266                 "keyName": {
 267                     "type": "string",
 268                     "description": "property name"
 269                 },
 270                 "value": {
 271                     "type": "string",
 272                     "description": "property value"
 273                 }
 274             }
 275         },
 276         "ListVimImages": {
 277             "type": "object",
 278             "properties": {
 279                 "name": {
 280                     "type": "string",
 281                     "description": "image name to filter image list"
 282                 },
 283                 "limit": {
 284                     "type": "string",
 285                     "description": "Requests a page size of items"
 286                 },
 287                 "marker": {
 288                     "type": "string",
 289                     "description": "image ID of the last-seen item"
 290                 }
 291             }
 292         },
 293         "VimImagesInfo": {
 294             "type": "object",
 295             "required": [
 296                 "vimId",
 297                 "tenantId",
 298                 "images"
 299             ],
 300             "properties": {
 301                 "vimId": {
 302                     "type": "string"
 303                 },
 304                 "vimName": {
 305                     "type": "string"
 306                 },
 307                 "tenantId": {
 308                     "type": "string",
 309                     "description": "tenant UUID"
 310                 },
 311                 "images": {
 312                     "type": "array",
 313                     "description": "image list information",
 314                     "items": {
 315                        "$ref": "#/definitions/VimImageInfo"
 316                     }
 317                 }
 318             }
 319         },
 320         "VimImageInfo": {
 321             "type": "object",
 322             "required": [
 323                 "name",
 324                 "status",
 325                 "id"
 326             ],
 327             "properties": {
 328                 "name": {
 329                     "type": "string",
 330                     "description": "image name"
 331                 },
 332                 "id": {
 333                     "type": "string",
 334                     "description": "image UUID"
 335                 },
 336                 "imageType": {
 337                     "type": "string",
 338                     "description": "image type: ami, ari, aki, vhd, vhdx, vmdk, raw, qcow2, vdi, iso"
 339                 },
 340                 "imagePath": {
 341                     "type": "string",
 342                     "description": "image url to catalog"
 343                 },
 344                 "containerFormat": {
 345                     "type": "string",
 346                     "description": "image container format: ami, ari, aki, bare, ovf, ova,  docker"
 347                 },
 348                 "visibility": {
 349                     "type": "string",
 350                     "description": "public, private, shared, or community"
 351                 },
 352                 "properties": {
 353                     "type": "array",
 354                     "description": "list of properties",
 355                     "items": {
 356                        "$ref": "#/definitions/VimImagePropertyInfo"
 357                     }
 358                 },
 359                 "status": {
 360                     "type": "string",
 361                     "description": "image status"
 362                 },
 363                 "size": {
 364                     "type": "string",
 365                     "description": "image size"
 366                 },
 367                 "vimId": {
 368                     "type": "string"
 369                 },
 370                 "vimName": {
 371                     "type": "string"
 372                 },
 373                 "tenantId": {
 374                     "type": "string",
 375                     "description": "tenant UUID"
 376                 },
 377                 "returnCode": {
 378                     "type": "integer",
 379                     "description": "0: Already exist 1: Newly created"
 380                 }
 381             }
 382         }
 383     }
 384 }