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 [3.0.0] - 2021-06-10
  37
  38 * Simplify v2.3.0 notification callback and handle_events API to return received
  39   event(s) only as a list type. Earlier single event was returned as a string type.
  40   Notification callback and handle_events API changes are not backward compatible.
  41
  42 [2.3.0] - 2021-06-09
  43
  44 * Pack all the events in a channel to one DB notification to be in line with SDL Golang.
  45
  46 [2.2.0] - 2021-05-11
  47
  48 * Add DB backend instance selection based on namespace value to balance DB load.
  49
  50 [2.1.1] - 2021-03-09
  51
  52 * Take DBAAS multi-channel publishing Redis modules into use.
  53
  54 [2.1.0] - 2020-08-26
  55
  56 * Add support for notifications
  57
  58 [2.0.4] - 2020-05-13
  59
  60 * Enhance SDL API set() function argument validation to cover also dictionary items.
  61
  62 [2.0.3] - 2020-01-22
  63
  64 * Add a new SDL storage API function `is_active()` to check healthiness of SDL instance.
  65
  66 [2.0.2] - 2020-01-14
  67
  68 * Version bump.
  69
  70 [2.0.1] - 2020-01-13
  71
  72 * Add a fake database backend implementation to be used only for testing
  73   purposes when the real DBAAS database service is not available.
  74
  75 [2.0.0] - 2020-01-03
  76
  77 * Change find_keys() and find_and_get() API functions to support glob-style
  78   regular expression in a key search pattern. API backward incompatible change.
  79 * Remove 'atomic' parameter of find_and_get() API function. API backward
  80   incompatible change.
  81
  82 [1.0.2] - 2019-12-18
  83
  84 * Take Hiredis package into use in Redis database backend.
  85 * Add unit tests for configuration handling.
  86
  87 [1.0.1] - 2019-12-06
  88
  89 * Version bump.
  90
  91 [1.0.0] - 2019-12-05
  92
  93 * First version.
  94
  95
  96
  97
  98 Summary
  99 -------
 100
 101 This is the first version of this package.
 102 It implements RIC Shared Data Layer (SDL) library.
 103
 104
 105
 106
 107 Release Data
 108 ------------
 109 This is the first version of this package.
 110
 111
 112
 113
 114
 115 Feature Additions
 116 ^^^^^^^^^^^^^^^^^
 117
 118
 119 Bug Corrections
 120 ^^^^^^^^^^^^^^^
 121
 122
 123 Deliverables
 124 ^^^^^^^^^^^^
 125
 126 Software Deliverables
 127 +++++++++++++++++++++
 128
 129 This version provides Python package ricsdl.
 130 It can be retrieved from pypi.org.
 131
 132
 133
 134 Documentation Deliverables
 135 ++++++++++++++++++++++++++
 136
 137
 138
 139
 140
 141 Known Limitations, Issues and Workarounds
 142 -----------------------------------------
 143
 144 System Limitations
 145 ^^^^^^^^^^^^^^^^^^
 146
 147
 148
 149 Known Issues
 150 ^^^^^^^^^^^^
 151
 152 Workarounds
 153 ^^^^^^^^^^^
 154
 155
 156
 157
 158
 159 References
 160 ----------