From: Robert Varga <robert.varga@pantheon.tech>
Date: Sun, 26 Sep 2021 21:12:40 +0000 (+0200)
Subject: Update NETCONF release notes
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=commitdiff_plain;h=f99b0d4c4af4d4d46da9b42eddc01293ba4dd6e4;p=docs.git

Update NETCONF release notes

The overview misses a number of things, make sure to update it with
OpenAPI and RESTCONF references. Also highlight netconf-2.0.x changes
and sum up the issues.

Change-Id: Ia97955380dcf0cfc39bb947124825d35573c07fd
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
---

diff --git a/docs/release-notes/projects/netconf.rst b/docs/release-notes/projects/netconf.rst
index a7b8431ed..ce79e248f 100644
--- a/docs/release-notes/projects/netconf.rst
+++ b/docs/release-notes/projects/netconf.rst
@@ -4,43 +4,51 @@ NETCONF
 
 Overview
 ========
+The NETCONF projects hosts multiple components relating to IETF's NETCONF Working Group:
+
+* Northbound and southbound plugins for NETCONF protocol, as described in `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__
+* Northbound plugin for RESTCONF protocol, as described in `RFC-8040 <http://tools.ietf.org/html/rfc8040>`__
+* Northbound plugin for RESTCONF protocol, as described in `an early draft <https://tools.ietf.org/html/draft-bierman-netconf-restconf-02>`__
+* Northnound plugin for descring RESTCONF endpoint in terms of `OpenAPI 3.0 <https://swagger.io/docs/specification/about/>`__
 
-NETCONF is an XML-based protocol used for configuration and monitoring
-devices in the network. The base NETCONF protocol is described in
-`RFC-6241 <http://tools.ietf.org/html/rfc6241>`__.
 
 Behavior/Feature Changes
 ========================
+The RFC8040 endpoint now correctly interprets `YANG Patch Media Type <https://datatracker.ietf.org/doc/html/rfc8072>`__
+requests.
 
-Here is the link to the features improved in this release:
-
-`OpenDaylight JIRA Tickets - Improvement <https://jira.opendaylight.org/issues/?jql=project+%3D+NETCONF+AND+issuetype+%3D+Improvement+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28Silicon%2C+%22Silicon+GA%22%2C+1.13.0%29+ORDER+BY+issuetype+DESC%2C+key+ASC>`_
+The ``netcon-node-topology`` YANG model has been updated to correctly mark the presence of OpenDaylight's
+``yang-ext:mount`` extension. This does not affect the implementation, but improves interoperability with
+external system.
 
 New Features
 ============
+There are no new features.
 
-Here is the link to the new features introduced in this release:
-
-`OpenDaylight JIRA Tickets - New Feature <https://jira.opendaylight.org/issues/?jql=project+%3D+NETCONF+AND+issuetype+%3D+%22New+Feature%22+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28Silicon%2C+%22Silicon+GA%22%2C+1.13.0%29+ORDER+BY+issuetype+DESC%2C+key+ASC>`_
-
-Deprecated Features
-===================
+Deprecated and Removed Features
+===============================
+The ``odl-messagebus`` feature has been removed.
 
-Here is the link to the features removed in this release:
-
-`OpenDaylight JIRA Tickets - Deprecated Feature <https://jira.opendaylight.org/issues/?jql=project+%3D+netconf+AND+type+%3D+Deprecate+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28Silicon%2C+%22Silicon+GA%22%2C+1.13.0%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
+The old RESTCONF endpoint ``localhost:8181/restconf``, as installed via ``odl-restconf-nb-bierman02`` feature,
+is now considered legacy and is expected to become deprecated in the next major release. Users are advised to
+migrate to using the RFC8040-compliant endpoint ``localhost:8181/rests``, as installed via
+``odl-restconf-nb-rfc8040``.
 
 Resolved Issues
 ===============
 
-Here is the link to the resolved issues fixed in this release:
-
-`OpenDaylight JIRA Tickets - Resolved Issue <https://jira.opendaylight.org/issues/?jql=project+%3D+netconf+AND+type+%3D+Bug+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28Silicon%2C+%22Silicon+GA%22%2C+1.13.0%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
+The following table lists the issues resolved in this release.
 
+.. jira_fixed_issues::
+   :project: NETCONF
+   :versions: 2.0.0-2.0.5
 
 Known Issues
 ============
 
-Here is the link to the known issues exist in this release:
+The following table lists the known issues that exist in this release.
+
+.. jira_known_issues::
+   :project: NETCONF
+   :versions: 2.0.0-2.0.5
 
-`OpenDaylight JIRA Tickets - Known Issue <https://jira.opendaylight.org/issues/?jql=project+%3D+netconf+AND+type+%3D+Bug+AND+status+not+in+%28Resolved%2C+Done%2C+Closed%29+ORDER+BY+issuetype+DESC%2C+key+ASC>`_
\ No newline at end of file