Fix local server for multiple applications

[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 732e938..7a50b52 100644 (file)
--- a/example/diameter/launcher/resources/HELP.md
+++ b/example/diameter/launcher/resources/HELP.md
@@ -278,7 +278,7 @@ Burst mode only allows single interface interaction. For multiple interface (ori
 
 Adds a new step to the test case with provided identifier. If provided identifier is not registered yet, a new test case will be created with that value and the step will be added as the first. For a specific 'id', the steps are stored in order as they are programmed. Check possible runtime exceptions when adding a new step because those which fail, will be ignored/skipped during test case programming giving an incomplete sequence invalid for the testing purpose.
 
-<id>: integer number, normally monotonically increased for each test case. Some external script/procedure shall clone a test case template in order to build a collection of independent and coherent test cases (normally same type) with different context values (Session-Id, Subscriber-Id, etc.).
+<id>: integer number, normally monotonically increased for each test case. Some external script/procedure shall clone a test case template in order to build a collection of independent and coherent test cases (normally same type) with different context values (Session-Id, Subscriber-Id, etc.). If 0 provided, `id` will be calculated as the current number of test cases plus 1 (normally valid when identification started on value of 1 and no holes were created).
 
 <command>: commands to be executed for the test id provided. Each command programmed constitutes a test case 'step', numbered from 1 to N, with an exception for 'description' which is used to describe the test case:
 
@@ -1242,8 +1242,27 @@ Sends diameter expressed in hexadecimal string (no spaces, no colons, i.e.: `010
 ### FSM testing
 
 ADML implements a bulting *Finite State Machine* to plan testing flows with a great flexibility.
+Every operation will receive a response which  `json` content is as follows:
 
-#### POST /testid-description
+```json
+{
+    "result":"true",
+    "response":"<test id>"
+}
+```
+
+or
+
+```json
+{
+    "result":"false",
+    "response":"<error hint>"
+}
+```
+
+In case of success operation, the value of the affected test identifier carried in `response` field is useful when zero value was provided to automatically reserve the next test case. In case of error, a brief error description will be carried in that field.
+
+#### POST /testid-description/{id}
 
 **Request body**:
 
@@ -1262,7 +1281,7 @@ 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.
@@ -1288,7 +1307,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-timeout
+#### POST /testid-timeout/{id}
 
 **Request body**:
 
@@ -1307,7 +1326,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sendmsg2e
+#### POST /testid-sendmsg2e/{id}
 
 **Request body**:
 
@@ -1327,7 +1346,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sendmsg2c
+#### POST /testid-sendmsg2c/{id}
 
 **Request body**:
 
@@ -1347,7 +1366,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-delay
+#### POST /testid-delay/{id}
 
 **Request body**:
 
@@ -1366,7 +1385,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-sh-command
+#### POST /testid-sh-command/{id}
 
 **Request body**:
 
@@ -1385,7 +1404,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe-hex
+#### POST /testid-waitfe-hex/{id}
 
 **Request body**:
 
@@ -1405,7 +1424,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc-hex
+#### POST /testid-waitfc-hex/{id}
 
 **Request body**:
 
@@ -1425,7 +1444,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe-msg
+#### POST /testid-waitfe-msg/{id}
 
 **Request body**:
 
@@ -1445,7 +1464,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc-msg
+#### POST /testid-waitfc-msg/{id}
 
 **Request body**:
 
@@ -1465,7 +1484,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfe
+#### POST /testid-waitfe/{id}
 
 **Request body**:
 
@@ -1494,7 +1513,7 @@ Value '-1' means 'no limit' (full parallel). Be careful with resources consumpti
 }
 ```
 
-#### POST /testid-waitfc
+#### POST /testid-waitfc/{id}
 
 **Request body**:
 
@@ -1774,7 +1793,13 @@ Makes interactive a specific test case id. The amount of 0, implies no execution
 
 #### POST /test-clear
 
-**Request body**: none
+**Request body**:
+
+```
+{
+     ["id":[test identifier (integer: all by default (-1))]]
+}
+```
 
 **Response body**:
 
@@ -1913,7 +1938,7 @@ Used for system test. Arguments are determined by the way in a specific dynamic
 
 ```
 {
-    "dynamic": <diameter arguments json object>
+    "arguments": <diameter arguments json object>
 }
 ```