From 8fcc3f4e331987d1e42222a4b88ef2f4dd114538 Mon Sep 17 00:00:00 2001 From: Bartosz Gardziejewski Date: Wed, 9 Dec 2020 13:07:37 +0100 Subject: Add rest API description fo marketplace Signed-off-by: Bartosz Gardziejewski Change-Id: I5c43bfc5545a466118cd6427a9aa9d3a02b2c90c Issue-ID: VNFSDK-700 --- .../VNFSDK-Marketplace-userguide-rest-api.rst | 64 ++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/files/VNFSDK-Marketplace-userguide-rest-api.rst (limited to 'docs/files') 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}' -- cgit 1.2.3-korg