Merge "Use specific RTD link to SDL documentation"
[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.0.4] - 2020-05-13
37
38 * Enhance SDL API set() function argument validation to cover also dictionary items.
39
40 [2.0.3] - 2020-01-22
41
42 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
43
44 [2.0.2] - 2020-01-14
45
46 * Version bump.
47
48 [2.0.1] - 2020-01-13
49
50 * Add a fake database backend implementation to be used only for testing
51   purposes when the real DBAAS database service is not available.
52
53 [2.0.0] - 2020-01-03
54
55 * Change find_keys() and find_and_get() API functions to support glob-style
56   regular expression in a key search pattern. API backward incompatible change.
57 * Remove 'atomic' parameter of find_and_get() API function. API backward
58   incompatible change.
59
60 [1.0.2] - 2019-12-18
61
62 * Take Hiredis package into use in Redis database backend.
63 * Add unit tests for configuration handling.
64
65 [1.0.1] - 2019-12-06
66
67 * Version bump.
68
69 [1.0.0] - 2019-12-05
70
71 * First version.
72
73
74
75
76 Summary
77 -------
78
79 This is the first version of this package.
80 It implements RIC Shared Data Layer (SDL) library.
81
82
83
84
85 Release Data
86 ------------
87 This is the first version of this package.
88
89
90
91
92
93 Feature Additions
94 ^^^^^^^^^^^^^^^^^
95
96
97 Bug Corrections
98 ^^^^^^^^^^^^^^^
99
100
101 Deliverables
102 ^^^^^^^^^^^^
103
104 Software Deliverables
105 +++++++++++++++++++++
106
107 This version provides Python package ricsdl.
108 It can be retrieved from pypi.org.
109
110
111
112 Documentation Deliverables
113 ++++++++++++++++++++++++++
114
115
116
117
118
119 Known Limitations, Issues and Workarounds
120 -----------------------------------------
121
122 System Limitations
123 ^^^^^^^^^^^^^^^^^^
124
125
126
127 Known Issues
128 ^^^^^^^^^^^^
129
130 Workarounds
131 ^^^^^^^^^^^
132
133
134
135
136
137 References
138 ----------
139
140