summaryrefslogtreecommitdiffstats
path: root/mgr
diff options
context:
space:
mode:
authoryunlong ying <ying.yunlong@zte.com.cn>2017-02-25 05:06:11 +0000
committerGerrit Code Review <gerrit@open-o.org>2017-02-25 05:06:11 +0000
commit267b303ef10f7d97bc129340fceb6775b9ea6e26 (patch)
treed4b87cf585fa7110a91e9d6aba33bc5d9963650a /mgr
parentd7ea86852bd6a9da3dee937664d9a2176f85c5c1 (diff)
parent7e1cb7a9774935badc3ad3b7879f1f1efbe8f063 (diff)
Merge "Modify swagger file of gvnfm-vnfmgr"v2.0.0release/mercury
Diffstat (limited to 'mgr')
-rw-r--r--mgr/mgr/swagger/swagger.json370
1 files changed, 358 insertions, 12 deletions
diff --git a/mgr/mgr/swagger/swagger.json b/mgr/mgr/swagger/swagger.json
index c977fbd..552d26f 100644
--- a/mgr/mgr/swagger/swagger.json
+++ b/mgr/mgr/swagger/swagger.json
@@ -1,15 +1,361 @@
{
- "swagger": "2.0",
- "info": {
- "version": "1.0.0",
- "title": "VNF Mgr Service rest API"
- },
- "basePath": "/openoapi/vnfmgr/v1",
- "tags": [
- {
- "name": "vnfmgr"
- }
- ],
- "paths": {
+ "swagger": "2.0",
+ "info": {
+ "version": "1.0.0",
+ "title": "VNF Mgr Service rest API"
+ },
+ "basePath": "/openoapi/vnfmgr/v1",
+ "tags": [
+ {
+ "name": "vnfmgr"
}
+ ],
+ "paths": {
+ "/vnfs": {
+ "post": {
+ "tags": [
+ "vnfReg Resource"
+ ],
+ "summary": "save the specified vnfReg info",
+ "description": "",
+ "operationId": "save_vnfReg",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "body",
+ "in": "body",
+ "description": "request parameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VnfRegRequestParams"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/saveVnfRegInfo"
+ }
+ },
+ "404": {
+ "description": "the vnf instance id is wrong"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ }
+ },
+ "/vnfs/{vnfInstId}": {
+ "get": {
+ "tags": [
+ "vnfReg Resource"
+ ],
+ "summary": "query the specified vnfReg info",
+ "description": "",
+ "operationId": "query_vnfReg",
+ "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/VnfRegInfo"
+ }
+ },
+ "404": {
+ "description": "the vnf instance id is wrong"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "vnf Resource"
+ ],
+ "summary": "save the specified vnf info",
+ "description": "",
+ "operationId": "save_vnf",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "body",
+ "in": "body",
+ "description": "request parameters",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VnfRegRequestParams"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/saveVnfInfo"
+ }
+ },
+ "404": {
+ "description": "the vnf instance id is wrong"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "vnf Resource"
+ ],
+ "summary": "delete the specified vnf info",
+ "description": "",
+ "operationId": "delete_vnf",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "vnfInstId",
+ "in": "path",
+ "description": "vnf instance id",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/deleteVnfInfo"
+ }
+ },
+ "404": {
+ "description": "the vnf instance id is wrong"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ }
+ },
+ "/configuration": {
+ "post": {
+ "tags": [
+ "vnf Resource"
+ ],
+ "summary": "config the specified vnf info",
+ "description": "",
+ "operationId": "config_vnf",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "body",
+ "in": "body",
+ "description": "request data",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VnfRequestParams"
+ }
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "successful operation",
+ "schema": {
+ "$ref": "#/definitions/configVnfInfo"
+ }
+ },
+ "404": {
+ "description": "the vnf instance id is wrong"
+ },
+ "500": {
+ "description": "the url is invalid"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "VnfRegRequestParams": {
+ "type": "object",
+ "properties": {
+ "vnfInstId": {
+ "type": "string"
+ },
+ "ip": {
+ "type": "string"
+ },
+ "port": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ }
+ }
+ },
+ "saveVnfRegInfo": {
+ "type": "object",
+ "properties": {}
+ },
+ "VnfRegInfo": {
+ "type": "object",
+ "properties": {
+ "vnfInstId": {
+ "type": "string"
+ },
+ "ip": {
+ "type": "string"
+ },
+ "port": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ }
+ }
+ },
+ "saveVnfInfo": {
+ "type": "object"
+ },
+ "deleteVnfInfo": {
+ "type": "object"
+ },
+ "VnfRequestParams": {
+ "type": "object",
+ "properties": {
+ "vnfInstanceId": {
+ "type": "string"
+ },
+ "vnfConfigurationData": {
+ "type": "object",
+ "properties": {
+ "cp": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "vnfSpecificData": {
+ "type": "object",
+ "properties": {
+ "autoScalable": {
+ "type": "string"
+ },
+ "autoHealable": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "vnfcConfigurationData": {
+ "type": "object",
+ "properties": {
+ "vnfcId": {
+ "type": "string"
+ },
+ "cp": {
+ "type": "array",
+ "items": {
+ "cpId": {
+ "type": "string"
+ },
+ "cpdId": {
+ "type": "string"
+ },
+ "cpAddress": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "vnfcSpecificData": {}
+ }
+ }
+ }
+ },
+ "configVnfInfo": {
+ "type": "object",
+ "properties": {
+ "vnfConfigurationData": {
+ "cp": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "vnfSpecificData": {
+ "type": "object",
+ "properties": {
+ "autoScalable": {
+ "type": "string"
+ },
+ "autoHealable": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "vnfcConfigurationData": {
+ "type": "object",
+ "properties": {
+ "vnfcId": {
+ "type": "string"
+ },
+ "cp": {
+ "type": "array",
+ "items": {
+ "type": "object"
+ }
+ },
+ "vnfcSpecificData": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
} \ No newline at end of file