lcm/swagger/vfc.others.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/{nsInstanceId}/postdeal": {
  10             "post": {
  11                 "tags": [
  12                     "postdeal"
  13                 ],
  14                 "summary": "ns postdeal",
  15                 "description": "",
  16                 "operationId": "ns_postdeal",
  17                 "consumes": [
  18                     "application/json"
  19                 ],
  20                 "produces": [
  21                     "application/json"
  22                 ],
  23                 "parameters": [
  24                     {
  25                         "required": true,
  26                         "type": "string",
  27                         "description": "",
  28                         "name": "nsInstanceId",
  29                         "in": "path"
  30                     },
  31                     {
  32                         "in": "body",
  33                         "name": "body",
  34                         "description": "request param",
  35                         "required": true,
  36                         "schema": {
  37                             "$ref": "#/definitions/NSInstPostDetailRequest"
  38                         }
  39                     }
  40                 ],
  41                 "responses": {
  42                     "202": {
  43                         "description": ""
  44                     },
  45                     "404": {
  46                         "description": "URL not found"
  47                     }
  48                 }
  49             }
  50         },
  51         "/mandb/{modelName}": {
  52             "get": {
  53                 "tags": [
  54                     "db"
  55                 ],
  56                 "summary": "query ns table info",
  57                 "description": "query ns table info",
  58                 "operationId": "query_ns_table",
  59                 "consumes": [
  60                     "application/json"
  61                 ],
  62                 "produces": [
  63                     "application/json"
  64                 ],
  65                 "parameters": [
  66                     {
  67                         "required": true,
  68                         "type": "string",
  69                         "description": "model Name.",
  70                         "name": "modelName",
  71                         "in": "path"
  72                     }
  73                 ],
  74                 "responses": {
  75                     "200": {
  76                         "description": "successful operation",
  77                         "schema": {
  78                             "$ref": "#/definitions/TableInfo"
  79                         }
  80                     },
  81                     "404": {
  82                         "description": "URL not found"
  83                     },
  84                     "500": {
  85                         "description": "the url is invalid"
  86                     }
  87                 }
  88             },
  89             "delete": {
  90                 "tags": [
  91                     "db"
  92                 ],
  93                 "summary": "ns table delete",
  94                 "description": "ns table delete",
  95                 "operationId": "ns_table_delete",
  96                 "consumes": [
  97                     "application/json"
  98                 ],
  99                 "produces": [
 100                     "application/json"
 101                 ],
 102                 "parameters": [
 103                     {
 104                         "required": true,
 105                         "type": "string",
 106                         "description": "model Name.",
 107                         "name": "modelName",
 108                         "in": "path"
 109                     }
 110                 ],
 111                 "responses": {
 112                     "204": {
 113                         "description": "The tables were deleted successfully."
 114                     },
 115                     "404": {
 116                         "description": "URL not found"
 117                     }
 118                 }
 119             }
 120         },
 121         "/jobs/{jobId}": {
 122           "post": {
 123             "tags": [
 124               "job"
 125             ],
 126             "summary": "jobstatus",
 127             "description": "",
 128             "operationId": "post_jobprogress",
 129             "parameters": [
 130               {
 131                 "required": true,
 132                 "type": "string",
 133                 "description": "",
 134                 "name": "jobId",
 135                 "in": "path"
 136               },
 137               {
 138                 "in": "body",
 139                 "name": "body",
 140                 "description": "request param",
 141                 "required": true,
 142                 "schema": {
 143                   "$ref": "#/definitions/JobProgressRequest"
 144                 }
 145               }
 146             ],
 147             "responses": {
 148               "202": {
 149                 "description": ""
 150               },
 151               "404": {
 152                         "description": "URL not found"
 153               }
 154             }
 155         }
 156       }
 157     },
 158     "definitions": {
 159
 160         "NSInstPostDetailRequest": {
 161             "type": "object",
 162             "properties": {
 163                 "status": {
 164                     "type": "string"
 165                 }
 166             }
 167         },
 168         "JobProgressRequest": {
 169           "type": "object",
 170           "properties": {
 171             "progress": {
 172               "type": "string"
 173             },
 174             "desc": {
 175               "type": "string"
 176             },
 177             "errcode": {
 178               "type": "string"
 179             }
 180           }
 181         },
 182         "TableInfo": {
 183             "type": "object",
 184             "properties": {
 185                 "count": {
 186                     "type": "string"
 187                 }
 188             }
 189         }
 190     }
 191 }