Update netconf/bgpcep release notes
[docs.git] / docs / release-notes / projects / netconf.rst
1 =======
2 NETCONF
3 =======
4
5 Overview
6 ========
7 The NETCONF projects hosts multiple components relating to IETF's NETCONF Working Group:
8
9 * Northbound and southbound plugins for NETCONF protocol, as described in `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__
10 * Northbound plugin for RESTCONF protocol, as described in `RFC-8040 <http://tools.ietf.org/html/rfc8040>`__
11 * Northbound plugin for RESTCONF protocol, as described in `an early draft <https://tools.ietf.org/html/draft-bierman-netconf-restconf-02>`__
12 * Northnound plugin for descring RESTCONF endpoint in terms of `OpenAPI 3.0 <https://swagger.io/docs/specification/about/>`__
13
14
15 Behavior/Feature Changes
16 ========================
17 The RFC8040 endpoint now correctly rejects consecutive slash characters in request URL. The previous
18 behavior of silently accepting such requests can be restored through setting the
19 ``org.opendaylight.restconf.url.consecutive-slashes`` system property to ``allow``. Valid options are also
20 ``debug`` and ``warn``, which cause offending requests to be accepted, but logged to the system log.
21
22 The ``netcon-node-topology`` YANG model has been updated to correctly mark the presence of OpenDaylight's
23 ``yang-ext:mount`` extension. This does not affect the implementation, but improves interoperability with
24 external system.
25
26 The default port for ``call-home`` has been updated to ``4334``, bringing it to compliance with RFC8071.
27
28 New Features
29 ============
30 There are no new features.
31
32 Deprecated and Removed Features
33 ===============================
34 The old RESTCONF endpoint ``localhost:8181/restconf``, as installed via ``odl-restconf-nb-bierman02`` feature,
35 is now considered obsolete and is not installed by default. Users are advised to migrate to using the
36 RFC8040-compliant endpoint ``localhost:8181/rests``, as installed via ``odl-restconf-nb-rfc8040``. The support
37 for the old endpoint will be removed in the next major release.
38
39 Resolved Issues
40 ===============
41
42 The following table lists the issues resolved in this release.
43
44 .. jira_fixed_issues::
45    :project: NETCONF
46    :versions: 3.0.0-3.0.2
47
48 Known Issues
49 ============
50
51 The following table lists the known issues that exist in this release.
52
53 .. jira_known_issues::
54    :project: NETCONF
55    :versions: 3.0.0-3.0.2
56
57 Resolved Issues in SR1
58 ======================
59 The following table lists the issues resolved in Service Release 1.
60
61 .. jira_fixed_issues::
62    :project: NETCONF
63    :versions: 3.0.3-3.0.5
64
65 Known Issues in SR1
66 ===================
67 The following table lists the known issues that exist in Service Release 1.
68
69 .. jira_known_issues::
70    :project: NETCONF
71    :versions: 3.0.3-3.0.5