From d30fcbb89c951c2d6e3d27c01e09649134c8a5c9 Mon Sep 17 00:00:00 2001 From: Samuel Schneider Date: Wed, 16 Oct 2024 12:39:40 +0200 Subject: [PATCH] Improve event notification subscription tutorial Information about possible query parameters was misplaced. Query parameters should be used when connecting to SSE location not when obtaining it. Move this information to more relevant place. JIRA: NETCONF-1392 Change-Id: Idb44f76ea1fa5a894b567b025b8871425efe4436 Signed-off-by: Samuel Schneider --- docs/user-guide.rst | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 423ce1915c..47f640d3a1 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -885,26 +885,6 @@ previous step. OPERATION: GET URI: http://{odlAddress}:{odlPort}/rests/data/ietf-restconf-monitoring:restconf-state/streams/stream=urn:uuid:b3db417c-0305-473d-b6c8-2da01c543171 -The subscription call may be modified with the following query parameters defined in the RESTCONF RFC: - -- `filter `__ - -- `start-time `__ - -- `end-time `__ - -In addition, the following ODL extension query parameter is supported: - -:odl-leaf-nodes-only: - If this parameter is set to "true", create and update notifications will only - contain the leaf nodes modified instead of the entire subscription subtree. - This can help in reducing the size of the notifications. - -:odl-skip-notification-data: - If this parameter is set to "true", create and update notifications will only - contain modified leaf nodes without data. - This can help in reducing the size of the notifications. - The response should look something like this: .. code-block:: json @@ -945,6 +925,26 @@ The request should look something like this: curl -v -X GET http://localhost:8181/rests/streams/json/urn:uuid:b3db417c-0305-473d-b6c8-2da01c543171 -H "Content-Type: text/event-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" +The subscription call may be modified with the following query parameters defined in the RESTCONF RFC: + +- `filter `__ + +- `start-time `__ + +- `end-time `__ + +In addition, the following ODL extension query parameter is supported: + +:odl-leaf-nodes-only: + If this parameter is set to "true", create and update notifications will only + contain the leaf nodes modified instead of the entire subscription subtree. + This can help in reducing the size of the notifications. + +:odl-skip-notification-data: + If this parameter is set to "true", create and update notifications will only + contain modified leaf nodes without data. + This can help in reducing the size of the notifications. + Netconf-keystore configuration ------------------------------ -- 2.36.6