Update notification subscription user guide 38/111338/3
authorSamuel Schneider <samuel.schneider@pantheon.tech>
Tue, 9 Apr 2024 15:19:49 +0000 (17:19 +0200)
committerRobert Varga <nite@hq.sk>
Tue, 16 Apr 2024 09:31:34 +0000 (09:31 +0000)
Update notification subscription user guide to reflect
usage of random UUIDs for stream names and necessity to
specify encoding in url.

JIRA: NETCONF-1272
Change-Id: I6dc49670e55df1b6fdf8256dde6ab07274dd882c
Signed-off-by: Samuel Schneider <samuel.schneider@pantheon.tech>
docs/user-guide.rst

index f9cdc6bad28a9bc0181e202ad37ad9f1e42e52d2..d97f0aa3b83daa328f5e12a9638a4292fc525230 100644 (file)
@@ -747,22 +747,32 @@ Opendaylight provides the way to stream the device notifications over a http ses
       }
     }
 
-The response suggests the http url for reading the notifications.
+The response contains the stream name for reading the notifications.
 
 .. code-block:: json
 
     {
        "odl-device-notification:output": {
-            "stream-path": "http://localhost:8181/rests/notif/test_device?notificationType=test_device"
+            "stream-name": "urn:uuid:91e630ec-1324-4f57-bae3-0925b6d11ffd"
         }
     }
 
-- Step 5: User can access the url in the response and the notifications will be as follows.
+- Step 5: To receive notifications send GET request to url as follows:
+
+.. code-block::
+
+    http://localhost:8181/rests/streams/{encoding}/{stream-name}
+
+{stream-name} - being **stream-name** received in previous step
+
+{encoding} - being desired encoding to be received, either "xml" or "json"
+
+The request for xml encoding and **stream-name** from previous example would look like this:
 
 .. code-block::
 
     GET
-    http://localhost:8181/rests/notif/test_device?notificationType=test_device
+    http://localhost:8181/rests/streams/xml/urn:uuid:91e630ec-1324-4f57-bae3-0925b6d11ffd
     Content-Type: application/xml
     Accept: application/xml