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                 }
  46             }
  47         },
  48         "/mandb/{modelName}": {
  49             "get": {
  50                 "tags": [
  51                     "db"
  52                 ],
  53                 "summary": "query ns table info",
  54                 "description": "query ns table info",
  55                 "operationId": "query_ns_table",
  56                 "consumes": [
  57                     "application/json"
  58                 ],
  59                 "produces": [
  60                     "application/json"
  61                 ],
  62                 "parameters": [
  63                     {
  64                         "required": true,
  65                         "type": "string",
  66                         "description": "model Name.",
  67                         "name": "modelName",
  68                         "in": "path"
  69                     }
  70                 ],
  71                 "responses": {
  72                     "200": {
  73                         "description": "successful operation",
  74                         "schema": {
  75                             "$ref": "#/definitions/TableInfo"
  76                         }
  77                     },
  78                     "500": {
  79                         "description": "the url is invalid"
  80                     }
  81                 }
  82             },
  83             "delete": {
  84                 "tags": [
  85                     "db"
  86                 ],
  87                 "summary": "ns table delete",
  88                 "description": "ns table delete",
  89                 "operationId": "ns_table_delete",
  90                 "consumes": [
  91                     "application/json"
  92                 ],
  93                 "produces": [
  94                     "application/json"
  95                 ],
  96                 "parameters": [
  97                     {
  98                         "required": true,
  99                         "type": "string",
 100                         "description": "model Name.",
 101                         "name": "modelName",
 102                         "in": "path"
 103                     }
 104                 ],
 105                 "responses": {
 106                     "204": {
 107                         "description": "The tables were deleted successfully."
 108                     }
 109                 }
 110             }
 111         },
 112         "/jobs/{jobId}": {
 113           "post": {
 114             "tags": [
 115               "job"
 116             ],
 117             "summary": "jobstatus",
 118             "description": "",
 119             "operationId": "post_jobprogress",
 120             "parameters": [
 121               {
 122                 "required": true,
 123                 "type": "string",
 124                 "description": "",
 125                 "name": "jobId",
 126                 "in": "path"
 127               },
 128               {
 129                 "in": "body",
 130                 "name": "body",
 131                 "description": "request param",
 132                 "required": true,
 133                 "schema": {
 134                   "$ref": "#/definitions/JobProgressRequest"
 135                 }
 136               }
 137             ],
 138             "responses": {
 139               "202": {
 140                 "description": ""
 141               }
 142             }
 143         }
 144       }
 145     },
 146     "definitions": {
 147
 148         "NSInstPostDetailRequest": {
 149             "type": "object",
 150             "properties": {
 151                 "status": {
 152                     "type": "string"
 153                 }
 154             }
 155         },
 156         "JobProgressRequest": {
 157           "type": "object",
 158           "properties": {
 159             "progress": {
 160               "type": "string"
 161             },
 162             "desc": {
 163               "type": "string"
 164             },
 165             "errcode": {
 166               "type": "string"
 167             }
 168           }
 169         },
 170         "TableInfo": {
 171             "type": "object",
 172             "properties": {
 173                 "count": {
 174                     "type": "string"
 175                 }
 176             }
 177         }
 178     }
 179 }