Modify sme invoker to discover the endpoints by itself

[nonrtric.git] / test / mrstub / README.md

diff --git a/test/mrstub/README.md b/test/mrstub/README.md
index 171b4f4..54aae2f 100644 (file)
--- a/test/mrstub/README.md
+++ b/test/mrstub/README.md
@@ -1,7 +1,7 @@
-# mrstub - stub interface to interact with the policy agent over Dmaap
+# mrstub - stub interface to interact with the A1PMS over Dmaap
 
 The mrstub is intended for function tests to simulate a message router.
-The mrstub exposes the read and write urls, used by the agent, as configured in consul.
+The mrstub exposes the read and write urls, used by the a1pms, as configured in consul.
 In addition, request messages can be fed to the mrstub and the response messages can be read by polling.
 
 ## Ports and certificates
@@ -15,7 +15,7 @@ The certificate and key shall be placed in the same dir and the dir shall be mou
 | 3906     | https |
 
 The dir cert contains a self-signed cert. Use the script generate_cert_and_key.sh to generate a new certificate and key. The password of the certificate must be set 'test'.
-The same urls are availables on both the http port 3905 and the https port 3906. If using curl and https, the flag -k shall be given to make curl ignore checking the certificate.
+The same urls are available on both the http port 3905 and the https port 3906. If using curl and https, the flag -k shall be given to make curl ignore checking the certificate.
 
 ### Message Router interface
 
@@ -37,7 +37,7 @@ The control interface can be used by any test script.
 The following REST operations are available:
 
 >Send a message to MR<br>
-This method puts a request message in the queue for the agent to pick up. The returned correlationId (auto generated by the mrstub) is used when polling for the reposone message of this particular request.<br>
+This method puts a request message in the queue for the a1pms to pick up. The returned correlationId (auto generated by the mrstub) is used when polling for the response message of this particular request.<br>
 ```URI and parameters (GET): /send-request?operation=<GET|PUT|POST|DELETE>&url=<url>```<br><br>
 ```response: <correlation-id> (http 200) or 400 for parameter error or 500 for other errors```
 
@@ -49,10 +49,10 @@ The method is for polling of messages, returns immediately containing the receiv
 >Metrics - counters<br>
 There are a number of counters that can be read to monitor the message processing. Do a http GET on any of the current counters and an integer value will be returned with http response code 200.
 ```/counter/requests_submitted``` - The total number of requests sent from the application<br>
-```/counter/requests_fetched``` - The total number of requests picked up by the agent<br>
-```/counter/responses_submitted``` - The total number of responses written by the agent<br>
+```/counter/requests_fetched``` - The total number of requests picked up by the a1pms<br>
+```/counter/responses_submitted``` - The total number of responses written by the a1pms<br>
 ```/counter/responses_fetched``` - The total number of responses picked up by the application<br>
-```/counter/current_requests``` - The current number of requests waiting to be picked up by the agent<br>
+```/counter/current_requests``` - The current number of requests waiting to be picked up by the a1pms<br>
 ```/counter/current_responses``` - The current number of responses waiting to be picked up by the application<br>
 
 ### Build and start
@@ -70,12 +70,12 @@ file "key.crt" is the key file
 file "generate_cert_and_key.sh" is a shell script to generate certificate and key
 file "pass" stores the password when you run the shell script
 
->Start the a1-interface container without specifing external certificates:<br>
+>Start the a1-interface container without specifying external certificates:<br>
 ```docker run --rm -it -p 3905:3905 -p 3906:3906 mrstub```
 
 It will listen to http 3905 port and https 3906 port(using default certificates) at the same time.
 
-This certificates/key can be overriden by mounting a volume when using "docker run" or "docker-compose"
+This certificates/key can be overridden by mounting a volume when using "docker run" or "docker-compose"
 In 'docker run', use field:<br>
 >```-v "$PWD/certificate:/usr/src/app/cert"```<br>