summaryrefslogtreecommitdiffstats
path: root/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst
diff options
context:
space:
mode:
authorBogumil Zebek <bogumil.zebek@nokia.com>2020-12-14 06:50:18 +0000
committerGerrit Code Review <gerrit@onap.org>2020-12-14 06:50:18 +0000
commitce00d6d6f1b946e79b32df22bd53c3deef34c541 (patch)
treed991b890192fdcf3411c57272729f3998b8890f7 /docs/files/VNFSDK-Marketplace-userguide-rest-api.rst
parentd315d44ab7a0e9013d9ebd848bac83a2cc132d3f (diff)
parent8fcc3f4e331987d1e42222a4b88ef2f4dd114538 (diff)
Merge "Add rest API description fo marketplace"
Diffstat (limited to 'docs/files/VNFSDK-Marketplace-userguide-rest-api.rst')
-rw-r--r--docs/files/VNFSDK-Marketplace-userguide-rest-api.rst64
1 files changed, 64 insertions, 0 deletions
diff --git a/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst b/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst
new file mode 100644
index 0000000..d7c1e6e
--- /dev/null
+++ b/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst
@@ -0,0 +1,64 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2020 Nokia.
+
+VNF SDK Marketplace User Guide for Rest API
+============================================
+
+The VNF SDK Marketplace expose rest API endpoints that allows validation of CSAR packages.
+
+**Parameters that need to be inserted are surrounded with {...}**.
+
+- CSAR Validation - use all rules
+
+Send and validate CSAR, against all active rules.
+If validation finish before timeout, result will be returned in json format.
+Otherwise *executionId*, that can be used for checking validation state in the future, will be returned.
+
+.. code-block::
+
+ curl --location --request POST 'http://{marketplace address}/onapapi/vnfsdk-marketplace/v1/vtp/executions' \
+ --header 'Content-Type: multipart/form-data' \
+ --form 'file=@"{path to csar file}"' \
+ --form 'executions="[{
+ \"scenario\": \"onap-dublin\",
+ \"testSuiteName\": \"validation\",
+ \"testCaseName\": \"csar-validate\",
+ \"parameters\": {
+ \"csar\": \"file://{csar file name}\",
+ \"pnf\":\"true\"
+ }
+ }]"'
+
+
+- CSAR Validation - use selected rules
+
+Send and validate CSAR, against selected rules.
+If validation finish before timeout, result will be returned in json format.
+Otherwise *executionId*, that can be used for checking validation state in the future, will be returned.
+
+.. code-block::
+
+ curl --location --request POST 'http://{marketplace address}/onapapi/vnfsdk-marketplace/v1/vtp/executions' \
+ --header 'Content-Type: multipart/form-data' \
+ --form 'file=@"{path to csar file}"' \
+ --form 'executions="[{
+ \"scenario\": \"onap-dublin\",
+ \"testSuiteName\": \"validation\",
+ \"testCaseName\": \"csar-validate\",
+ \"parameters\": {
+ \"csar\": \"file://{csar file name}\",
+ \"pnf\":\"true\",
+ \"rules\":\"{rules to be validated example:r130206,r816745}\"
+ }
+ }]"'
+
+
+- CSAR Validation - get results of validation
+
+Get result of CSAR validation connected with *executionId*.
+Returns result in json format.
+
+.. code-block::
+
+ curl --location --request GET 'http://{marketplace address}/onapapi/vnfsdk-marketplace/v1/vtp/executions?requestId={executionId}'