X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fusecases%2Foruclosedlooprecovery%2Fgoversion%2FREADME.md;h=06c44b291c76b5ebf06ddb1942589edb1ea0b767;hb=5b26de71a0aae08360a38477150551651a7ef734;hp=b5b93553326b67b7e281d341fa0e42506a9e8527;hpb=0ade79498db21c8db3ecdd96ec30eb006e593acb;p=nonrtric.git diff --git a/test/usecases/oruclosedlooprecovery/goversion/README.md b/test/usecases/oruclosedlooprecovery/goversion/README.md index b5b93553..06c44b29 100644 --- 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.