Update user-guide.rst 12/83612/2
authorMario Abraham <mario.abraham@pantheon.tech>
Wed, 14 Aug 2019 10:18:22 +0000 (12:18 +0200)
committerMario Abraham <mario.abraham@pantheon.tech>
Wed, 14 Aug 2019 17:51:08 +0000 (17:51 +0000)
- added info about 2 different endpoints
related to RESTCONF

Issue-ID: NETCONF-500
Signed-off-by: Mario Abraham <mario.abraham@pantheon.tech>
Change-Id: I3ab9517e6ac2afe3e061eb31dfa8b642e1d34614
(cherry picked from commit 5bc455ab7471a308b77e1455da43f1d8202aa89c)

docs/user-guide.rst

index 22941acdc40de31024a68654329cbb9a002eb165..c2988f849c2fae97c022b3a51b4bdc41346264a4 100644 (file)
@@ -51,6 +51,37 @@ Netconf-connector configuration
 There are 2 ways for configuring netconf-connector: NETCONF or RESTCONF.
 This guide focuses on using RESTCONF.
 
+.. important::
+
+    There are 2 different endpoints related to RESTCONF protocols:
+
+    - | ``http://localhost:8181/restconf`` is related to `draft-bierman-netconf-restconf-02 <https://tools.ietf.org/html/draft-bierman-netconf-restconf-02>`__,
+      | can be activated by installing ``odl-restconf-nb-bierman02``
+       Karaf feature.
+      | This user guide uses this approach.
+
+    - | ``http://localhost:8181/rests`` is related to `RFC-8040 <https://tools.ietf.org/html/rfc8040>`__,
+      | can be activated by installing ``odl-restconf-nb-rfc8040``
+       Karaf feature.
+
+    | In case of `RFC-8040 <https://tools.ietf.org/html/rfc8040>`__
+     resources for configuration and operational datastores start
+     ``/rests/data/``,
+    | e. g. GET
+     http://localhost:8181/rests/data/network-topology:network-topology
+     with response of both datastores. It's allowed to use query
+     parameters to distinguish between them.
+    | e. g. GET
+     http://localhost:8181/rests/data/network-topology:network-topology?content=config
+     for configuration datastore
+    | and GET
+     http://localhost:8181/rests/data/network-topology:network-topology?content=nonconfig
+     for operational datastore.
+
+
+
+
+
 Default configuration
 ^^^^^^^^^^^^^^^^^^^^^