lcm/swagger/vfc.vllcm.swagger.json

   1 {
   2     "swagger": "2.0",
   3     "info": {
   4         "version": "1.0.0",
   5         "title": "ONAP VFC Service Internal Rest API"
   6     },
   7     "basePath": "/api/nslcm/v1",
   8     "paths": {
   9         "/ns/vls": {
  10             "post": {
  11                 "tags": [
  12                     "vl"
  13                 ],
  14                 "summary": "vl create",
  15                 "description": "",
  16                 "operationId": "create_vl",
  17                 "consumes": [
  18                     "application/json"
  19                 ],
  20                 "produces": [
  21                     "application/json"
  22                 ],
  23                 "parameters": [
  24                     {
  25                         "in": "body",
  26                         "name": "body",
  27                         "description": "instantiate request param",
  28                         "required": true,
  29                         "schema": {
  30                             "$ref": "#/definitions/VlPostRequest"
  31                         }
  32                     }
  33                 ],
  34                 "responses": {
  35                     "201": {
  36                         "description": "",
  37                         "schema": {
  38                             "$ref": "#/definitions/VlPostResponse"
  39                         }
  40                     },
  41                     "404": {
  42                         "description": "URL not found"
  43                     }
  44                 }
  45             }
  46         },
  47         "/ns/vls/{vlId}": {
  48             "get": {
  49                 "tags": [
  50                     "vl"
  51                 ],
  52                 "summary": "query the specified vl info",
  53                 "description": "",
  54                 "operationId": "query_vl",
  55                 "consumes": [
  56                     "application/json"
  57                 ],
  58                 "produces": [
  59                     "application/json"
  60                 ],
  61                 "parameters": [
  62                     {
  63                         "name": "vlId",
  64                         "in": "path",
  65                         "description": "vl instance id",
  66                         "required": true,
  67                         "type": "string"
  68                     }
  69                 ],
  70                 "responses": {
  71                     "200": {
  72                         "description": "successful operation",
  73                         "schema": {
  74                             "$ref": "#/definitions/VlInfo"
  75                         }
  76                     },
  77                     "404": {
  78                         "description": "the vl instance id is wrong"
  79                     },
  80                     "500": {
  81                         "description": "the url is invalid"
  82                     }
  83                 }
  84             },
  85             "delete": {
  86                 "tags": [
  87                     "vl"
  88                 ],
  89                 "summary": "delete vl",
  90                 "description": "",
  91                 "operationId": "delete_vl",
  92                 "consumes": [
  93                     "application/json"
  94                 ],
  95                 "produces": [
  96                     "application/json"
  97                 ],
  98                 "parameters": [
  99                     {
 100                         "required": true,
 101                         "type": "string",
 102                         "description": "",
 103                         "name": "vlId",
 104                         "in": "path"
 105                     }
 106                 ],
 107                 "responses": {
 108                     "204": {
 109                         "description": "successful operation",
 110                         "schema": {
 111                             "$ref": "#/definitions/DeleteVlResponse"
 112                         }
 113                     },
 114                     "404": {
 115                         "description": "the vl instance id is wrong"
 116                     },
 117                     "500": {
 118                         "description": "the url is invalid"
 119                     }
 120                 }
 121             }
 122         }
 123     },
 124     "definitions": {
 125         "VlPostRequest": {
 126             "type": "object",
 127             "properties": {
 128                 "jobId": {
 129                     "type": "string"
 130                 },
 131                 "nsInstanceId": {
 132                     "type": "string"
 133                 },
 134                 "flavourId": {
 135                     "type": "string"
 136                 },
 137                 "sapData": {
 138                     "type": "array",
 139                     "items": {
 140                         "type": "object"
 141                     }
 142                 },
 143                 "pnfInfo": {
 144                     "type": "array",
 145                     "items": {
 146                         "type": "object"
 147                     }
 148                 },
 149                 "vnfInstanceData": {
 150                     "type": "array",
 151                     "items": {
 152                         "type": "object"
 153                     }
 154                 },
 155                 "nestedNsInstanceId": {
 156                     "type": "array",
 157                     "items": {
 158                         "type": "object"
 159                     }
 160                 },
 161                 "locationConstraints": {
 162                     "type": "array",
 163                     "items": {
 164                         "type": "object"
 165                     }
 166                 },
 167                 "additionalParamForNs": {
 168                     "type": "array",
 169                     "items": {
 170                         "type": "object"
 171                     }
 172                 },
 173                 "additionalParamForVnf": {
 174                     "type": "array",
 175                     "items": {
 176                         "type": "object"
 177                     }
 178                 },
 179                 "extNSVirtualLink": {
 180                     "type": "array",
 181                     "items": {
 182                         "type": "object"
 183                     }
 184                 },
 185                 "context": {
 186                     "type": "string"
 187                 },
 188                 "vlIndex": {
 189                     "type": "string"
 190                 }
 191             }
 192         },
 193         "VlPostResponse": {
 194             "type": "object",
 195             "properties": {
 196                 "result": {
 197                     "type": "integer",
 198                     "enum": [
 199                         0,
 200                         1
 201                     ]
 202                 },
 203                 "detail": {
 204                     "type": "string"
 205                 },
 206                 "vlId": {
 207                     "type": "string"
 208                 }
 209             }
 210         },
 211         "VlInfo": {
 212             "type": "object",
 213             "properties": {
 214                 "vlId": {
 215                     "type": "string"
 216                 },
 217                 "vlName": {
 218                     "type": "string"
 219                 },
 220                 "vlStatus": {
 221                     "type": "string"
 222                 }
 223             }
 224         },
 225         "DeleteVlResponse": {
 226             "type": "object",
 227             "properties": {
 228                 "result": {
 229                     "type": "integer",
 230                     "enum": [
 231                         0,
 232                         1
 233                     ]
 234                 },
 235                 "detail": {
 236                     "type": "string"
 237                 }
 238             }
 239         }
 240     }
 241 }