From 9ddf5d56726e400bbf6955c3620706916057e6d8 Mon Sep 17 00:00:00 2001 From: Chris Donley Date: Wed, 30 May 2018 13:33:08 -0700 Subject: Fix typos in VNFSDK docs Issue-ID: VNFSDK-270 Change-Id: Ia8b1fcf8f32fe2b15dd4facacee206ccff8b8c80 Signed-off-by: Chris Donley --- docs/files/VESEventRegistration.rst | 37 ++-- docs/files/marketplace-overview.rst | 4 +- docs/files/swagger.json | 343 ------------------------------------ docs/files/swagger.yaml | 235 ------------------------ docs/index.rst | 4 +- docs/swagger.json | 343 ++++++++++++++++++++++++++++++++++++ docs/swagger.yaml | 235 ++++++++++++++++++++++++ 7 files changed, 599 insertions(+), 602 deletions(-) delete mode 100644 docs/files/swagger.json delete mode 100644 docs/files/swagger.yaml create mode 100644 docs/swagger.json create mode 100644 docs/swagger.yaml (limited to 'docs') diff --git a/docs/files/VESEventRegistration.rst b/docs/files/VESEventRegistration.rst index 4104a1f..a3fe93d 100644 --- a/docs/files/VESEventRegistration.rst +++ b/docs/files/VESEventRegistration.rst @@ -164,6 +164,7 @@ YAML files consist of a series of YAML documents delimited by ‘---‘ and ‘…’ for example: :: + --- # Event Registration for eventName ‘name1’ @@ -480,6 +481,7 @@ based on the named ‘conditions’ asserted in action qualifiers in the preceding event definitions. For example: :: + --- # Event Registration for eventName ‘name1’ @@ -531,17 +533,13 @@ The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a colon and square brackets. Each rule is then defined within the square brackets. Commas are used to separate rules. -Each rule is expressed as follows: - -rule: { - -trigger: *logical expression in terms of conditions*, +Each rule is expressed as follows:: -microservices: [ *microservice1, microservice2, microservice3…* ] - -alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ], - -} + rule: { + trigger: *logical expression in terms of conditions*, + microservices: [ *microservice1, microservice2, microservice3…* ] + alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ], + } Notes: @@ -573,9 +571,7 @@ Example logical expression: Where A, B, C and D are named conditions expressed earlier in the YAML file. -Example rules definition: - -:: +Example rules definition:: rules: [ rule: { @@ -603,6 +599,7 @@ with a colon and curly braces. The time based rule is placed in the curly braces as follows: :: + trigger: B:{3 times in 300 seconds} This means that if condition B occurs 3 (or more) times in 300 seconds @@ -611,6 +608,7 @@ This means that if condition B occurs 3 (or more) times in 300 seconds More complex triggers can be created as follows: :: + trigger: B:{3 times in 300 seconds} \|\| (C & D:{2 times in 600 seconds}), This means that the trigger fires if condition B occurs 3 (or more) @@ -665,7 +663,7 @@ make it easier to read. }} }} - ... +:: --- # registration for clearing Fault\_vMrf\_alarm003Cleared @@ -701,7 +699,7 @@ make it easier to read. }} }} - ... +:: --- # registration for Heartbeat_vMRF @@ -732,7 +730,7 @@ make it easier to read. }} }} - ... +:: --- # registration for Mfvs\_vMRF @@ -1001,7 +999,7 @@ make it easier to read. }} }} - ... +:: --- # registration for Syslog\_vMRF @@ -1038,7 +1036,7 @@ make it easier to read. }} }} - ... +:: --- #Rules @@ -1054,6 +1052,5 @@ make it easier to read. microservices: [scaleIn] } ] - - ... + diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst index df1dde0..8927ea1 100644 --- a/docs/files/marketplace-overview.rst +++ b/docs/files/marketplace-overview.rst @@ -3,7 +3,7 @@ .. Copyright 2017 Huawei Technologies Co., Ltd. VNF SDK Marketplace -=================== +------------------- VNF SDK provides a reference implementation "marketplace" to help vendors validate and manage VNF packages. It also supports the operator to onboard VNF @@ -12,7 +12,7 @@ or :download:`json ` :download:`yaml ` |image0| -.. |image0| image:: vnfsdk-marketplace.png +.. |image0| image:: files/vnfsdk-marketplace.png :height: 600px :width: 800px diff --git a/docs/files/swagger.json b/docs/files/swagger.json deleted file mode 100644 index 04a227b..0000000 --- a/docs/files/swagger.json +++ /dev/null @@ -1,343 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "These are the APIs for the ONAP VNFSDK Marketplace. VNFSDK helps to package and validate VNFs for onboarding into ONAP. You can find out more about VNFSDK at [http://onap.readthedocs.io](http://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html).", - "version": "1.0.0", - "title": "ONAP VNFSDK", - "contact": { - "email": "onap-discuss@lists.onap.org" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - } - }, - "host": "onap.readthedocs.io", - "basePath": "/onapapi/marketplace/v1", - "tags": [ - { - "name": "csars", - "description": "VNF CSAR information", - "externalDocs": { - "description": "Find out more", - "url": "http://wiki.onap.org" - } - } - ], - "schemes": [ - "http" - ], - "paths": { - "/csars": { - "get": { - "summary": "Query VNF Package by conditions", - "description": "Query VNF package", - "operationId": "queryVnf", - "produces": [ - "application/json" - ], - "tags": [ - "VNF package" - ], - "parameters": [ - { - "name": "conditions", - "in": "query", - "description": "Conditions that need to be considered for filter", - "required": true, - "type": "array", - "items": { - "type": "string" - }, - "collectionFormat": "multi" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/Csars" - } - } - }, - "400": { - "description": "Invalid status value" - } - } - }, - "post": { - "summary": "Upload/Re-Upload VNF Package", - "description": "", - "operationId": "addVnf", - "consumes": [ - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "tags": [ - "VNF package" - ], - "parameters": [ - { - "in": "body", - "name": "body", - "description": "VNF objects to add to the Marketplace", - "required": true, - "schema": { - "$ref": "#/definitions/Csars" - } - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ApiResponse" - } - } - } - } - }, - "/csars/{csarId}": { - "get": { - "tags": [ - "csarId" - ], - "summary": "Find vnf by CSAR ID", - "description": "Returns a single vnf", - "operationId": "getVnfByCsarId", - "produces": [ - "application/xml", - "application/json" - ], - "parameters": [ - { - "name": "csarId", - "in": "path", - "description": "CSAR ID of VNF to return", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Csars" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "VNF not found" - } - } - }, - "post": { - "tags": [ - "csarId" - ], - "summary": "Updates a VNF in the Marketplace with form data", - "description": "", - "operationId": "updateCsar", - "consumes": [ - "application/x-www-form-urlencoded" - ], - "produces": [ - "application/xml", - "application/json" - ], - "parameters": [ - { - "name": "csarId", - "in": "path", - "description": "CSAR ID of VNF that needs to be updated", - "required": true, - "type": "string" - }, - { - "name": "name", - "in": "formData", - "description": "Updated name of the VNF", - "required": false, - "type": "string" - }, - { - "name": "fileNamee", - "in": "formData", - "description": "Updated filename of the csar", - "required": false, - "type": "string" - } - ], - "responses": { - "405": { - "description": "Invalid input" - } - } - }, - "delete": { - "tags": [ - "csarId" - ], - "summary": "Deletes a VNF", - "description": "", - "operationId": "deleteVnf", - "produces": [ - "application/xml", - "application/json" - ], - "parameters": [ - { - "name": "csarId", - "in": "path", - "description": "VNF CSAR ID to delete", - "required": true, - "type": "string" - } - ], - "responses": { - "400": { - "description": "Invalid ID supplied" - } - } - } - }, - "/csars/{csarId}/files": { - "get": { - "tags": [ - "csarId" - ], - "summary": "Download vnf", - "description": "Download a single vnf", - "operationId": "downloadVnf", - "produces": [ - "application/xml", - "application/json" - ], - "parameters": [ - { - "name": "csarId", - "in": "path", - "description": "CSAR ID of VNF to return", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Csars" - } - }, - "400": { - "description": "Invalid ID supplied" - }, - "404": { - "description": "VNF not found" - } - } - } - } - }, - "definitions": { - "Csars": { - "type": "object", - "required": [ - "csarId" - ], - "properties": { - "type": { - "type": "string", - "example": "CSAR" - }, - "name": { - "type": "string", - "example": "NanocellGateway" - }, - "fileName": { - "type": "string" - }, - "creationDate": { - "type": "string" - }, - "modificationDate": { - "type": "string" - }, - "readDate": { - "type": "string" - }, - "size": { - "type": "string", - "example": "37 MB" - }, - "provider": { - "type": "string", - "example": "XYZ" - }, - "version": { - "type": "string", - "example": "v1.0.0" - }, - "createTime": { - "type": "string" - }, - "modifyTime": { - "type": "string" - }, - "downloadUri": { - "type": "string", - "example": "http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0" - }, - "shortdesc": { - "type": "string", - "example": "XYZ Nanocell Gateway VNF" - }, - "details": { - "type": "string" - }, - "csarId": { - "type": "string", - "example": "78ede6f3-66cc-46ab-b748-38a6c010d272" - }, - "parameters": { - "type": "array", - "xml": { - "name": "parameters", - "wrapped": true - }, - "items": { - "type": "string" - } - } - }, - "xml": { - "name": "Csars" - } - }, - "ApiResponse": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "type": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - }, - "externalDocs": { - "description": "Find out more about VNFSDK", - "url": "https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html" - } -} \ No newline at end of file diff --git a/docs/files/swagger.yaml b/docs/files/swagger.yaml deleted file mode 100644 index 79edd40..0000000 --- a/docs/files/swagger.yaml +++ /dev/null @@ -1,235 +0,0 @@ -swagger: "2.0" -info: - description: "These are the APIs for the ONAP VNFSDK Marketplace. VNFSDK helps to package and validate VNFs for onboarding into ONAP. You can find out more about VNFSDK at [http://onap.readthedocs.io](http://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html)." - version: "1.0.0" - title: "ONAP VNFSDK" - contact: - email: "onap-discuss@lists.onap.org" - license: - name: "Apache 2.0" - url: "http://www.apache.org/licenses/LICENSE-2.0.html" -host: "onap.readthedocs.io" -basePath: "/onapapi/marketplace/v1" -tags: -- name: "csars" - description: "VNF CSAR information" - externalDocs: - description: "Find out more" - url: "http://wiki.onap.org" -schemes: -- "http" -paths: - /csars: - get: - summary: "Query VNF Package by conditions" - description: "Query VNF package" - operationId: "queryVnf" - produces: - - "application/json" - tags: - - "VNF package" - parameters: - - name: "conditions" - in: "query" - description: "Conditions that need to be considered for filter" - required: true - type: "array" - items: - type: "string" - collectionFormat: "multi" - responses: - 200: - description: "successful operation" - schema: - type: "array" - items: - $ref: "#/definitions/Csars" - 400: - description: "Invalid status value" - post: - summary: "Upload/Re-Upload VNF Package" - description: "" - operationId: "addVnf" - consumes: - - "multipart/form-data" - produces: - - "application/json" - tags: - - "VNF package" - parameters: - - in: "body" - name: "body" - description: "VNF objects to add to the Marketplace" - required: true - schema: - $ref: "#/definitions/Csars" - responses: - 200: - description: "successful operation" - schema: - $ref: "#/definitions/ApiResponse" - /csars/{csarId}: - get: - tags: - - "csarId" - summary: "Find vnf by CSAR ID" - description: "Returns a single vnf" - operationId: "getVnfByCsarId" - produces: - - "application/xml" - - "application/json" - parameters: - - name: "csarId" - in: "path" - description: "CSAR ID of VNF to return" - required: true - type: "string" - responses: - 200: - description: "successful operation" - schema: - $ref: "#/definitions/Csars" - 400: - description: "Invalid ID supplied" - 404: - description: "VNF not found" - post: - tags: - - "csarId" - summary: "Updates a VNF in the Marketplace with form data" - description: "" - operationId: "updateCsar" - consumes: - - "application/x-www-form-urlencoded" - produces: - - "application/xml" - - "application/json" - parameters: - - name: "csarId" - in: "path" - description: "CSAR ID of VNF that needs to be updated" - required: true - type: "string" - - name: "name" - in: "formData" - description: "Updated name of the VNF" - required: false - type: "string" - - name: "fileNamee" - in: "formData" - description: "Updated filename of the csar" - required: false - type: "string" - responses: - 405: - description: "Invalid input" - delete: - tags: - - "csarId" - summary: "Deletes a VNF" - description: "" - operationId: "deleteVnf" - produces: - - "application/xml" - - "application/json" - parameters: - - name: "csarId" - in: "path" - description: "VNF CSAR ID to delete" - required: true - type: "string" - responses: - 400: - description: "Invalid ID supplied" - /csars/{csarId}/files: - get: - tags: - - "csarId" - summary: "Download vnf" - description: "Download a single vnf" - operationId: "downloadVnf" - produces: - - "application/xml" - - "application/json" - parameters: - - name: "csarId" - in: "path" - description: "CSAR ID of VNF to return" - required: true - type: "string" - responses: - 200: - description: "successful operation" - schema: - $ref: "#/definitions/Csars" - 400: - description: "Invalid ID supplied" - 404: - description: "VNF not found" - -definitions: - Csars: - type: "object" - required: - - "csarId" - properties: - type: - type: "string" - example: "CSAR" - name: - type: "string" - example: "NanocellGateway" - fileName: - type: "string" - creationDate: - type: "string" - modificationDate: - type: "string" - readDate: - type: "string" - size: - type: "string" - example: "37 MB" - provider: - type: "string" - example: "XYZ" - version: - type: "string" - example: "v1.0.0" - createTime: - type: "string" - modifyTime: - type: "string" - downloadUri: - type: "string" - example: "http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0" - shortdesc: - type: "string" - example: "XYZ Nanocell Gateway VNF" - details: - type: "string" - csarId: - type: "string" - example: "78ede6f3-66cc-46ab-b748-38a6c010d272" - parameters: - type: "array" - xml: - name: "parameters" - wrapped: true - items: - type: "string" - xml: - name: "Csars" - ApiResponse: - type: "object" - properties: - code: - type: "integer" - format: "int32" - type: - type: "string" - message: - type: "string" -externalDocs: - description: "Find out more about VNFSDK" - url: "https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html" \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index af04833..2d77e38 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,7 +46,7 @@ persisted, along with the product executables and data, using TOSCA CSAR files. files/*blueprints VNF SDK Marketplace -------------------- +=================== .. include:: files/marketplace-overview.rst @@ -82,7 +82,7 @@ content. The following tools are included... User Guides ------------ +=========== VNF Package Tools User Guide ---------------------------- diff --git a/docs/swagger.json b/docs/swagger.json new file mode 100644 index 0000000..04a227b --- /dev/null +++ b/docs/swagger.json @@ -0,0 +1,343 @@ +{ + "swagger": "2.0", + "info": { + "description": "These are the APIs for the ONAP VNFSDK Marketplace. VNFSDK helps to package and validate VNFs for onboarding into ONAP. You can find out more about VNFSDK at [http://onap.readthedocs.io](http://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html).", + "version": "1.0.0", + "title": "ONAP VNFSDK", + "contact": { + "email": "onap-discuss@lists.onap.org" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "host": "onap.readthedocs.io", + "basePath": "/onapapi/marketplace/v1", + "tags": [ + { + "name": "csars", + "description": "VNF CSAR information", + "externalDocs": { + "description": "Find out more", + "url": "http://wiki.onap.org" + } + } + ], + "schemes": [ + "http" + ], + "paths": { + "/csars": { + "get": { + "summary": "Query VNF Package by conditions", + "description": "Query VNF package", + "operationId": "queryVnf", + "produces": [ + "application/json" + ], + "tags": [ + "VNF package" + ], + "parameters": [ + { + "name": "conditions", + "in": "query", + "description": "Conditions that need to be considered for filter", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Csars" + } + } + }, + "400": { + "description": "Invalid status value" + } + } + }, + "post": { + "summary": "Upload/Re-Upload VNF Package", + "description": "", + "operationId": "addVnf", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "tags": [ + "VNF package" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "VNF objects to add to the Marketplace", + "required": true, + "schema": { + "$ref": "#/definitions/Csars" + } + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ApiResponse" + } + } + } + } + }, + "/csars/{csarId}": { + "get": { + "tags": [ + "csarId" + ], + "summary": "Find vnf by CSAR ID", + "description": "Returns a single vnf", + "operationId": "getVnfByCsarId", + "produces": [ + "application/xml", + "application/json" + ], + "parameters": [ + { + "name": "csarId", + "in": "path", + "description": "CSAR ID of VNF to return", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Csars" + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "VNF not found" + } + } + }, + "post": { + "tags": [ + "csarId" + ], + "summary": "Updates a VNF in the Marketplace with form data", + "description": "", + "operationId": "updateCsar", + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/xml", + "application/json" + ], + "parameters": [ + { + "name": "csarId", + "in": "path", + "description": "CSAR ID of VNF that needs to be updated", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "formData", + "description": "Updated name of the VNF", + "required": false, + "type": "string" + }, + { + "name": "fileNamee", + "in": "formData", + "description": "Updated filename of the csar", + "required": false, + "type": "string" + } + ], + "responses": { + "405": { + "description": "Invalid input" + } + } + }, + "delete": { + "tags": [ + "csarId" + ], + "summary": "Deletes a VNF", + "description": "", + "operationId": "deleteVnf", + "produces": [ + "application/xml", + "application/json" + ], + "parameters": [ + { + "name": "csarId", + "in": "path", + "description": "VNF CSAR ID to delete", + "required": true, + "type": "string" + } + ], + "responses": { + "400": { + "description": "Invalid ID supplied" + } + } + } + }, + "/csars/{csarId}/files": { + "get": { + "tags": [ + "csarId" + ], + "summary": "Download vnf", + "description": "Download a single vnf", + "operationId": "downloadVnf", + "produces": [ + "application/xml", + "application/json" + ], + "parameters": [ + { + "name": "csarId", + "in": "path", + "description": "CSAR ID of VNF to return", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Csars" + } + }, + "400": { + "description": "Invalid ID supplied" + }, + "404": { + "description": "VNF not found" + } + } + } + } + }, + "definitions": { + "Csars": { + "type": "object", + "required": [ + "csarId" + ], + "properties": { + "type": { + "type": "string", + "example": "CSAR" + }, + "name": { + "type": "string", + "example": "NanocellGateway" + }, + "fileName": { + "type": "string" + }, + "creationDate": { + "type": "string" + }, + "modificationDate": { + "type": "string" + }, + "readDate": { + "type": "string" + }, + "size": { + "type": "string", + "example": "37 MB" + }, + "provider": { + "type": "string", + "example": "XYZ" + }, + "version": { + "type": "string", + "example": "v1.0.0" + }, + "createTime": { + "type": "string" + }, + "modifyTime": { + "type": "string" + }, + "downloadUri": { + "type": "string", + "example": "http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0" + }, + "shortdesc": { + "type": "string", + "example": "XYZ Nanocell Gateway VNF" + }, + "details": { + "type": "string" + }, + "csarId": { + "type": "string", + "example": "78ede6f3-66cc-46ab-b748-38a6c010d272" + }, + "parameters": { + "type": "array", + "xml": { + "name": "parameters", + "wrapped": true + }, + "items": { + "type": "string" + } + } + }, + "xml": { + "name": "Csars" + } + }, + "ApiResponse": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32" + }, + "type": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + }, + "externalDocs": { + "description": "Find out more about VNFSDK", + "url": "https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html" + } +} \ No newline at end of file diff --git a/docs/swagger.yaml b/docs/swagger.yaml new file mode 100644 index 0000000..79edd40 --- /dev/null +++ b/docs/swagger.yaml @@ -0,0 +1,235 @@ +swagger: "2.0" +info: + description: "These are the APIs for the ONAP VNFSDK Marketplace. VNFSDK helps to package and validate VNFs for onboarding into ONAP. You can find out more about VNFSDK at [http://onap.readthedocs.io](http://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/files/vnfsdk-apis.html)." + version: "1.0.0" + title: "ONAP VNFSDK" + contact: + email: "onap-discuss@lists.onap.org" + license: + name: "Apache 2.0" + url: "http://www.apache.org/licenses/LICENSE-2.0.html" +host: "onap.readthedocs.io" +basePath: "/onapapi/marketplace/v1" +tags: +- name: "csars" + description: "VNF CSAR information" + externalDocs: + description: "Find out more" + url: "http://wiki.onap.org" +schemes: +- "http" +paths: + /csars: + get: + summary: "Query VNF Package by conditions" + description: "Query VNF package" + operationId: "queryVnf" + produces: + - "application/json" + tags: + - "VNF package" + parameters: + - name: "conditions" + in: "query" + description: "Conditions that need to be considered for filter" + required: true + type: "array" + items: + type: "string" + collectionFormat: "multi" + responses: + 200: + description: "successful operation" + schema: + type: "array" + items: + $ref: "#/definitions/Csars" + 400: + description: "Invalid status value" + post: + summary: "Upload/Re-Upload VNF Package" + description: "" + operationId: "addVnf" + consumes: + - "multipart/form-data" + produces: + - "application/json" + tags: + - "VNF package" + parameters: + - in: "body" + name: "body" + description: "VNF objects to add to the Marketplace" + required: true + schema: + $ref: "#/definitions/Csars" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/ApiResponse" + /csars/{csarId}: + get: + tags: + - "csarId" + summary: "Find vnf by CSAR ID" + description: "Returns a single vnf" + operationId: "getVnfByCsarId" + produces: + - "application/xml" + - "application/json" + parameters: + - name: "csarId" + in: "path" + description: "CSAR ID of VNF to return" + required: true + type: "string" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/Csars" + 400: + description: "Invalid ID supplied" + 404: + description: "VNF not found" + post: + tags: + - "csarId" + summary: "Updates a VNF in the Marketplace with form data" + description: "" + operationId: "updateCsar" + consumes: + - "application/x-www-form-urlencoded" + produces: + - "application/xml" + - "application/json" + parameters: + - name: "csarId" + in: "path" + description: "CSAR ID of VNF that needs to be updated" + required: true + type: "string" + - name: "name" + in: "formData" + description: "Updated name of the VNF" + required: false + type: "string" + - name: "fileNamee" + in: "formData" + description: "Updated filename of the csar" + required: false + type: "string" + responses: + 405: + description: "Invalid input" + delete: + tags: + - "csarId" + summary: "Deletes a VNF" + description: "" + operationId: "deleteVnf" + produces: + - "application/xml" + - "application/json" + parameters: + - name: "csarId" + in: "path" + description: "VNF CSAR ID to delete" + required: true + type: "string" + responses: + 400: + description: "Invalid ID supplied" + /csars/{csarId}/files: + get: + tags: + - "csarId" + summary: "Download vnf" + description: "Download a single vnf" + operationId: "downloadVnf" + produces: + - "application/xml" + - "application/json" + parameters: + - name: "csarId" + in: "path" + description: "CSAR ID of VNF to return" + required: true + type: "string" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/Csars" + 400: + description: "Invalid ID supplied" + 404: + description: "VNF not found" + +definitions: + Csars: + type: "object" + required: + - "csarId" + properties: + type: + type: "string" + example: "CSAR" + name: + type: "string" + example: "NanocellGateway" + fileName: + type: "string" + creationDate: + type: "string" + modificationDate: + type: "string" + readDate: + type: "string" + size: + type: "string" + example: "37 MB" + provider: + type: "string" + example: "XYZ" + version: + type: "string" + example: "v1.0.0" + createTime: + type: "string" + modifyTime: + type: "string" + downloadUri: + type: "string" + example: "http://msb_ip:msb_port/files/marketplace/CSAR/XYZ/NanocellGW/v1.0" + shortdesc: + type: "string" + example: "XYZ Nanocell Gateway VNF" + details: + type: "string" + csarId: + type: "string" + example: "78ede6f3-66cc-46ab-b748-38a6c010d272" + parameters: + type: "array" + xml: + name: "parameters" + wrapped: true + items: + type: "string" + xml: + name: "Csars" + ApiResponse: + type: "object" + properties: + code: + type: "integer" + format: "int32" + type: + type: "string" + message: + type: "string" +externalDocs: + description: "Find out more about VNFSDK" + url: "https://onap.readthedocs.io/en/latest/submodules/vnfsdk/model.git/docs/index.html" \ No newline at end of file -- cgit 1.2.3-korg