Update 2023.09 Chlorine SR3 release notes
[docs.git] / docs / release-notes / projects / mdsal.rst
index b6a90641ba0580c71e1ed0c13b3bf3dffbbc2bfb..7834ef79f38ab29c8a7cfd28995b169aa5a72d37 100644 (file)
@@ -13,52 +13,31 @@ for providing YANG-defined interaction patterns:
 
 Behavior/Feature Changes
 ========================
-The Binding mapping of ``leaf-list`` YANG statement has been updated to correctly take into account
-the ``ordered-by`` statement. The default, ``ordered-by system``, leaf-lists are now presented
-as ``java.util.Set``. This matches their semantics in terms of ``hashCode()`` and ``equals()`` methods.
-The mapping to ``java.util.List`` is maintained for ``ordered-by user`` leaf-lists.
+The Binding mapping of ``type identityref`` YANG statement has been updated to use singleton objects
+instead of corresponding ``.class`` references. These singleton objects are exposed as ``VALUE`` constants,
+hence the migration is a straightforward move from ``Foo.class`` to ``Foo.VALUE``.
 
-The Binding mapping of ``type decimal64`` has been updated to use ``org.opendaylight.yangtools.yang.common.Decimal64``
-instead of ``java.math.BigDecimal``. This offers an exact match in value semantics, which were not
-previously correctly enforced.
+Binding classes generated for ``type enumeration`` YANG statement now have ``ofName()`` and ``ofValue()``
+methods, which return a non-null object or throw an ``IllegalArgumentException``.
 
-The ``InstanceIdentifier`` class has been updated to reject attempts to form invalid identifiers, such
-as using a ``Notification`` class as a path argument.
-
-Builder classes generated by the Binding code generator no longer implement
-``org.opendaylight.yangtools.concepts.Builder``. While this removes the ability to treat their ``build()``
-methods in micro-frameworks, it also improves call site visibility, leading to better experience when
-refactoring code.
-
-The ``iana-if-type.yang`` model has been updated to revision 2021-06-21.
-
-The ``iana-routing-types.yang`` model has been updated to revision 2021-10-19.
+The ``feature`` YANG statement now has a representation in Binding: it is a final class which subclasses
+``YangFeature`` with a singleton value.
 
 New Features
 ============
-No new features.
+Both ``DOMNotificationService`` and ``NotificationService`` have gained the ability to register single-type
+and flexible multi-type notification listerners. This change allows Binding users to implement only specific
+listeners, unlike the previous method of using generated interfaces extending ``NotificationListener`` -- which
+required implementation of methods for every notification defined in a specific module.
 
 Deprecated Features
 ===================
-No deprecated features.
+``NotificationService.registerNotificationListener()`` method has been deprecated, along with its Binding
+specification interfaces based on ``NotificationListener``. These will be removed in the next major release.
 
 Removed Features
 ===================
-The model for RFC7223 version of ``ietf-interfaces.yang`` has been removed. This model has been
-obsoleted by the RFC8343 version.
-
-The model for RFC7277 version of ``ietf-ip.yang`` has been removed. This model has been superseded
-by the RFC8344 version.
-
-The model for RFC7895 version of ``ietf-yang-library.yang`` and the corresponding support code has been
-removed. This model has been superseded by the RFC8525 version, which provides sufficient compatibility
-for OpenDaylight scenarios.
-
-``AssertDataObjects`` utilities have been removed, as they depend on Xtend and a dormant upstream and
-are not used anywhere in OpenDaylight.
-
-The unused ``unified-html-generator`` code generation plugin has been removed. It has never been
-productized or used in default configuration.
+No removed features.
 
 Resolved Issues
 ===============
@@ -66,7 +45,7 @@ The following table lists the issues resolved in this release.
 
 .. jira_fixed_issues::
    :project: MDSAL
-   :versions: 9.0.0-9.0.1
+   :versions: 10.0.0-10.0.2
 
 Known Issues
 ============
@@ -74,4 +53,52 @@ The following table lists the known issues that exist in this release.
 
 .. jira_known_issues::
    :project: MDSAL
-   :versions: 9.0.0-9.0.1
+   :versions: 10.0.0-10.0.2
+
+Resolved Issues in SR1
+======================
+The following table lists the issues resolved in Service Release 1.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.3-10.0.5
+
+Known Issues in SR1
+===================
+The following table lists the known issues that exist in Service Release 1.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.3-10.0.5
+
+Resolved Issues in SR2
+======================
+The following table lists the issues resolved in Service Release 2.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.6-10.0.6
+
+Known Issues in SR2
+===================
+The following table lists the known issues that exist in Service Release 2.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.6-10.0.6
+
+Resolved Issues in SR3
+======================
+The following table lists the issues resolved in Service Release 3.
+
+.. jira_fixed_issues::
+   :project: MDSAL
+   :versions: 10.0.7-10.0.7
+
+Known Issues in SR3
+===================
+The following table lists the known issues that exist in Service Release 3.
+
+.. jira_known_issues::
+   :project: MDSAL
+   :versions: 10.0.7-10.0.7