lcm/swagger/vfc.sfclcm.swagger.json

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