Add fourth work package for REST API implementation

[anna.git] / example / diameter / launcher / resources / HELP.md

diff --git a/example/diameter/launcher/resources/HELP.md b/example/diameter/launcher/resources/HELP.md
index bef7e3f..40f1a5e 100644 (file)
--- a/example/diameter/launcher/resources/HELP.md
+++ b/example/diameter/launcher/resources/HELP.md
@@ -1267,6 +1267,10 @@ ADML implements a bulting *Finite State Machine* to plan testing flows with a gr
 In-Progress limit is the maximum number of tests which can be executed in parallel.
 This operation allows a specific test to set this global pool behaviour.
 
+Zero-value is equivalent to stop the clock (no tests will be executed).
+
+Value '-1' means 'no limit' (full parallel). Be careful with resources consumption.
+
 **Request body**:
 
 ```
@@ -1563,6 +1567,12 @@ This operation allows a specific test to set this global pool behaviour.
 
 Global operation (also at test identifier level is accessible).
 
+Zero-value is equivalent to stop the clock (no tests will be executed).
+
+Value '-1' means 'no limit' (full parallel). Be careful with resources consumption.
+
+Defaults to '-2' (no '-1' which is default for *testid-ip-limit* version), which wil show the current pool *ip-limit* and also the number of test cases which are *in progress*.
+
 **Request body**:
 
 ```
@@ -1633,7 +1643,7 @@ Global operation (also at test identifier level is accessible).
 ```
 {
     "result":"<true or false>",
-    "response":"<response>"
+    "response":"<base64-encoded output>"
 }
 ```
 
@@ -1651,13 +1661,15 @@ Global operation (also at test identifier level is accessible).
 
 ```
 {
-    "result":"<true or false>",
+    "result":"<true: if state is 'Success' or false>",
     "response":"<response>"
 }
 ```
 
 #### POST /test-interact
 
+Makes interactive a specific test case id. The amount of 0, implies no execution steps margin, which could be useful to 'freeze' a test in the middle of its execution. Value -1 makes it non-interactive resuming it from the current step.
+
 **Request body**:
 
 ```
@@ -1682,8 +1694,8 @@ Global operation (also at test identifier level is accessible).
 
 ```
 {
-     "type":"<soft|hard>"
-     [,"id":[test identifier (integer: apply to all the tests (-2))]]
+     ["type":"<[soft]|hard>"]
+     [,"id":[test identifier (integer: apply to all the tests (-1))]]
 }
 ```
 
@@ -1775,11 +1787,13 @@ Global operation (also at test identifier level is accessible).
 
 #### POST /test-junit
 
+As it could be very large, it will be dumped on provided target directory, '*/tmp/junit.xml*' by default.
+
 **Request body**:
 
 ```
 {
-    "targetFile":"<file path>"
+    ["targetFile":"<file path>"]
 }
 ```
 
@@ -1801,7 +1815,7 @@ Global operation (also at test identifier level is accessible).
 ```
 {
     "result":"<true or false>",
-    "response":"<response>"
+    "response":"<base64-encoded output>"
 }
 ```
 
@@ -1814,7 +1828,7 @@ Global operation (also at test identifier level is accessible).
 ```
 {
     "result":"<true or false>",
-    "response":"<response>"
+    "response":"<base64-encoded output>"
 }
 ```
 
@@ -1827,7 +1841,7 @@ Global operation (also at test identifier level is accessible).
 ```
 {
     "result":"<true or false>",
-    "response":"<response>"
+    "response":"<base64-encoded output>"
 }
 ```