Rephrase release notes introduction
[ric-plt/streaming-protobufs.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 Release-Notes
20 =============
21
22 This document provides the release notes of the streaming-protobufs.
23
24 .. contents::
25    :depth: 3
26    :local:
27
28
29
30 Version history
31 ---------------
32
33 [6.0.0] - 2020-04-30
34
35 * Renamed RRC event trigger EventA3 configuration's a3_Threshold parameter
36   name to a3_Offset and change parameter type to MeasTriggerQuantityOffset.
37
38 [5.0.0] - 2020-04-22
39
40 * Fixed CSI-MeasConfig configuration under ServingCellConfig to be optional.
41
42 [4.0.3] - 2020-04-15
43
44 * Added git extension to Golang streaming_protobufs module path name.
45
46 [4.0.2] - 2020-04-15
47
48 * Moved Golang source code generated from '.proto' files to new subdirectory
49   go/streaming_protobufs to be in line with the Go package name of Protobufs.
50
51 [4.0.1] - 2020-04-15
52
53 * Add Golang module files.
54
55 [4.0.0] - 2020-04-14
56
57 * Changed scg-CellGroupConfig parameter type from Bytes to RRCReconfiguration
58   to describe SCG configuration as a Protobuf structure. Moved all '.proto'
59   files from streaming-protobufs root directory to proto subdirectory. Added
60   Golang source code generated from '.proto' files into the repository.
61
62 [3.0.0] - 2020-02-14
63
64 * Changed all parameters string types to bytes type except parameters 'gNbID'
65   and 'protobuf_revision' types in x2ap_streaming.proto file were still left
66   a string type.
67
68 [2.0.0] - 2020-01-16
69
70 * Changed SgNB UE X2AP ID to be an optional IE in SGNB ADDITION REQUEST REJECT
71   to be compatible with 3GPP 36.423 standard. API backward incompatible change.
72
73 [1.0.0] - 2020-01-14
74
75 * Fixed overlapping declaration error hit in Golang data structures, which
76   were generated from SGNB CHANGE CONFIRM protobuf message. API backward
77   incompatible change.
78
79 [0.2.3] - 2019-12-18
80
81 * Implement Protobuf schema for following X2AP messages:
82
83   * SGNB CHANGE REQUIRED
84   * SGNB CHANGE CONFIRM
85   * SGNB CHANGE REFUSE
86   * SGNB ACTIVITY NOTIFICATION
87   * GNB STATUS INDICATION
88
89 [0.2.2] - 2019-11-14
90
91 * Add mandatory documentation files.
92 * Fix Protobuf version number in x2ap_streaming.proto file.
93
94 [0.2.1] - 2019-10-16
95
96 * Fix protobuf definition of PLMN-Identity-EUTRA-5GC.
97
98 [0.2.0] - 2019-10-11
99
100 * Initial version.
101 * Implement Protobuf schema for following X2AP messages:
102
103   * SGNB ADDITION REQUEST
104   * SGNB ADDITION REQUEST ACKNOWLEDGE
105   * SGNB ADDITION REQUEST REJECT
106   * SGNB RECONFIGURATION COMPLETE
107   * RRC TRANSFER
108   * UE CONTEXT RELEASE
109   * SGNB RELEASE REQUEST
110   * SGNB RELEASE REQUEST ACKNOWLEDGE
111   * SGNB RELEASE REQUIRED
112   * SGNB RELEASE CONFIRM
113   * SGNB MODIFICATION REQUEST
114   * SGNB MODIFICATION REQUEST REJECT
115   * SGNB MODIFICATION REQUEST ACKNOWLEDGE
116   * SGNB MODIFICATION REQUIRED
117   * SGNB MODIFICATION CONFIRM
118   * SGNB MODIFICATION REFUSE
119   * SN STATUS TRANSFER
120   * SECONDARY RAT DATA USAGE REPORT