Add new operation 'run' to test a specific test case

[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 5dbf7b5..69f0615 100644 (file)
--- a/example/diameter/launcher/resources/HELP.md
+++ b/example/diameter/launcher/resources/HELP.md
@@ -431,7 +431,11 @@ Anyway, the meaning is the same in both contexts. But now, when the amount is mi
 
 **test|goto|<id>**
 
-Updates current test pointer position.
+Updates current test pointer position. Take into account, that 'test|next' will execute the next test case, not the one pointed with *goto*.
+
+**test|run|<id>**
+
+Run the test case selected.
 
 **test|look[|id]**
 
@@ -462,7 +466,7 @@ Restarts the whole programmed test list when finished the amount number of times
 
 **test|auto-reset|<soft|hard>**
 
-When cycling, current test cases can be soft (default) or hard reset. If no timeout has been configured for the test case, hard reset could prevent stuck on the next cycle for those test cases still in progress.
+When cycling, current test cases can be soft or hard reset. If no timeout has been configured for the test case, hard reset could prevent stuck on the next cycle for those test cases still in progress.
 
 **test|initialized**
 
@@ -520,8 +524,25 @@ This operation requires advanced programming and knowlegde of ANNA Diameter stac
 # HTTP Interface
 
 All the operations described above can be used through the optional HTTP interface. You only have
- to define the http server at the command line with something like: '--httpServer localhost:9000'.
-To send the task, we shall build the http POST request json body with the operation string.
+ to define the http server at the command line with something like: '--httpServer localhost:8000'.
+REST API specification:
+
+## GET
+
+> curl -v --request GET localhost:8000<uri>
+
+HTTP2 is not served, so, you should use *nginx* reverse proxy or similar, to pass HTTP1 requests to the server, allowing the external use of HTTP2 clients like *nghttp*:
+
+> nghttp -v -H ":method: GET" "<uri>"
+
+### GET /xxxx
+
+
+
+## POST
+
+> curl -v --request POST -H "Content-Type: application/json" localhost:8000<uri> -d@test.json
 
- Json specification covers a subset for previous:
+HTTP2 is not served, so, you should use *nginx* reverse proxy or similar, to pass HTTP1 requests to the server, allowing the external use of HTTP2 clients like *nghttp*:
 
+> nghttp -v -H ":method: POST" -d test.json "<uri>"
\ No newline at end of file