From: Samuel Schneider Date: Tue, 9 Apr 2024 15:19:49 +0000 (+0200) Subject: Update notification subscription user guide X-Git-Tag: v7.0.5~30 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=844045c11a143abda8a1f33c51dfd68edf13da0c;p=netconf.git Update notification subscription user guide 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 --- diff --git a/docs/user-guide.rst b/docs/user-guide.rst index f9cdc6bad2..d97f0aa3b8 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -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