Pack notifications to be compatible with SDL golang
[ric-plt/sdlpy.git] / docs / release-notes.rst
1 ..
2 ..  Copyright (c) 2019 AT&T Intellectual Property.
3 ..  Copyright (c) 2019 Nokia.
4 ..
5 ..  Licensed under the Creative Commons Attribution 4.0 International
6 ..  Public License (the "License"); you may not use this file except
7 ..  in compliance with the License. You may obtain a copy of the License at
8 ..
9 ..    https://creativecommons.org/licenses/by/4.0/
10 ..
11 ..  Unless required by applicable law or agreed to in writing, documentation
12 ..  distributed under the License is distributed on an "AS IS" BASIS,
13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ..
15 ..  See the License for the specific language governing permissions and
16 ..  limitations under the License.
17 ..
18
19
20 Release Notes
21 =============
22
23
24 This document provides the release notes of the ricsdl library.
25
26 .. contents::
27    :depth: 3
28    :local:
29
30
31
32
33 Version history
34 ---------------
35
36 [2.3.0] - 2021-06-09
37
38 * Pack all the events in a channel to one DB notification to be in line with SDL Golang.
39
40 [2.2.0] - 2021-05-11
41
42 * Add DB backend instance selection based on namespace value to balance DB load.
43
44 [2.1.1] - 2021-03-09
45
46 * Take DBAAS multi-channel publishing Redis modules into use.
47
48 [2.1.0] - 2020-08-26
49
50 * Add support for notifications
51
52 [2.0.4] - 2020-05-13
53
54 * Enhance SDL API set() function argument validation to cover also dictionary items.
55
56 [2.0.3] - 2020-01-22
57
58 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
59
60 [2.0.2] - 2020-01-14
61
62 * Version bump.
63
64 [2.0.1] - 2020-01-13
65
66 * Add a fake database backend implementation to be used only for testing
67   purposes when the real DBAAS database service is not available.
68
69 [2.0.0] - 2020-01-03
70
71 * Change find_keys() and find_and_get() API functions to support glob-style
72   regular expression in a key search pattern. API backward incompatible change.
73 * Remove 'atomic' parameter of find_and_get() API function. API backward
74   incompatible change.
75
76 [1.0.2] - 2019-12-18
77
78 * Take Hiredis package into use in Redis database backend.
79 * Add unit tests for configuration handling.
80
81 [1.0.1] - 2019-12-06
82
83 * Version bump.
84
85 [1.0.0] - 2019-12-05
86
87 * First version.
88
89
90
91
92 Summary
93 -------
94
95 This is the first version of this package.
96 It implements RIC Shared Data Layer (SDL) library.
97
98
99
100
101 Release Data
102 ------------
103 This is the first version of this package.
104
105
106
107
108
109 Feature Additions
110 ^^^^^^^^^^^^^^^^^
111
112
113 Bug Corrections
114 ^^^^^^^^^^^^^^^
115
116
117 Deliverables
118 ^^^^^^^^^^^^
119
120 Software Deliverables
121 +++++++++++++++++++++
122
123 This version provides Python package ricsdl.
124 It can be retrieved from pypi.org.
125
126
127
128 Documentation Deliverables
129 ++++++++++++++++++++++++++
130
131
132
133
134
135 Known Limitations, Issues and Workarounds
136 -----------------------------------------
137
138 System Limitations
139 ^^^^^^^^^^^^^^^^^^
140
141
142
143 Known Issues
144 ^^^^^^^^^^^^
145
146 Workarounds
147 ^^^^^^^^^^^
148
149
150
151
152
153 References
154 ----------