X-Git-Url: https://git.teslayout.com/public/public/public/?a=blobdiff_plain;f=example%2Fdiameter%2Flauncher%2Fresources%2FHELP.md;h=c7a15a7659c36c1b8308c8cf634247ce5437f0d2;hb=609c79ead77490f99f3f34836b19820999a85169;hp=bef7e3f43a3a8ee7315fbfc42fbbf49d27cacb77;hpb=e688b5354af3a5fe0add859710cae41ffe123f65;p=anna.git

diff --git a/example/diameter/launcher/resources/HELP.md b/example/diameter/launcher/resources/HELP.md
index bef7e3f..c7a15a7 100644
--- a/example/diameter/launcher/resources/HELP.md
+++ b/example/diameter/launcher/resources/HELP.md
@@ -539,7 +539,7 @@ Implemented status codes: *200* (ok), *400* (bad request) and *405* (method not
 
 > curl -v --request GET localhost:8000<uri>
 
-You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
+You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*anna-adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
 
 > nghttp -v -H ":method: GET" "<uri>"
 
@@ -579,7 +579,7 @@ Retrieve statistics xml report (will be *base64-encoded* at response).
 
 > curl -v --request POST -H "Content-Type: application/json" localhost:8000<uri> -d@test.json
 
-You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
+You could also expose the service as HTTP2 server through *nginx* working as reverse proxy (*anna-adml-http* image is built in this way although internally provides HTTP operations script only for 1.1). Then you could use HTTP2 clients like *nghttp*:
 
 > nghttp -v -H ":method: POST" -d test.json "<uri>"
 
@@ -840,7 +840,7 @@ Selects a context working node by mean a registered name (origin-host). If empty
 }
 ```
 
-**Response body**: 
+**Response body**:
 
 ```
 {
@@ -1243,7 +1243,7 @@ Sends diameter expressed in hexadecimal string (no spaces, no colons, i.e.: `010
 
 ADML implements a bulting *Finite State Machine* to plan testing flows with a great flexibility.
 
-#### POST /testid-description
+#### POST /testid-description/{id}
 
 **Request body**:
 
@@ -1262,11 +1262,15 @@ ADML implements a bulting *Finite State Machine* to plan testing flows with a gr
 }
 ```
 
-#### POST /testid-ip-limit
+#### POST /testid-ip-limit/{id}
 
 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**:
 
 ```
@@ -1284,7 +1288,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-timeout
+#### POST /testid-timeout/{id}
 
 **Request body**:
 
@@ -1303,7 +1307,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-sendmsg2e
+#### POST /testid-sendmsg2e/{id}
 
 **Request body**:
 
@@ -1323,7 +1327,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-sendmsg2c
+#### POST /testid-sendmsg2c/{id}
 
 **Request body**:
 
@@ -1343,7 +1347,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-delay
+#### POST /testid-delay/{id}
 
 **Request body**:
 
@@ -1362,7 +1366,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-sh-command
+#### POST /testid-sh-command/{id}
 
 **Request body**:
 
@@ -1381,7 +1385,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfe-hex
+#### POST /testid-waitfe-hex/{id}
 
 **Request body**:
 
@@ -1401,7 +1405,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfc-hex
+#### POST /testid-waitfc-hex/{id}
 
 **Request body**:
 
@@ -1421,7 +1425,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfe-msg
+#### POST /testid-waitfe-msg/{id}
 
 **Request body**:
 
@@ -1441,7 +1445,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfc-msg
+#### POST /testid-waitfc-msg/{id}
 
 **Request body**:
 
@@ -1461,7 +1465,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfe
+#### POST /testid-waitfe/{id}
 
 **Request body**:
 
@@ -1490,7 +1494,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-#### POST /testid-waitfc
+#### POST /testid-waitfc/{id}
 
 **Request body**:
 
@@ -1519,7 +1523,7 @@ This operation allows a specific test to set this global pool behaviour.
 }
 ```
 
-### EXECUTION ACTIONS
+### FSM TESTING EXECUTION ACTIONS
 
 #### POST /test-ttps
 
@@ -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>"
 }
 ```
 
@@ -1889,5 +1903,26 @@ Global operation (also at test identifier level is accessible).
 }
 ```
 
+### DYNAMIC PROCEDURE
+
+Used for system test. Arguments are determined by the way in a specific dynamic library is designed/documented.
+
+#### POST /dynamic
 
+**Request body**:
+
+```
+{
+    "arguments": <diameter arguments json object>
+}
+```
+
+**Response body**:
+
+```
+{
+    "result":"<true or false>",
+    "response":"<response>"
+}
+```