From: maopengzhang Date: Wed, 27 Sep 2017 16:07:47 +0000 (+0800) Subject: Add 404 error in the swagger X-Git-Tag: v1.0.0~19 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=vfc%2Fnfvo%2Flcm.git;a=commitdiff_plain;h=4dfcc940a6a36221229ce64f079ae011c2acde9a Add 404 error in the swagger Add 404 error in the swagger in the all VFC API files Change-Id: I43dbb704e51fc2e793d4bdd723f9ec0711c0fbc7 Issue-ID: VFC-163 Signed-off-by: maopengzhang --- diff --git a/lcm/swagger/vfc.db.swagger.json b/lcm/swagger/vfc.db.swagger.json index 98f7696b..6c8efb02 100644 --- a/lcm/swagger/vfc.db.swagger.json +++ b/lcm/swagger/vfc.db.swagger.json @@ -1,758 +1 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VFC Service Internal Rest API" - }, - "basePath": "/api/nslcm/v1", - "paths": { - "/ns/vls": { - "post": { - "tags": [ - "vls" - ], - "summary": "vl create", - "description": "", - "operationId": "create_vl", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VlPostRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/VlPostResponse" - } - } - } - } - }, - "/ns/vls/{vlId}": { - "get": { - "tags": [ - "vls" - ], - "summary": "query the specified vl info", - "description": "", - "operationId": "query_vl", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "vlId", - "in": "path", - "description": "vl instance id", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VlInfo" - } - }, - "404": { - "description": "the vl instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - }, - "delete": { - "tags": [ - "vls" - ], - "summary": "delete vl", - "description": "", - "operationId": "delete_vl", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "", - "name": "vlId", - "in": "path" - } - ], - "responses": { - "204": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/DeleteVlResponse" - } - }, - "404": { - "description": "the vl instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/ns/vnfs": { - "post": { - "tags": [ - "vnfs" - ], - "summary": "vnf create", - "description": "", - "operationId": "create_vnf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VnfPostRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/VnfPostResponse" - } - } - } - } - }, - "/ns/vnfs/{vnfInstId}": { - "get": { - "tags": [ - "vnfs" - ], - "summary": "query the specified vnf info", - "description": "", - "operationId": "query_vnf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "vnfInstId", - "in": "path", - "description": "vnf instance id", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VnfInfo" - } - }, - "404": { - "description": "the vnf instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - }, - "delete": { - "tags": [ - "vnfs" - ], - "summary": "delete vnf", - "description": "", - "operationId": "delete_vnf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "", - "name": "vnfInstId", - "in": "path" - } - ], - "responses": { - "204": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/DeleteResponse" - } - }, - "404": { - "description": "the vl instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/ns/sfcs": { - "post": { - "tags": [ - "sfcs" - ], - "summary": "sfc create", - "description": "", - "operationId": "create_sfc", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "request param", - "required": true, - "schema": { - "$ref": "#/definitions/SfcPostRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/SfcPostResponse" - } - } - } - } - }, - "/ns/sfcs/{sfcInstId}": { - "get": { - "tags": [ - "sfcs" - ], - "summary": "query the specified sfc info", - "description": "", - "operationId": "query_sfc", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "sfcInstId", - "in": "path", - "description": "sfc instance id", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/SfcInfo" - } - }, - "404": { - "description": "the sfc instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - }, - "delete": { - "tags": [ - "vnfs" - ], - "summary": "delete sfc", - "description": "", - "operationId": "delete_sfc", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "", - "name": "sfcInstId", - "in": "path" - } - ], - "responses": { - "204": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/DeleteResponse" - } - }, - "404": { - "description": "the sfc instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/ns/{nsInstanceId}/postdeal": { - "post": { - "tags": [ - "postdeal" - ], - "summary": "ns postdeal", - "description": "", - "operationId": "ns_postdeal", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "", - "name": "nsInstanceId", - "in": "path" - }, - { - "in": "body", - "name": "body", - "description": "request param", - "required": true, - "schema": { - "$ref": "#/definitions/NSInstPostDetailRequest" - } - } - ], - "responses": { - "202": { - "description": "" - } - } - } - }, - "/mandb/{modelName}": { - "get": { - "tags": [ - "db" - ], - "summary": "query ns table info", - "description": "query ns table info", - "operationId": "query_ns_table", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "model Name.", - "name": "modelName", - "in": "path" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/TableInfo" - } - }, - "500": { - "description": "the url is invalid" - } - } - }, - "delete": { - "tags": [ - "db" - ], - "summary": "ns table delete", - "description": "ns table delete", - "operationId": "ns_table_delete", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "model Name.", - "name": "modelName", - "in": "path" - } - ], - "responses": { - "204": { - "description": "The tables were deleted successfully." - } - } - } - } - }, - "definitions": { - "VlPostRequest": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - }, - "nsInstanceId": { - "type": "string" - }, - "flavourId": { - "type": "string" - }, - "sapData": { - "type": "array", - "items": { - "type": "object" - } - }, - "pnfInfo": { - "type": "array", - "items": { - "type": "object" - } - }, - "vnfInstanceData": { - "type": "array", - "items": { - "type": "object" - } - }, - "nestedNsInstanceId": { - "type": "array", - "items": { - "type": "object" - } - }, - "locationConstraints": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForNs": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForVnf": { - "type": "array", - "items": { - "type": "object" - } - }, - "extNSVirtualLink": { - "type": "array", - "items": { - "type": "object" - } - }, - "context": { - "type": "string" - }, - "vlIndex": { - "type": "string" - } - } - }, - "VlPostResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - }, - "vlId": { - "type": "string" - } - } - }, - "VnfPostRequest": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - }, - "nsInstanceId": { - "type": "string" - }, - "flavourId": { - "type": "string" - }, - "sapData": { - "type": "array", - "items": { - "type": "object" - } - }, - "pnfInfo": { - "type": "array", - "items": { - "type": "object" - } - }, - "vnfInstanceData": { - "type": "array", - "items": { - "type": "object" - } - }, - "nestedNsInstanceId": { - "type": "array", - "items": { - "type": "object" - } - }, - "locationConstraints": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForNs": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForVnf": { - "type": "array", - "items": { - "type": "object" - } - }, - "extNSVirtualLink": { - "type": "array", - "items": { - "type": "object" - } - }, - "context": { - "type": "string" - }, - "vnfIndex": { - "type": "string" - } - } - }, - "VnfPostResponse": { - "type": "object", - "properties": { - "vnfInstId": { - "type": "string" - }, - "jobId": { - "type": "string" - } - } - }, - "SfcPostRequest": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - }, - "nsInstanceId": { - "type": "string" - }, - "sapData": { - "type": "array", - "items": { - "type": "object" - } - }, - "vnfInstanceData": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForNs": { - "type": "array", - "items": { - "type": "object" - } - }, - "additionalParamForVnf": { - "type": "array", - "items": { - "type": "object" - } - }, - "sdnControllerId": { - "type": "string" - }, - "context": { - "type": "string" - }, - "fpindex": { - "type": "string" - } - } - }, - "NSInstPostDetailRequest": { - "type": "object", - "properties": { - "status": { - "type": "string" - } - } - }, - - "SfcPostResponse": { - "type": "object", - "properties": { - "sfcInstId": { - "type": "string" - }, - "jobId": { - "type": "string" - } - } - }, - "VlInfo": { - "type": "object", - "properties": { - "vlId": { - "type": "string" - }, - "vlName": { - "type": "string" - }, - "vlStatus": { - "type": "string" - } - } - }, - "VnfInfo": { - "type": "object", - "properties": { - "vnfInstId": { - "type": "string" - }, - "vnfName": { - "type": "string" - }, - "vnfStatus": { - "type": "string" - } - } - }, - "SfcInfo": { - "type": "object", - "properties": { - "sfcInstId": { - "type": "string" - }, - "sfcName": { - "type": "string" - }, - "sfcStatus": { - "type": "string" - } - } - }, - "DeleteVlResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - } - } - }, - "DeleteResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - } - } - }, - - "TableInfo": { - "type": "object", - "properties": { - "count": { - "type": "string" - } - } - } - } -} \ No newline at end of file + \ No newline at end of file diff --git a/lcm/swagger/vfc.nslcm.swagger.json b/lcm/swagger/vfc.nslcm.swagger.json index 0a8fc095..7d15e101 100644 --- a/lcm/swagger/vfc.nslcm.swagger.json +++ b/lcm/swagger/vfc.nslcm.swagger.json @@ -47,6 +47,9 @@ "schema": { "$ref": "#/definitions/NsCreateResponse" } + }, + "404": { + "description": "URL not found" } } }, @@ -72,6 +75,9 @@ "schema": { "$ref": "#/definitions/NsInstancesInfo" } + }, + "404": { + "description": "URL not found" } } } @@ -111,6 +117,9 @@ }, "201": { "description": "Invalid Request" + }, + "404": { + "description": "URL not found" } } } @@ -150,6 +159,9 @@ }, "201": { "description": "Invalid Request" + }, + "404": { + "description": "URL not found" } } } @@ -187,6 +199,9 @@ "$ref": "#/definitions/JobInfo" } }, + "404": { + "description": "URL not found" + }, "500": { "description": "the url is invalid" } diff --git a/lcm/swagger/vfc.others.swagger.json b/lcm/swagger/vfc.others.swagger.json index f6b48fbb..fe0bc826 100644 --- a/lcm/swagger/vfc.others.swagger.json +++ b/lcm/swagger/vfc.others.swagger.json @@ -41,6 +41,9 @@ "responses": { "202": { "description": "" + }, + "404": { + "description": "URL not found" } } } @@ -75,6 +78,9 @@ "$ref": "#/definitions/TableInfo" } }, + "404": { + "description": "URL not found" + }, "500": { "description": "the url is invalid" } @@ -105,6 +111,9 @@ "responses": { "204": { "description": "The tables were deleted successfully." + }, + "404": { + "description": "URL not found" } } } @@ -138,6 +147,9 @@ "responses": { "202": { "description": "" + }, + "404": { + "description": "URL not found" } } } diff --git a/lcm/swagger/vfc.sfclcm.swagger.json b/lcm/swagger/vfc.sfclcm.swagger.json index af06543f..53c5754d 100644 --- a/lcm/swagger/vfc.sfclcm.swagger.json +++ b/lcm/swagger/vfc.sfclcm.swagger.json @@ -37,6 +37,9 @@ "schema": { "$ref": "#/definitions/SfcPostResponse" } + }, + "404": { + "description": "URL not found" } } } diff --git a/lcm/swagger/vfc.vllcm.swagger.json b/lcm/swagger/vfc.vllcm.swagger.json index 1b5241a9..dadd8ceb 100644 --- a/lcm/swagger/vfc.vllcm.swagger.json +++ b/lcm/swagger/vfc.vllcm.swagger.json @@ -37,6 +37,9 @@ "schema": { "$ref": "#/definitions/VlPostResponse" } + }, + "404": { + "description": "URL not found" } } } diff --git a/lcm/swagger/vfc.vnfdriver.swagger.json b/lcm/swagger/vfc.vnfdriver.swagger.json index c5e890c8..c9c47c01 100644 --- a/lcm/swagger/vfc.vnfdriver.swagger.json +++ b/lcm/swagger/vfc.vnfdriver.swagger.json @@ -336,6 +336,9 @@ "$ref": "#/definitions/GrantVNFResponse" } }, + "404": { + "description": "URL not found" + }, "500": { "description": "the url is invalid" } @@ -372,6 +375,9 @@ "202": { "description": "" }, + "404": { + "description": "URL not found" + }, "500": { "description": "the url is invalid" } @@ -485,6 +491,9 @@ "$ref": "#/definitions/VnfmInfo" } }, + "404": { + "description": "URL not found" + }, "500": { "description": "internal error" } @@ -521,6 +530,9 @@ "$ref": "#/definitions/VimInfo" } }, + "404": { + "description": "URL not found" + }, "500": { "description": "internal error" } diff --git a/lcm/swagger/vfc.vnflcm.swagger.json b/lcm/swagger/vfc.vnflcm.swagger.json index 3fbcb603..2481704e 100644 --- a/lcm/swagger/vfc.vnflcm.swagger.json +++ b/lcm/swagger/vfc.vnflcm.swagger.json @@ -37,6 +37,9 @@ "schema": { "$ref": "#/definitions/VnfPostResponse" } + }, + "404": { + "description": "URL not found" } } }