aboutsummaryrefslogtreecommitdiffstats
path: root/docs/APIs/NSLCM_API
diff options
context:
space:
mode:
authoryangyan <yangyanyj@chinamobile.com>2017-09-26 11:42:00 +0800
committeryangyan <yangyanyj@chinamobile.com>2017-09-26 11:42:16 +0800
commit71e81d2345760e3d193c584b3e73cce5270d6872 (patch)
treeb7efb45aa58c566010cd4520aa17f9698f587aa3 /docs/APIs/NSLCM_API
parent8df64c4e5d4eeed111fb41efe30785fc6d7ac03c (diff)
update the api files
Fix sphinx verify issues Issue-ID: VFC-447 Change-Id: Icdb93758f8d27443d3bebd91b92527c7c9bec449 Signed-off-by: yangyan <yangyanyj@chinamobile.com>
Diffstat (limited to 'docs/APIs/NSLCM_API')
-rw-r--r--docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst524
1 files changed, 521 insertions, 3 deletions
diff --git a/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst b/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
index 4be4162d..16b52b9c 100644
--- a/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
+++ b/docs/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst
@@ -1,544 +1,1062 @@
-.. contents::
- :depth: 1
-..
+
NS LCM API
==========
{
"swagger": "2.0",
+
"info": {
+
"version": "1.0.0",
+
"title": "ONAP VFC Network Service Lifecycle Management API",
+
"description": "VFC Network Service Lifecycle Management Rest API.",
+
"contact": {
+
"name": "ONAP VFC team",
+
"email": "onap-discuss@lists.onap.org",
+
"url": "https://gerrit.onap.org/r/#/admin/projects/vfc/nfvo/lcm"
+
}
+
},
+
"basePath": "/api/nslcm/v1",
+
"schemes": [
+
"http",
"https"
+
],
+
"consumes": [
+
"application/json"
+
],
"produces": [
+
"application/json"
+
],
"paths": {
+
"/ns": {
+
"post": {
+
"tags": [
+
"ns"
+
],
"summary": "ns create",
+
"description": "ns create",
+
"operationId": "ns_create",
+
"parameters": [
+
{
+
"in": "body",
+
"name": "NSCreateRequest",
+
"description": "NS Instance Create Request",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/NsCreateRequest"
+
}
+
}
+
],
+
"responses": {
+
"200": {
+
"description": "successful operation",
+
"schema": {
+
"$ref": "#/definitions/NsCreateResponse"
+
}
+
}
+
}
+
},
+
"get": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns get",
+
"description": "ns get",
+
"operationId": "ns_get",
+
"parameters": [],
+
"responses": {
+
"200": {
+
"description": "successful operation",
+
"schema": {
+
"$ref": "#/definitions/NsInfo"
+
}
+
}
+
}
+
}
+
},
+
"/ns/{nsInstanceId}/Instantiate": {
+
"post": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns Instantiate",
+
"description": "ns Instantiate",
+
"operationId": "ns_Instantiate",
+
"parameters": [
+
{
"required": true,
+
"type": "string",
+
"description": "",
+
"name": "nsInstanceId",
+
"in": "path"
+
},
{
+
"in": "body",
+
"name": "NSInstantiateRequest",
+
"description": "NS Instantiate Request Body",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/NsInstantiateRequest"
+
}
+
}
+
],
+
"responses": {
+
"200": {
+
"description": "",
+
"schema": {
+
"$ref": "#/definitions/JobInfo"
+
}
+
},
+
"201": {
+
"description": "Invalid Request"
+
}
+
}
+
}
+
},
+
"/ns/{nsInstanceId}/scale": {
+
"post": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns scale",
+
"description": "ns scale",
+
"operationId": "ns_scale",
+
"parameters": [
+
{
+
"required": true,
+
"type": "string",
+
"description": "",
+
"name": "nsInstanceId",
+
"in": "path"
+
},
+
{
+
"in": "body",
+
"name": "ScaleNSRequest",
+
"description": "Scale NS Request Body",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/NsScaleRequest"
+
}
+
}
+
],
+
"responses": {
+
"200": {
+
"description": "",
+
"schema": {
+
"$ref": "#/definitions/JobInfo"
+
}
+
},
+
"201": {
+
"description": "Invalid Request"
+
}
+
}
+
}
+
},
+
"/ns/{ns_instance_id}/heal": {
+
"post": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns heal",
+
"description": "ns heal",
+
"operationId": "ns_heal",
+
"parameters": [
+
{
"required": true,
+
"type": "string",
+
"description": "Identifier of the NS instance.",
+
"name": "ns_instance_id",
+
"in": "path"
+
},
+
{
+
"in": "body",
+
"name": "healVnfData",
+
"description": "healVnfData",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/NsHealRequest"
+
}
+
}
+
],
+
"responses": {
+
"202": {
+
"description": "",
+
"schema": {
+
"$ref": "#/definitions/JobInfo"
+
}
+
},
+
"500": {
+
"description": "the url is invalid"
+
}
+
}
+
}
+
},
+
"/ns/{ns_instance_id}/terminate": {
+
"post": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns terminate",
+
"description": "ns terminate",
+
"operationId": "ns_terminate",
+
"parameters": [
+
{
+
"required": true,
+
"type": "string",
+
"description": "Identifier of the NS instance.",
+
"name": "ns_instance_id",
+
"in": "path"
+
},
+
{
"in": "body",
+
"name": "NsTerminateRequest",
+
"description": "NsTerminateRequest",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/NsTerminateRequest"
+
}
+
}
+
],
+
"responses": {
+
"202": {
+
"description": "",
+
"schema": {
+
"$ref": "#/definitions/JobInfo"
+
}
+
},
+
"500": {
+
"description": "the url is invalid"
+
}
+
}
+
}
+
},
"/ns/{ns_instance_id}": {
+
"delete": {
+
"tags": [
+
"ns"
+
],
+
"summary": "ns delete",
+
"description": "ns delete",
+
"operationId": "ns_delete",
+
"parameters": [
+
{
"required": true,
+
"type": "string",
+
"description": "Identifier of the NS instance.",
+
"name": "ns_instance_id",
+
"in": "path"
+
}
+
],
+
"responses": {
+
"204": {
+
"description": "The NS instance resource and the associated NS identifier were deleted successfully."
+
}
+
}
+
}
+
},
+
"/jobs/{jobId}": {
+
"post": {
+
"tags": [
+
"job"
+
],
+
"summary": "jobstatus",
+
"description": "",
+
"operationId": "jobstatus",
+
"parameters": [
+
{
"required": true,
+
"type": "string",
+
"description": "",
+
"name": "jobId",
+
"in": "path"
+
},
+
{
+
"in": "body",
+
"name": "body",
+
"description": "request param",
+
"required": true,
+
"schema": {
+
"$ref": "#/definitions/JobProgressRequest"
+
}
+
}
+
],
+
"responses": {
+
"202": {
+
"description": ""
+
}
+
}
+
}
+
}
+
},
+
"definitions": {
+
"NsCreateRequest": {
+
"type": "object",
+
"properties": {
+
"csarId": {
+
"type": "string",
+
"description": "the NS package ID"
+
},
+
"nsName": {
+
"type": "string"
+
},
+
"description": {
+
"type": "string"
+
}
+
}
+
},
+
"NsCreateResponse": {
+
"type": "object",
+
"properties": {
+
"nsInstanceId": {
+
"type": "string"
+
}
+
}
+
},
"NsInstantiateRequest": {
+
"type": "object",
+
"properties": {
+
"LocationConstraints": {
+
"type": "array",
+
"items": {
+
"$ref": "#/definitions/LocationConstraint"
+
}
+
},
+
"additionalParamForNs": {
+
"type": "string"
+
}
+
}
+
},
+
"LocationConstraint": {
+
"type": "object",
+
"properties": {
+
"vnfProfileId": {
+
"type": "string"
+
},
"locationConstraints": {
+
"type": "object",
+
"properties": {
+
"vimid": {
+
"type": "string"
+
}
+
}
+
}
+
}
+
},
+
"NsScaleRequest": {
+
"type": "object",
+
"properties": {
+
"scaleType": {
+
"type": "string"
+
},
+
"scaleNsByStepsData": {
+
"$ref": "#/definitions/NsScaleByStepsData"
+
}
+
}
+
},
+
"NsScaleByStepsData": {
+
"type": "object",
+
"properties": {
+
"scalingDirection": {
+
"type": "string"
+
},
+
"aspectId": {
+
"type": "string"
+
},
+
"numberOfSteps": {
+
"type": "integer"
+
}
+
}
+
},
+
"NsHealRequest": {
+
"type": "object",
+
"properties": {
+
"vnfInstanceId": {
+
"type": "string"
+
},
+
"cause": {
+
"type": "string"
+
},
+
"additionalParams": {
+
"type": "object",
+
"properties": {
+
"action": {
+
"type": "string"
+
},
+
"actionvminfo": {
+
"type": "object",
+
"properties": {
+
"vmid": {
+
"type": "string"
+
},
+
"vmname": {
+
"type": "string"
+
}
+
}
+
}
+
}
+
}
+
}
+
},
+
"NsTerminateRequest": {
+
"type": "object",
+
"properties": {
+
"terminationType": {
+
"type": "string"
+
},
+
"gracefulTerminationTimeout": {
+
"type": "string"
+
}
+
}
+
},
+
"JobInfo": {
+
"type": "object",
+
"properties": {
+
"jobId": {
+
"type": "string"
+
}
+
}
+
},
+
"JobProgressRequest": {
+
"type": "object",
+
"properties": {
+
"progress": {
+
"type": "string"
+
},
+
"desc": {
+
"type": "string"
+
},
+
"errcode": {
+
"type": "string"
+
}
+
}
+
},
+
"NsInfo": {
+
"type": "object",
+
"properties": {
+
"nsInstanceId": {
+
"type": "string"
+
},
+
"nsName": {
+
"type": "string"
+
},
+
"description": {
+
"type": "string"
+
},
+
"nsdId": {
+
"type": "string"
+
},
+
"vnfInfo": {
+
"type": "array",
+
"items": {
+
"$ref": "#/definitions/vnfInfo"
+
}
+
},
+
"vlInfo": {
+
"type": "array",
+
"items": {
+
"$ref": "#/definitions/vlInfo"
+
}
+
},
+
"vnffgInfo": {
+
"type": "array",
+
"items": {
+
"$ref": "#/definitions/vnffgInfo"
+
}
+
},
+
"nsState": {
+
"type": "string"
+
}
+
}
+
},
+
"vnfInfo": {
+
"type": "object",
+
"properties": {
+
"vnfInstanceId": {
+
"type": "string"
+
},
+
"vnfInstanceName": {
+
"type": "string"
+
},
+
"vnfdId": {
+
"type": "string"
+
}
+
}
+
},
+
"vlInfo": {
+
"type": "object",
+
"properties": {
+
"vlInstanceId": {
+
"type": "string"
+
},
+
"vlInstanceName": {
+
"type": "string"
+
},
+
"vldId": {
+
"type": "string"
+
},
+
"relatedCpInstanceId": {
+
"type": "array",
+
"items": {
+
"$ref": "#/definitions/cpInfo"
+
}
+
}
+
}
+
},
+
"cpInfo": {
+
"type": "object",
+
"properties": {
+
"cpInstanceId": {
+
"type": "string"
+
},
+
"cpInstanceName": {
+
"type": "string"
+
},
+
"cpdId": {
+
"type": "string"
+
}
+
}
+
},
"vnffgInfo": {
+
"type": "object",
+
"properties": {
+
"vnffgInstanceId": {
+
"type": "string"
+
},
+
"vnfId": {
+
"type": "string"
+
},
"pnfId": {
+
"type": "string"
+
},
+
"virtualLinkId": {
+
"type": "string"
+
},
+
"cpId": {
+
"type": "string"
+
},
+
"nfp": {
+
"type": "string"
+
}
+
}
+
}
+
}
+
} \ No newline at end of file