Uplift from master branch

[nonrtric.git] / test / usecases / oruclosedlooprecovery / goversion / README.md

diff --git a/test/usecases/oruclosedlooprecovery/goversion/README.md b/test/usecases/oruclosedlooprecovery/goversion/README.md
index b5b9355..06c44b2 100644 (file)
--- a/test/usecases/oruclosedlooprecovery/goversion/README.md
+++ b/test/usecases/oruclosedlooprecovery/goversion/README.md
@@ -25,13 +25,16 @@ The configured public key and cerificate shall be PEM-encoded. A self signed cer
 
 ## Functionality
 
-The creation of the job is not done when the consumer is started. Instead the consumer provides a REST API where it can be started and stopped, described below.
+The creation of the job is not done when the consumer is started. Instead the consumer provides a REST API where it can be started and stopped, described below. The API is available on the host and port configured for the consumer
 
->- /start  Creates the job in ICS.
->- /stop   Deletes the job in ICS.
+>- /admin/start  Creates the job in ICS.
+>- /admin/stop   Deletes the job in ICS.
 
 If the consumer is shut down with a SIGTERM, it will also delete the job before exiting.
 
+There is also a status call provided in the REST API. This will return the running status of the consumer as JSON.
+>- /status  {"status": "started/stopped"}
+
 ## Development
 
 To make it easy to test during development of the consumer, three stubs are provided in the `stub` folder.