Add release notes for Chlorine SR1 MRI projects
[docs.git] / docs / release-notes / projects / yangtools.rst
1 ==========
2 YANG Tools
3 ==========
4
5 Overview
6 ========
7 YANG Tools provides a set of libraries to deal with YANG models and data modeled using them.
8
9 Behavior/Feature Changes
10 ========================
11 ``ImmutableOffsetMap`` and ``SingletonSet`` classes now use the Serialization Proxy Pattern,
12 improving their serialization footprint.
13
14 A large number of abstract classes and interfaces not intended to be directly subclasses/implemented
15 are now ``sealed``. This results in better API definitions and provides a clearer guidance to users.
16 This change also means these can no longer be mocked through Mockito and similar frameworks. Users
17 are advised to use concrete implementations instead.
18
19 New Features
20 ============
21 YANG Parser now supports the ``module-tag`` as defined in `RFC819 <https://www.rfc-editor.org/rfc/rfc8819.html>`__.
22
23 Removed Features
24 ================
25 The ``CheckedBuilder`` and ``Builder`` concepts have been removed in this release.
26
27 The ``IllegalArgumentCodec`` concept has been removed in this release.
28
29 The support for resolving inter-module dependencies based on semantic version has been removed.
30
31 Deprecated Features
32 ===================
33 Code generation plugin APIs for ``yang-maven-plugin`` contained in the ``yang-maven-plugin-spi``
34 artifact are deprecated and will be removed in the next major release. Their replacement live
35 in maven-agnostic ``plugin-generator-api``.
36
37 The ``SchemaPath`` class has been deprecated and will be removed in the next major release. Please
38 use its correct replacements, ``SchemaNodeIdentifier`` and ``EffectiveStatementInference``, which
39 provide more powerful capabilities.
40
41 Resolved Issues
42 ===============
43 The following table lists the issues resolved in this release.
44
45 .. jira_fixed_issues::
46    :project: YANGTOOLS
47    :versions: 9.0.0-9.0.1
48
49 Known Issues
50 ============
51 The following table lists the known issues that exist in this release.
52
53 .. jira_known_issues::
54    :project: YANGTOOLS
55    :versions: 9.0.0-9.0.1
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: YANGTOOLS
63    :versions: 9.0.2-9.0.2
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: YANGTOOLS
71    :versions: 9.0.2-9.0.2