Added in note for the verbose option.

Change-Id: I274c128d5cf954bcdb62b018d2d8a8f5863cec32
Signed-off-by: mrpa <miruna.paun@enea.com>

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
index 6ce9f9c..f710ccb 100644
--- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
@@ -868,6 +868,41 @@ Options:
   -o, --display_output    Display output of the method
   --help                  Show this message and exit.</programlisting>
 
+      <para>For displaying all the available Python APIs and their parameters,
+      run the Python script with the <literal>-v/--verbose</literal> option. A
+      few examples will be displayed in the following sections.</para>
+
+      <para>If the parameters of the Python APIs contain <literal>=</literal>
+      in their description that means they have a default value that is
+      already defined in the Python script. The default value of the parameter
+      is displayed after this symbol.</para>
+
+      <para>To use or change the default value of one or more parameters,
+      perform one of the following methods:</para>
+
+      <itemizedlist>
+        <listitem>
+          <para>Run the Python API using only the values of the parameters 
+            without specifying the parameters' names. All parameters will 
+            be given and the value will be the position of each parameter.</para>
+        </listitem>
+
+        <listitem>
+          <para>Run the Python API using the
+          <literal>&lt;parameter_name&gt;=</literal> syntax. Only specific
+          parameters will be given and they will be specified as
+          <literal>&lt;parameter_name&gt;=&lt;parameter_value&gt;</literal>.</para>
+        </listitem>
+
+        <listitem>
+          <para>Run the Python API with a mix of parameters. Mandatory
+          parameters will be given without specifying their name (their
+          position will be used in this situation) and the optional parameters
+          will be given, using the syntax:<literal>
+          &lt;parameter_name&gt;=&lt;parameter_value&gt;</literal>.</para>
+        </listitem>
+      </itemizedlist>
+
       <para>In the <literal>test_harness/&lt;module name&gt;</literal>
       directory, the Ansible Playbooks are implemented for running the Python
       scripts from Enea Edge Automation. The name of the Ansible Playbooks is