Document RESTCONF base path configuration

Add new configuration field "restconf" introduced by NETCONF-1218
to the documentation of restconf northbound configuration.

JIRA: NETCONF-1231
Change-Id: I8382182a0009a5de1ce5556734b81eb4b1232060
Signed-off-by: Samuel Schneider <samuel.schneider@pantheon.tech>

diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index 62df15cd238b1c9df41efdc0ac78f854dcfed688..6e34b1de75e7e4c30805f557ed7817e2e07bcab2 100644 (file)
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -1506,6 +1506,7 @@ set:
 * ``ping-executor-name-prefix``, which defaults to ``ping-executor``
 * ``max-thread-count``, which defaults to ``1``
 * ``use-sse``, which defaults to ``true``
+* ``restconf``, which defaults to ``rests``
 
 *maximum-fragment-length* — Maximum web-socket fragment length in number of Unicode code units (characters)
 (exceeded message length leads to fragmentation of messages)
@@ -1521,6 +1522,8 @@ set:
 *use-sse* — In case of ``true`` access to notification streams will be via Server-Sent Events.
 Otherwise web-socket servlet will be initialized.
 
+*restconf* — The value of RFC8040 restconf URI template, pointing to the root resource. Must not end with '/'.
+
 In order to change these settings, you can either modify the corresponding configuration
 file, ``org.opendaylight.restconf.nb.rfc8040.cfg``, for example:
 
@@ -1529,9 +1532,10 @@ file, ``org.opendaylight.restconf.nb.rfc8040.cfg``, for example:
     maximum-fragment-length=0
     heartbeat-interval=10000
     idle-timeout=30000
-    ping-executor-name-prefix="ping-executor"
+    ping-executor-name-prefix=ping-executor
     max-thread-count=1
     use-sse=true
+    restconf=rests
 
 Or use Karaf CLI:
 
@@ -1544,6 +1548,7 @@ Or use Karaf CLI:
     opendaylight-user@root>config:property-set ping-executor-name-prefix "ping-executor"
     opendaylight-user@root>config:property-set max-thread-count 1
     opendaylight-user@root>config:property-set use-sse true
+    opendaylight-user@root>config:property-set restconf "rests"
     opendaylight-user@root>config:update
 
 NETCONF Call Home

diff --git a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/OSGiNorthbound.java b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/OSGiNorthbound.java
index d83a126bc35881e4978e79de9223959514fe7881..0db023b1a9c90d67dba157cac520cc3c2d194fcb 100644 (file)
--- a/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/OSGiNorthbound.java
+++ b/restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/OSGiNorthbound.java
@@ -52,7 +52,7 @@ public final class OSGiNorthbound {
         @AttributeDefinition
         boolean use$_$sse() default true;
         @AttributeDefinition(name = "{+restconf}", description = """
-            The value of RFC8040 {+restconf} URI template, poiting to the root resource. Must not end with '/'.""")
+            The value of RFC8040 {+restconf} URI template, pointing to the root resource. Must not end with '/'.""")
         String restconf() default "rests";
     }