From: Mario Abraham Date: Wed, 14 Aug 2019 10:18:22 +0000 (+0200) Subject: Update user-guide.rst X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=commitdiff_plain;h=refs%2Fheads%2Fstable%2Ffluorine Update user-guide.rst - added info about 2 different endpoints related to RESTCONF Issue-ID: NETCONF-500 Signed-off-by: Mario Abraham Change-Id: I3ab9517e6ac2afe3e061eb31dfa8b642e1d34614 (cherry picked from commit 5bc455ab7471a308b77e1455da43f1d8202aa89c) --- diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 50694dbf88..7c30580c26 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -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 `__, + | 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 `__, + | can be activated by installing ``odl-restconf-nb-rfc8040`` + Karaf feature. + + | In case of `RFC-8040 `__ + 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 ^^^^^^^^^^^^^^^^^^^^^