diff options
| author |   Aditya Anantatmakula <aditya.anantatmakula@verizon.com> | 2018-07-16 15:24:38 +0530 |
|---|---|---|
| committer | Aditya Anantatmakula <aditya.anantatmakula@verizon.com> | 2018-07-16 15:29:37 +0530 |
| commit | 7bf50435745fcd5a30dc5d8e6f36bf59eac33398 (patch) | |
| tree | 04d516d27423a7ad90a3cb315292295be4b376f5 | |
| parent | d4076143a8c36f2440f5ec425b5e1759692fe057 (diff) | |
Clean Up the unnecessary swagger JSON files
Change-Id: I3768348f349db2ace7dc46c1be0f42963fe5a8e0
Issue-ID: VFC-957
signed-off-by: Aditya Anantatmakula <aditya.anantatmakula@verizon.com>
| -rw-r--r-- | lcm/swagger/urls.py | 1 | ||||
| -rw-r--r-- | lcm/swagger/vfc.db.swagger.json | 90 | ||||
| -rw-r--r-- | lcm/swagger/vfc.nslcm.swagger.json | 649 | ||||
| -rw-r--r-- | lcm/swagger/vfc.others.swagger.json | 113 | ||||
| -rw-r--r-- | lcm/swagger/vfc.sfclcm.swagger.json | 240 | ||||
| -rw-r--r-- | lcm/swagger/vfc.vllcm.swagger.json | 241 | ||||
| -rw-r--r-- | lcm/swagger/vfc.vnfdriver.swagger.json | 1358 | ||||
| -rw-r--r-- | lcm/swagger/vfc.vnflcm.swagger.json | 235 | ||||
| -rw-r--r-- | lcm/swagger/views.py | 73 |
9 files changed, 0 insertions, 3000 deletions
diff --git a/lcm/swagger/urls.py b/lcm/swagger/urls.py index 47a1cc2c..ef2806a7 100644 --- a/lcm/swagger/urls.py +++ b/lcm/swagger/urls.py @@ -34,7 +34,6 @@ SchemaView = get_schema_view( ) urlpatterns = [ - # url(r'^api/nslcm/v1/swagger.json$', SwaggerJsonView.as_view()), url(r'^api/nslcm/v1/swagger(?P<format>.json|.yaml)$', SchemaView.without_ui(cache_timeout=0), name='schema-json'), url(r'^api/nslcm/v1/swagger$', SchemaView.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'), url(r'^api/nslcm/v1/redoc$', SchemaView.with_ui('redoc', cache_timeout=0), name='schema-redoc'), diff --git a/lcm/swagger/vfc.db.swagger.json b/lcm/swagger/vfc.db.swagger.json deleted file mode 100644 index fde55d32..00000000 --- a/lcm/swagger/vfc.db.swagger.json +++ /dev/null @@ -1,90 +0,0 @@ -{
- "swagger": "2.0",
- "info": {
- "version": "1.0.0",
- "title": "ONAP VFC Service Internal DB Rest API"
- },
- "basePath": "/api/nslcm/v1",
- "paths": {
- "/mandb/{modelName}": {
- "get": {
- "tags": [
- "Database"
- ],
- "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"
- }
- },
- "404": {
- "description": "URL not found"
- },
- "500": {
- "description": "the url is invalid"
- }
- }
- },
- "delete": {
- "tags": [
- "Database"
- ],
- "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."
- },
- "404": {
- "description": "URL not found"
- }
- }
- }
- }
- },
- "definitions": {
- "TableInfo": {
- "type": "object",
- "properties": {
- "count": {
- "type": "string"
- }
- }
- }
- }
-}
\ No newline at end of file diff --git a/lcm/swagger/vfc.nslcm.swagger.json b/lcm/swagger/vfc.nslcm.swagger.json deleted file mode 100644 index e4fefe0f..00000000 --- a/lcm/swagger/vfc.nslcm.swagger.json +++ /dev/null @@ -1,649 +0,0 @@ -{
- "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": "object",
- "additionalProperties" : {
- "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"
- }
- }
- }
- }
- }
- }
- }
-}
diff --git a/lcm/swagger/vfc.others.swagger.json b/lcm/swagger/vfc.others.swagger.json deleted file mode 100644 index 16d70c0b..00000000 --- a/lcm/swagger/vfc.others.swagger.json +++ /dev/null @@ -1,113 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VFC Service Internal Rest API" - }, - "basePath": "/api/nslcm/v1", - "paths": { - "/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": "" - }, - "404": { - "description": "URL not found" - } - } - } - }, - "/jobs/{jobId}": { - "post": { - "tags": [ - "job" - ], - "summary": "jobstatus", - "description": "", - "operationId": "post_jobprogress", - "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": "" - }, - "404": { - "description": "URL not found" - } - } - } - } - }, - "definitions": { - - "NSInstPostDetailRequest": { - "type": "object", - "properties": { - "status": { - "type": "string" - } - } - }, - "JobProgressRequest": { - "type": "object", - "properties": { - "progress": { - "type": "string" - }, - "desc": { - "type": "string" - }, - "errcode": { - "type": "string" - } - } - } - } -}
\ No newline at end of file diff --git a/lcm/swagger/vfc.sfclcm.swagger.json b/lcm/swagger/vfc.sfclcm.swagger.json deleted file mode 100644 index 53c5754d..00000000 --- a/lcm/swagger/vfc.sfclcm.swagger.json +++ /dev/null @@ -1,240 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VFC Service SFC Rest API" - }, - "basePath": "/api/nslcm/v1", - "paths": { - "/ns/sfcs": { - "post": { - "tags": [ - "sfc" - ], - "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" - } - }, - "404": { - "description": "URL not found" - } - } - } - }, - "/ns/sfcs/{sfcInstId}": { - "get": { - "tags": [ - "sfc" - ], - "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": [ - "sfc" - ], - "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" - } - } - } - } - }, - "definitions": { - - "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" - } - } - }, - "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" - } - } - }, - - "DeleteResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - } - } - }, - "SfcInfo": { - "type": "object", - "properties": { - "sfcInstId": { - "type": "string" - }, - "sfcName": { - "type": "string" - }, - "sfcStatus": { - "type": "string" - } - } - } - } -}
\ No newline at end of file diff --git a/lcm/swagger/vfc.vllcm.swagger.json b/lcm/swagger/vfc.vllcm.swagger.json deleted file mode 100644 index dadd8ceb..00000000 --- a/lcm/swagger/vfc.vllcm.swagger.json +++ /dev/null @@ -1,241 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VFC Service Internal Rest API" - }, - "basePath": "/api/nslcm/v1", - "paths": { - "/ns/vls": { - "post": { - "tags": [ - "vl" - ], - "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" - } - }, - "404": { - "description": "URL not found" - } - } - } - }, - "/ns/vls/{vlId}": { - "get": { - "tags": [ - "vl" - ], - "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": [ - "vl" - ], - "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" - } - } - } - } - }, - "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" - } - } - }, - "VlInfo": { - "type": "object", - "properties": { - "vlId": { - "type": "string" - }, - "vlName": { - "type": "string" - }, - "vlStatus": { - "type": "string" - } - } - }, - "DeleteVlResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - } - } - } - } -}
\ No newline at end of file diff --git a/lcm/swagger/vfc.vnfdriver.swagger.json b/lcm/swagger/vfc.vnfdriver.swagger.json deleted file mode 100644 index fc35adbd..00000000 --- a/lcm/swagger/vfc.vnfdriver.swagger.json +++ /dev/null @@ -1,1358 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VNFM Driver Development Related API", - "description": "ONAP VNFM Driver Development Related 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", - "schemes": [ - "http", - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/{vnfmtype}/v1/{vnfmid}/vnfs": { - "post": { - "tags": [ - "VNFMDriver" - ], - "summary": "vnf create&instantiate", - "description": "VNF create&instantiate Rest API should be provided by the VNFM Driver", - "operationId": "vnf_instantiate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "The value of vnfmtype should be the SVNFM driver service name", - "name": "vnfmtype", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VnfInstantiateRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/VnfInstantiateResponse" - } - } - } - } - }, - "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/scale": { - "post": { - "tags": [ - "VNFMDriver" - ], - "summary": "vnf Scale", - "description": "VNF Scale Rest API should be provided by the VNFM Driver", - "operationId": "vnf_scale", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "The value of vnfmtype should be the SVNFM driver service name", - "name": "vnfmtype", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfInstanceId should be the VNF Instantiate ID", - "name": "vnfInstanceId", - "in": "path" - }, - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VnfScaleRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/JobInfo" - } - }, - "404": { - "description": "the VNF instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/heal": { - "post": { - "tags": [ - "VNFMDriver" - ], - "summary": "vnf heal", - "description": "VNF Heal Rest API should be provided by the VNFM Driver", - "operationId": "vnf_heal", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "The value of vnfmtype should be the SVNFM driver service name", - "name": "vnfmtype", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfInstanceId should be the VNF Instantiate ID", - "name": "vnfInstanceId", - "in": "path" - }, - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VnfHealRequest" - } - } - ], - "responses": { - "201": { - "description": "", - "schema": { - "$ref": "#/definitions/JobInfo" - } - }, - "404": { - "description": "the VNF instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/terminate": { - "post": { - "tags": [ - "VNFMDriver" - ], - "summary": "terminate&delete vnf", - "description": "VNF terminate&delete Rest API should be provided by the VNFM Driver", - "operationId": "terminate_vnf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "The value of vnfmtype should be the SVNFM driver service name", - "name": "vnfmtype", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfInstanceId should be the VNF Instantiate ID", - "name": "vnfInstanceId", - "in": "path" - }, - { - "in": "body", - "name": "body", - "description": "instantiate request param", - "required": true, - "schema": { - "$ref": "#/definitions/VnfTerminateRequest" - } - } - ], - "responses": { - "204": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/JobInfo" - } - }, - "404": { - "description": "the VNF instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}": { - "get": { - "tags": [ - "VNFMDriver" - ], - "summary": "query the specified vnf info", - "description": "", - "operationId": "query_vnf", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "required": true, - "type": "string", - "description": "The value of vnfmtype should be the SVNFM driver service name", - "name": "vnfmtype", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfInstanceId should be the VNF Instantiate ID", - "name": "vnfInstanceId", - "in": "path" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VnfInfo" - } - }, - "404": { - "description": "the vnf instance id is wrong" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/nslcm/v1/ns/grantvnf": { - "post": { - "tags": [ - "NSLCM" - ], - "summary": "grantvnf", - "description": "Grant VNF, provived by the NSLCM component", - "operationId": "grantvnf", - "parameters": [ - { - "in": "body", - "name": "grantvnf", - "description": "Grant VNF Request", - "required": true, - "schema": { - "$ref": "#/definitions/GrantVNFRequest" - } - } - ], - "responses": { - "202": { - "description": "", - "schema": { - "$ref": "#/definitions/GrantVNFResponse" - } - }, - "404": { - "description": "URL not found" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/nslcm/v1/ns/{vnfmid}/vnfs/{vnfInstanceId}/Notify": { - "post": { - "tags": [ - "NSLCM" - ], - "summary": "VNF LCM Notification", - "description": "VNF LCM Notification API should be provided by NSLCM component", - "operationId": "VNF_LCM_Notification", - "parameters": [ - { - "required": true, - "type": "string", - "description": "VNFM Instance Id", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "VNF Instance Id", - "name": "vnfInstanceId", - "in": "path" - }, - { - "in": "body", - "name": "vnf Notification", - "description": "VNF LCM Notification", - "required": true, - "schema": { - "$ref": "#/definitions/VNFLCMNotification" - } - } - ], - "responses": { - "202": { - "description": "" - }, - "404": { - "description": "URL not found" - }, - "500": { - "description": "the url is invalid" - } - } - } - }, - "/{vnfmid}/jobs/{jobid}": { - "get": { - "tags": [ - "VNFMDriver" - ], - "summary": "jobstatus", - "description": "Job Infomation API should be provided by VNFM Driver", - "operationId": "get_jobstatus", - "parameters": [ - { - "required": true, - "type": "string", - "description": "job Id", - "name": "jobid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "The value of vnfmid should be the VNFM Instantiate ID", - "name": "vnfmid", - "in": "path" - }, - { - "required": true, - "type": "string", - "description": "job response message id", - "name": "responseId", - "in": "query" - } - ], - "responses": { - "202": { - "description": "", - "schema": { - "$ref": "#/definitions/JobDetailInfo" - } - } - } - } - }, - "/catalog/v1/vnfpackages/{csarId}": { - "get": { - "tags": [ - "Catalog" - ], - "summary": "query vnf package info", - "description": "query one vnf package info via vnf package csarId", - "operationId": "query_vnf_package", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "csarId", - "in": "path", - "description": "csar id of vnf package", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VnfPkgDetailInfo" - } - }, - "500": { - "description": "internal error" - } - } - } - }, - "/nslcm/v1/vnfms/{vnfmid}":{ - "get": { - "tags": [ - "NSLCM" - ], - "summary": "Query VNFM register info", - "description": "query VNFM register info", - "operationId": "query_vnfm_info", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "vnfmid", - "in": "path", - "description": "vnfm id", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VnfmInfo" - } - }, - "404": { - "description": "URL not found" - }, - "500": { - "description": "internal error" - } - } - } - }, - "/nslcm/v1/vims/{vimid}":{ - "get": { - "tags": [ - "NSLCM" - ], - "summary": "Query VIM register info", - "description": "query VIM register info", - "operationId": "query_VIM_info", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "vimid", - "in": "path", - "description": "vim id", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/VimInfo" - } - }, - "404": { - "description": "URL not found" - }, - "500": { - "description": "internal error" - } - } - } - } - }, - "definitions": { - "jobResponseInfo": { - "type": "object", - "properties": { - "status": { - "type": "string" - }, - "progress": { - "type": "string" - }, - "statusDescription": { - "type": "string" - }, - "errorCode": { - "type": "string" - }, - "responseId": { - "type": "string" - } - } - }, - "JobStatus" : { - "description": "The status of the job", - "type": "string", - "enum": [ - "started", - "processing", - "finished", - "error", - "timeout" - ] - }, - "JobDetailInfo": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - }, - "responseDescriptor": { - "type": "object", - "properties": { - "status": { - "$ref": "#/definitions/JobStatus", - "description": "The status of the job" - }, - "progress": { - "type": "string", - "description": "The progress of the job. Value between 0 and 100." - }, - "statusDescription": { - "type": "string", - "description": "The reason of the current status of the job." - }, - "errorCode": { - "type": "string" - }, - "responseId": { - "type": "string" - }, - "responseHistoryList": { - "type": "array", - "items": { - "$ref": "#/definitions/jobResponseInfo" - } - } - } - } - } - }, - "ChangeType" : { - "description": "The type of the change", - "type": "string", - "enum": [ - "VDU" - ] - }, - "ResourceChange" : { - "type": "object", - "properties": { - "type": { - "$ref": "#/definitions/ChangeType", - "description": "The type of the resource." - }, - "resourceDefinitionId": { - "description": "The identifier of the resource within the grant request.", - "type": "string" - }, - "vdu": { - "description": "The identifier of the VDU.", - "type": "string" - } - } - }, - "OperationType" : { - "description": "The type of operation", - "type": "string", - "enum": [ - "Terminal", - "Instantiate", - "Scalein", - "Scaleout", - "Scaledown", - "Scaleup", - "Heal" - ] - }, - "GrantVNFRequest": { - "type": "object", - "properties": { - "vnfInstanceId": { - "type": "string" - }, - "vnfDescriptorId": { - "type": "string" - }, - "lifecycleOperation": { - "description" : "The type of the operation.", - "$ref": "#/definitions/OperationType" - }, - "jobId": { - "type": "string" - }, - "addResource": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceChange" - } - }, - "removeResource": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceChange" - } - }, - "additionalParam": { - "type": "object", - "description": "Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId" - } - } - }, - "GrantVNFResponse": { - "type": "object", - "properties": { - "vim": { - "type": "object", - "properties": { - "vimid": { - "type": "string" - }, - "accessinfo": { - "type": "object", - "properties": { - "tenant": { - "type": "string", - "description": "The name of the tenant" - } - } - } - } - } - } - }, - "VnfNotificationType": { - "description": "The type of the notification", - "type": "string", - "enum": [ - "added", - "removed", - "modified" - ] - }, - "AffectedVnfc": { - "type": "object", - "properties": { - "vnfcInstanceId": { - "type": "string", - "description": "Identifier of the VNFC instance" - }, - "vduId": { - "type": "string", - "description": "Identifier of the VDU in the VNFD" - }, - "changeType": { - "$ref": "#/definitions/VnfNotificationType", - "description": "The type of the change" - }, - "vimId": { - "type": "string", - "description": "Identifier of vim" - }, - "vmId": { - "type": "string", - "description": "Identifier of virtual machine" - }, - "vmName": { - "type": "string", - "description": "Name of virtual machine" - } - } - }, - "AffectedVirtualLinkType": { - "description": "The type of the affected virtual link", - "type": "string", - "enum": [ - "network", - "port" - ] - }, - "AffectedVirtualLink":{ - "type": "object", - "properties": { - "vlInstanceId": { - "type": "string", - "description": "Identifier of the VL instance" - }, - "vldId": { - "type": "string", - "description": "Identifier of the VLD in the VNFD" - }, - "changeType": { - "$ref": "#/definitions/VnfNotificationType", - "description": "The type of the change" - }, - "networkResource": { - "type": "object", - "description": "network Resource", - "properties": { - "resourceType": { - "$ref": "#/definitions/AffectedVirtualLinkType", - "description": "Must be network" - }, - "resourceId": { - "type": "string", - "description": "Identifier of the resource in the scope of the VIM" - }, - "resourceName": { - "type": "string", - "description": "Name of the resource in the scope of the VIM" - } - } - } - } - }, - "VnfCpNotificationType": { - "description": "The type of the notification for connection points", - "type": "string", - "enum": [ - "added", - "removed", - "changed" - ] - }, - "AffectedCp": { - "type": "object", - "properties": { - "virtualLinkInstanceId": { - "type": "string", - "description": "Identifier of the VL instance" - }, - "cpInstanceId": { - "type": "string", - "description": "Identifier of the connection point" - }, - "cpdId": { - "type": "string", - "description": "Identifier of the connection point in the VNFD" - }, - "ownerType": { - "type": "string", - "description": "The type of the owner." - }, - "ownerId": { - "type": "string", - "description": "Identifier of the owner. Mandatory if ownerType is specified." - }, - "changeType": { - "$ref": "#/definitions/VnfCpNotificationType", - "description": "The type of the change" - }, - "portResource": { - "type": "object", - "description": "port Resource", - "properties": { - "vimId": { - "type": "string", - "description": "Identifier of the VIM" - }, - "resourceId": { - "type": "string", - "description": "Identifier of the resource in the scope of the VIM" - }, - "resourceName": { - "type": "string", - "description": "Resource name in the vim" - }, - "tenant": { - "type": "string", - "description": "The identifier of the tenant" - }, - "ipAddress": { - "type": "string", - "description": "The IP address of the port" - }, - "macAddress": { - "type": "string", - "description": "The MAC address of the port" - }, - "instId": { - "type": "string", - "description": "The instance id of the server to which the port is attached to" - } - } - } - } - }, - "AffectedVirtualStorage" : { - "type": "object" - }, - "VnfLcmNotificationStatus" : { - "description": "The status of the operation", - "type": "string", - "enum": [ - "result", - "start" - ] - }, - "VNFLCMNotification": { - "type": "object", - "properties": { - "status": { - "description" : "The status of the operation that triggered the LCN.", - "$ref": "#/definitions/VnfLcmNotificationStatus" - }, - "vnfInstanceId": { - "type": "string" - }, - "operation": { - "description" : "The type of the operation that tiggered the LCN.", - "$ref": "#/definitions/OperationType" - }, - "jobId": { - "description" : "The identifier fo the job that triggered the LCN.", - "type": "string" - }, - "affectedVnfc": { - "type": "array", - "description": "The affected VNFCs", - "items": { - "$ref": "#/definitions/AffectedVnfc" - } - }, - "affectedCp": { - "type": "array", - "description": "The affected Connected Points", - "items": { - "$ref": "#/definitions/AffectedCp" - } - }, - "affectedVl": { - "type": "array", - "description": "The affected virtual links", - "items": { - "$ref": "#/definitions/AffectedVirtualLink" - } - }, - "affectedVirtualStorage": { - "type": "array", - "description": "The affected virtual storages. (Not supported)", - "items": { - "$ref": "#/definitions/AffectedVirtualStorage" - } - } - } - }, - "VnfInstantiateRequest": { - "type": "object", - "properties": { - "vnfInstanceName": { - "type": "string" - }, - "vnfPackageId": { - "type": "string" - }, - "vnfDescriptorId": { - "type": "string" - }, - "vnfInstanceDescription": { - "type": "string" - }, - "extVirtualLink": { - "type": "array", - "items": { - "$ref": "#/definitions/extVirtualLinkInfo" - } - }, - "additionalParam": { - "type": "object", - "description": "Additional parameters passed to the VNFM. The vimId may be passed in the additional parameter section by the NFVO to VNFM." - } - } - }, - "extVirtualLinkInfo":{ - "type": "object", - "properties": { - "resourceSubnetId": { - "type": "string", - "description": "The provider id of the subnet" - }, - "vlInstanceId": { - "type": "string", - "description" : "The identifier of the virtual link" - }, - "resourceId": { - "type": "string", - "description": "The provider id of the network" - }, - "cpdId": { - "type": "string", - "description": "The identifier of the connection point descriptor" - }, - "vim": { - "type": "object", - "properties": { - "vimid": { - "type": "string", - "description": "The identifier of the VIM" - } - } - } - } - }, - "VnfInstantiateResponse": { - "type": "object", - "properties": { - "vnfInstanceId": { - "type": "string" - }, - "jobId": { - "type": "string" - } - } - }, - "ScaleDirection" : { - "description": "The direction of the scaling", - "type": "string", - "enum": [ - "SCALE_IN", - "SCALE_OUT" - ] - }, - "VnfScaleRequest":{ - "type": "object", - "properties": { - "type": { - "description" : "The direction of the scaling.", - "$ref": "#/definitions/ScaleDirection" - }, - "aspectId":{ - "type": "string", - "description": "Identifies the aspect of the VNF that is requested to be scaled" - }, - "numberOfSteps": { - "type": "string", - "description": "Number of scaling steps to be executed as part of this ScaleVnf operation. It shall be a positive number" - }, - "additionalParam":{ - "type": "object", - "description": "Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled" - } - } - }, - "VnfHealRequest":{ - "type": "object", - "properties": { - "action": { - "type": "string" - }, - "affectedvm": { - "type": "object", - "properties": { - "vimid":{ - "type": "string" - }, - "vduid": { - "type": "string" - }, - "vmname":{ - "type": "string" - } - } - } - } - }, - "VnfTerminationType": { - "description": "The type of the termination.", - "type": "string", - "enum": [ - "graceful", - "forceful" - ] - }, - "VnfTerminateRequest":{ - "type": "object", - "properties": { - "terminationType": { - "description" : "The type of the termination", - "$ref": "#/definitions/VnfTerminationType" - }, - "gracefulTerminationTimeout": { - "description": "The time interval(second) to wait for the VNF to be taken out of service during graceful termination.", - "type": "string" - } - } - }, - "JobInfo": { - "type": "object", - "properties": { - "jobId": { - "type": "string" - } - } - }, - "VnfInfo": { - "type": "object", - "properties": { - "vnfInstanceId": { - "type": "string" - }, - "vnfInstanceName": { - "type": "string" - }, - "vnfInstanceDescription": { - "type": "string" - }, - "vnfdId": { - "type": "string" - }, - "vnfPackageId": { - "type": "string" - }, - "version": { - "type": "string" - }, - "vnfProvider": { - "type": "string" - }, - "vnfType": { - "type": "string" - }, - "vnfStatus": { - "type": "string" - } - } - }, - "vimInfo": { - "type": "object", - "properties": { - "vimInfoId": { - "type": "string" - }, - "vimId": { - "type": "string" - }, - "interfaceInfo": { - "type": "object", - "properties": { - "vimType": { - "type": "string", - "description": "The vim Type value wil be openstack" - }, - "apiVersion": { - "type": "string", - "description": "The api Version Type value will be " - }, - "protocolType": { - "type": "string", - "description": "The protocol Type value will be http or https" - } - } - }, - "accessInfo": { - "type": "object", - "properties": { - "tenant": { - "type": "string", - "description": "Tenant Name of tenant" - }, - "username": { - "type": "string", - "description": "Username for login" - }, - "password": { - "type": "string", - "description": "Password of login user" - } - } - }, - "interfaceEndpoint": { - "type": "string", - "description": "Information about the interface endpoint. It is a URL" - } - } - }, - "VnfPkgDetailInfo": { - "type": "object", - "properties": { - "csarId": { - "type": "string", - "description": "vnf package id, UUID" - }, - "packageInfo": { - "$ref": "#/definitions/VnfPkgInfo" - }, - "imageInfo": { - "$ref": "#/definitions/VnfPkgImgListInfo" - }, - "vnfInstanceInfo": { - "$ref": "#/definitions/VnfInstListInfo" - } - } - }, - "VnfPkgInfo": { - "type": "object", - "description": "vnf package infomation", - "properties": { - "vnfPackageId": { - "type": "string", - "description": "vnf package id (csarId)" - }, - "csarName": { - "type": "string", - "description": "The name of the csar" - }, - "vnfdId": { - "type": "string", - "description": "VNF descriptor ID" - }, - "vnfdProvider": { - "type": "string", - "description": "VNF descriptor vendor ID" - }, - "vnfdModel": { - "type": "string", - "description": "The model of the VNF (JSON) encoded to string" - }, - "vnfdVersion": { - "type": "string", - "description": "VNF descriptor version" - }, - "vnfVersion": { - "type": "string", - "description": "VNF Software version" - }, - "downloadUrl":{ - "type": "string", - "description": "The URL from which the VNF package can be downloaded" - } - } - }, - "VnfInstListInfo": { - "type": "array", - "items": { - "$ref": "#/definitions/VnfInstInfo" - } - }, - "VnfInstInfo": { - "type": "object", - "properties": { - "vnfInstanceId": { - "type": "string", - "description": "VNF instance ID" - }, - "vnfInstanceName": { - "type": "string", - "description": "VNF instance name" - } - } - }, - "VnfPkgImgListInfo": { - "type": "array", - "items": { - "$ref": "#/definitions/VnfPkgImgInfo" - } - }, - "VnfPkgImgInfo": { - "type": "object", - "properties": { - "fileName": { - "type": "string", - "description": "image file name" - }, - "imageUrl": { - "type": "string", - "description": "image file path in the csar or image url in external repository" - } - } - }, - "VnfmInfo": { - "type": "object", - "properties": { - "vnfmId": { - "type": "string", - "description": "vnfm Id" - }, - "name": { - "type": "string", - "description": "vnfm name" - }, - "type": { - "type": "string", - "description": "vnfm type" - }, - "url": { - "type": "string", - "description": "vnfm url" - }, - "userName": { - "type": "string", - "description": "vnfm login username" - }, - "password": { - "type": "string", - "description": "vnfm login password" - }, - "vimId": { - "type": "string", - "description": "vim Id" - }, - "vendor": { - "type": "string", - "description": "vendor name" - }, - "version": { - "type": "string", - "description": "vnfm version" - }, - "description": { - "type": "string", - "description": "vnfm description" - }, - "certificateUrl": { - "type": "string", - "description": "vnfm certificate Url" - }, - "createTime": { - "type": "string", - "description": "vnfm info createTime" - } - } - }, - "VimInfo": { - "type": "object", - "properties": { - "vimId": { - "type": "string", - "description": "vim Id" - }, - "name": { - "type": "string", - "description": "vim name" - }, - "type": { - "type": "string", - "description": "vim type" - }, - "url": { - "type": "string", - "description": "vim url" - }, - "userName": { - "type": "string", - "description": "vim login username" - }, - "password": { - "type": "string", - "description": "vim login password" - }, - "vendor": { - "type": "string", - "description": "vendor name" - }, - "version": { - "type": "string", - "description": "vim version" - }, - "description": { - "type": "string", - "description": "vim description" - }, - "createTime": { - "type": "string", - "description": "vim info createTime" - }, - "sslCacert": { - "type": "string", - "description": "The collection of trusted certificates towards the VIM connection." - }, - "sslInsecure": { - "type": "string", - "description": "Whether to verify VIM's certificate" - }, - "status": { - "type": "string", - "description": "The status of external system" - } - } - } - } -} diff --git a/lcm/swagger/vfc.vnflcm.swagger.json b/lcm/swagger/vfc.vnflcm.swagger.json deleted file mode 100644 index 2481704e..00000000 --- a/lcm/swagger/vfc.vnflcm.swagger.json +++ /dev/null @@ -1,235 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "1.0.0", - "title": "ONAP VFC Service Internal Rest API" - }, - "basePath": "/api/nslcm/v1", - "paths": { - "/ns/vnfs": { - "post": { - "tags": [ - "vnf" - ], - "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" - } - }, - "404": { - "description": "URL not found" - } - } - } - }, - "/ns/vnfs/{vnfInstId}": { - "get": { - "tags": [ - "vnf" - ], - "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": [ - "vnf" - ], - "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" - } - } - } - } - }, - "definitions": { - "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" - } - } - }, - - "VnfInfo": { - "type": "object", - "properties": { - "vnfInstId": { - "type": "string" - }, - "vnfName": { - "type": "string" - }, - "vnfStatus": { - "type": "string" - } - } - }, - "DeleteResponse": { - "type": "object", - "properties": { - "result": { - "type": "integer", - "enum": [ - 0, - 1 - ] - }, - "detail": { - "type": "string" - } - } - } - } -}
\ No newline at end of file diff --git a/lcm/swagger/views.py b/lcm/swagger/views.py deleted file mode 100644 index e78ecead..00000000 --- a/lcm/swagger/views.py +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2016-2017 ZTE Corporation. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -import json -import logging -import os - -from rest_framework.response import Response -from rest_framework.views import APIView - -logger = logging.getLogger(__name__) - - -class SwaggerJsonView(APIView): - - def get(self, request): - json_file = os.path.join(os.path.dirname(__file__), 'vfc.nslcm.swagger.json') - f = open(json_file) - json_data = json.JSONDecoder().decode(f.read()) - f.close() - - json_file = os.path.join(os.path.dirname(__file__), 'vfc.vnflcm.swagger.json') - f = open(json_file) - json_data_temp = json.JSONDecoder().decode(f.read()) - f.close() - - json_data["paths"].update(json_data_temp["paths"]) - json_data["definitions"].update(json_data_temp["definitions"]) - - json_file = os.path.join(os.path.dirname(__file__), 'vfc.vllcm.swagger.json') - f = open(json_file) - json_data_temp = json.JSONDecoder().decode(f.read()) - f.close() - - json_data["paths"].update(json_data_temp["paths"]) - json_data["definitions"].update(json_data_temp["definitions"]) - - json_file = os.path.join(os.path.dirname(__file__), 'vfc.sfclcm.swagger.json') - f = open(json_file) - json_data_temp = json.JSONDecoder().decode(f.read()) - f.close() - - json_data["paths"].update(json_data_temp["paths"]) - json_data["definitions"].update(json_data_temp["definitions"]) - - json_file = os.path.join(os.path.dirname(__file__), 'vfc.db.swagger.json') - f = open(json_file) - json_data_temp = json.JSONDecoder().decode(f.read()) - f.close() - - json_data["paths"].update(json_data_temp["paths"]) - json_data["definitions"].update(json_data_temp["definitions"]) - - json_file = os.path.join(os.path.dirname(__file__), 'vfc.others.swagger.json') - f = open(json_file) - json_data_temp = json.JSONDecoder().decode(f.read()) - f.close() - - json_data_jobtemp = json_data["paths"]["/jobs/{jobId}"] - json_data["paths"].update(json_data_temp["paths"]) - json_data["paths"]["/jobs/{jobId}"].update(json_data_jobtemp) - json_data["definitions"].update(json_data_temp["definitions"]) - return Response(json_data) |