diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-08-03 14:20:10 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-08-03 14:26:18 -0400 |
| commit | d6a93c8116a8c2ce7cb96896d9745406bfa2a5ec (patch) | |
| tree | ae24cbc6bd33b83ac3b1073c6eef98413f50ef09 /docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst | |
| parent | 1ec476db8795ff868065a2e9d8e080afb15ab59b (diff) | |
Eliminate appx 350 Sphinx Warnings
Rename NSLCM_API as json file and use swaggerv2doc to display json swagger definition
Remove extra characters at the end of line reported by doc8
Use code-blocks to better highlight json objects and eliminate warnings
Remove duplicate offeredapis content
Change-Id: Iec699b8f7d4f4be5b9783b3c40f24c8c4a279d7b
Issue-ID: VFC-919
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst')
| -rw-r--r-- | docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst | 651 |
1 files changed, 0 insertions, 651 deletions
diff --git a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst b/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst deleted file mode 100644 index 6ed6196a..00000000 --- a/docs/platform/APIs/NSLCM_API/NSLCM_API_Specification_v0.1.rst +++ /dev/null @@ -1,651 +0,0 @@ -
-
-Network services lifecycle management northbound APIs
-=====================================================
-
-{
- "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"
- }
- },
- "404": {
- "description": "URL not found"
- }
- }
- },
- "get": {
- "tags": [
- "ns"
- ],
- "summary": "ns get",
- "description": "ns get",
- "operationId": "ns_instantces_get",
- "parameters": [
- {
- "required": true,
- "type": "string",
- "description": "job response message id",
- "name": "csarId",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "schema": {
- "$ref": "#/definitions/NsInstancesInfo"
- }
- },
- "404": {
- "description": "URL not found"
- }
- }
- }
- },
- "/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"
- },
- "404": {
- "description": "URL not found"
- }
- }
- }
- },
- "/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"
- },
- "404": {
- "description": "URL not found"
- }
- }
- }
- },
- "/ns/{nsInstanceId}/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": "nsInstanceId",
- "in": "path"
- },
- {
- "in": "body",
- "name": "healVnfData",
- "description": "healVnfData",
- "required": true,
- "schema": {
- "$ref": "#/definitions/NsHealRequest"
- }
- }
- ],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/JobInfo"
- }
- },
- "404": {
- "description": "URL not found"
- },
- "500": {
- "description": "the url is invalid"
- }
- }
- }
- },
- "/ns/{nsInstanceId}/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": "nsInstanceId",
- "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/{nsInstanceId}": {
- "get": {
- "tags": [
- "ns"
- ],
- "summary": "ns get",
- "description": "ns get",
- "operationId": "ns_instance_get",
- "parameters": [
- {
- "required": true,
- "type": "string",
- "description": "Identifier of the NS instance.",
- "name": "nsInstanceId",
- "in": "path"
- }
- ],
- "responses": {
- "200": {
- "description": "successful operation",
- "schema": {
- "$ref": "#/definitions/NsInstanceInfo"
- }
- }
- }
- },
- "delete": {
- "tags": [
- "ns"
- ],
- "summary": "ns delete",
- "description": "ns delete",
- "operationId": "ns_delete",
- "parameters": [
- {
- "required": true,
- "type": "string",
- "description": "Identifier of the NS instance.",
- "name": "nsInstanceId",
- "in": "path"
- }
- ],
- "responses": {
- "204": {
- "description": "The NS instance resource and the associated NS identifier were deleted successfully."
- }
- }
- }
- },
- "/jobs/{jobId}": {
- "get": {
- "tags": [
- "job"
- ],
- "summary": "jobstatus",
- "description": "",
- "operationId": "get_jobstatus",
- "parameters": [
- {
- "required": true,
- "type": "string",
- "description": "job Id",
- "name": "jobId",
- "in": "path"
- },
- {
- "required": true,
- "type": "string",
- "description": "job response message id",
- "name": "responseId",
- "in": "query"
- }
- ],
- "responses": {
- "202": {
- "description": "",
- "schema": {
- "$ref": "#/definitions/JobDetailInfo"
- }
- }
- }
- }
- }
- },
- "definitions": {
- "NsCreateRequest": {
- "type": "object",
- "properties": {
- "context":{
- "type": "object",
- "properties": {
- "globalCustomerId":{
- "type": "string",
- "description": "the global customer id"
- },
- "serviceType":{
- "type": "string",
- "description": "service type"
- }
- }
- },
- "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"
- }
- }
- },
- "NsInstancesInfo":{
- "type": "array",
- "items": {
- "$ref": "#/definitions/NsInstanceInfo"
- }
- },
- "NsInstanceInfo": {
- "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"
- }
- }
- },
- "jobResponseInfo": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string"
- },
- "progress":{
- "type": "string"
- },
- "statusDescription": {
- "type": "string"
- },
- "errorCode": {
- "type": "string"
- },
- "responseId": {
- "type": "string"
- }
- }
- },
- "JobDetailInfo":{
- "type": "object",
- "properties": {
- "jobId": {
- "type": "string"
- },
- "responseDescriptor":
- {
- "type":"object",
- "properties": {
- "status": {
- "type": "string"
- },
- "progress":{
- "type": "string"
- },
- "statusDescription": {
- "type": "string"
- },
- "errorCode": {
- "type": "string"
- },
- "responseId": {
- "type": "string"
- },
- "responseHistoryList": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/jobResponseInfo"
- }
- }
- }
- }
- }
- }
- }
-}
\ No newline at end of file |