From a229deaafe420c122c383805df9aadfe10f0ff64 Mon Sep 17 00:00:00 2001 From: Bartosz Gardziejewski Date: Fri, 22 Jan 2021 08:34:46 +0100 Subject: Update documentation - running validation with selected release Signed-off-by: Bartosz Gardziejewski Change-Id: Ic4fc23bff09c5c94707a3b1b447d5234fd96b95e Issue-ID: VNFSDK-731 --- .../VNFSDK-Marketplace-userguide-rest-api.rst | 26 ++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'docs/files') diff --git a/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst b/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst index 40c68b6..f77370c 100644 --- a/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst +++ b/docs/files/VNFSDK-Marketplace-userguide-rest-api.rst @@ -53,6 +53,32 @@ Otherwise *executionId*, that can be used for checking validation state in the f } }]"' +- CSAR Validation - run validation for selected release + +Send and validate a CSAR file using rules which have selected release. +The 'release' parameter is optional and it can have one of the values: amsterdam, casablanca, dublin, frankfurt, guilin, honolulu, latest +If user doesn't set parameter then all rules will be used during validation. Otherwise rules are collected according to pattern: +amsterdam rules <- casablanca rules <-dublin rules <-frankfurt rules <- guilin rules <- honolulu release <- latest +For example: if user set release to dublin then rules with release dublin, casablanca and amsterdam will be used. + +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-vtp\", + \"testSuiteName\": \"validation\", + \"testCaseName\": \"csar-validate\", + \"parameters\": { + \"csar\": \"file://{csar file name}\", + \"pnf\":\"true\", + \"release\":\"dublin\" + } + }]"' - CSAR Validation - get results of validation -- cgit 1.2.3-korg