From 88bb2d4abd6d73a0a44b8884693fa962be66bae5 Mon Sep 17 00:00:00 2001 From: Aman <170030039@iitdh.ac.in> Date: Sat, 18 Jul 2020 12:04:10 +0530 Subject: [PATCH] Added JSON and XML payloads tabs with RFC 8040 URL Modified docs/pcep/pcep-user-guide-test-tools.rst by adding JSON,XML examples with corresponding sphinx tab Change-Id: Iff6fba06627c8718b1584341532365b6da9590a1 Signed-off-by: Aman <170030039@iitdh.ac.in> --- docs/pcep/pcep-user-guide-test-tools.rst | 98 +++++++++++++++++++----- 1 file changed, 77 insertions(+), 21 deletions(-) diff --git a/docs/pcep/pcep-user-guide-test-tools.rst b/docs/pcep/pcep-user-guide-test-tools.rst index 921e84357a..341297fc05 100644 --- a/docs/pcep/pcep-user-guide-test-tools.rst +++ b/docs/pcep/pcep-user-guide-test-tools.rst @@ -101,24 +101,53 @@ Once we set the configuration, a new data change counter will be created and reg **URL:** ``/restconf/config/odl-data-change-counter-config:data-change-counter-config/data-change-counter`` +**RFC8040 URL:** ``/rests/data/odl-data-change-counter-config:data-change-counter-config=data-change-counter`` + **Method:** ``PUT`` -**Content-Type:** ``application/xml`` +.. tabs:: + + .. tab:: XML + + **Content-Type:** ``application/xml`` + + **Request Body:** + + .. code-block:: xml + :linenos: + :emphasize-lines: 2,3 + + + data-change-counter + example-linkstate-topology + + + @line 2: **Counter Id** - Unique counter change identifier. + + @line 3: **Topology Name** - An identifier for a topology. + + .. tab:: JSON + + **Content-Type:** ``application/json`` -**Request Body:** + **Request Body:** -.. code-block:: xml - :linenos: - :emphasize-lines: 2,3 + .. code-block:: json + :linenos: + :emphasize-lines: 4,5 - - data-change-counter - example-linkstate-topology - + { + "odl-data-change-counter-config:data-change-counter-config": [ + { + "counter-id": "data-change-counter", + "topology-name": "example-linkstate-topology" + } + ] + } -@line 2: **Counter Id** - Unique counter change identifier. + @line 4: **Counter Id** - Unique counter change identifier. -@line 3: **Topology Name** - An identifier for a topology. + @line 5: **Topology Name** - An identifier for a topology. Usage ''''' @@ -127,19 +156,46 @@ Counter state for topology **URL:** ``/restconf/operational/data-change-counter:data-change-counter/counter/data-change-counter`` +**RFC8040 URL:** ``/rests/data/data-change-counter:data-change-counter/counter=data-change-counter?content=nonconfig`` + **Method:** ``GET`` -**Response Body:** +.. tabs:: + + .. tab:: XML + + **Response Body:** + + .. code-block:: xml + :linenos: + :emphasize-lines: 2,3 + + + data-change-counter + 0 + + + @line 2: **Counter Id** - Unique counter change identifier. + + @line 3: **Count** - Number of changes under registered topology's subtree. + + .. tab:: JSON + + **Response Body:** -.. code-block:: xml - :linenos: - :emphasize-lines: 2,3 + .. code-block:: json + :linenos: + :emphasize-lines: 4,5 - - data-change-counter - 0 - + { + "data-change-counter:counter": [ + { + "id": "data-change-counter", + "count": 0 + } + ] + } -@line 2: **Counter Id** - Unique counter change identifier. + @line 4: **Counter Id** - Unique counter change identifier. -@line 3: **Count** - Number of changes under registered topology's subtree. + @line 5: **Count** - Number of changes under registered topology's subtree. -- 2.36.6