--- /dev/null
+{
+ "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
Code Review / vfc / nfvo / lcm.git / blobdiff