X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=test%2Fcr%2FREADME.md;h=becace1a5c05d575950842cb7770ee93ba725e61;hb=49f0e5ab01b51aee8713a17aed86cd6d229b40cc;hp=251f0b314061e2f6206d56b718a1e4058a2cb6db;hpb=647744d8ab625d28ea0ecda3e6741e23ba9b0bc7;p=nonrtric.git diff --git a/test/cr/README.md b/test/cr/README.md index 251f0b31..becace1a 100644 --- a/test/cr/README.md +++ b/test/cr/README.md @@ -2,7 +2,7 @@ The callback receiver is intended for function tests to simulate a RAPP. The callback receiver exposes the read and write urls, used by the agent, as configured in service. -The callback receiver receives notifications from PMS when synchronization happens between PMS and RICs. +The callback receiver receives notifications from PMS when synchronization happens between PMS and RICs. However, the callback receiver can be uses to receive any json payload from any source. # Ports and certificates @@ -24,14 +24,30 @@ The following REST operations are available: >Send a message to CR
This method puts a request message from PMS to notify that sychronization between PMS and certain RIC happens.
-```URI and payload, (PUT or POST): /callbacks/ ```

+```URI and payload, (PUT or POST): /callbacks/ ```
```response: OK 200 or 500 for other errors``` +>Fetch one message for an id from CR
+This method fetches the oldes message for an id, and removes the message.
+```URI and payload, (GET): /get-event/```
+```response: 200 or 500 for other errors``` + +>Fetch all messages for an id from CR
+This method fetches all message in an array for an id, and removes all messages.
+```URI and payload, (GET): /get-all-events/```
+```response: 200 or 500 for other errors``` + +>Dump all currently wating callback messages in CR
+This method fetches all message in an array for an id. Messages are left intact in the CR.
+```URI and payload, (GET): /db```
+```response: 200``` + >Metrics - counters
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/received_callbacks``` - The total number of received callbacks
```/counter/fetched_callbacks``` - The total number of fetched callbacks
```/counter/current_messages``` - The current number of callback messages waiting to be fetched
+All counters also support the query parameter "id" to fetch counter for one individual id, eg ```/counter/current_messages?id=my-id``` ### Build and start ###