Update links to Dublin vulnerability report in Release Note
[externalapi/nbi.git] / docs / releasenotes / releasenotes.rst
1 .. SPDX-License-Identifier: CC-BY-4.0
2 .. Copyright 2019 ORANGE
3
4 Release Notes
5 =============
6
7 Version: 4.0.0
8 --------------
9
10 :Release Date: 2018-05-30
11
12 **New Features**
13
14 Main features are:
15
16 Detail of features described in readTheDoc documentation.
17
18 **Known Issues**
19
20
21 **Security Notes**
22
23 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
24
25 Quick Links:
26
27 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
28
29 **Upgrade Notes**
30
31
32 **Deprecation Notes**
33
34
35 **Other**
36
37 ===========
38
39 Version: 3.0.2
40 --------------
41
42 :Release Date: 2019-01-31
43
44 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
45
46 **Fix**
47
48 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
49 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
50
51 Detail of features described in the readTheDoc documentation.
52
53 **Known Issues**
54
55 No new issues
56
57 **Security Notes**
58
59 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
60
61 Quick Links:
62
63 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
64
65
66 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
67
68 ===========
69
70 Version: 3.0.1
71 --------------
72
73 :Release Date: 2018-11-30
74
75 **New Features**
76
77 Main features are:
78
79 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
80 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
81 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
82 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
83 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
84 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
85 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
86
87 Detail of features described in the readTheDoc documentation.
88
89 **Known Issues**
90
91 No new issue (see Beijing ones)
92
93 **Security Notes**
94
95 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
96
97 Quick Links:
98
99 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
100
101 **Upgrade Notes**
102
103 No upgrade available from Beijing
104
105 **Deprecation Notes**
106
107 NA
108
109 **Other**
110
111 ===========
112
113 Version: 1.0.0
114 --------------
115
116 :Release Date: 2018-06-07
117
118 **New Features**
119
120 Main features are:
121
122 - `EXTAPI-39 <https://jira.onap.org/browse/EXTAPI-39>`_ - Retrieve SDC information (catalog information) for service level artifacts based on TMF633 open APIs - operation GET
123 - `EXTAPI-41 <https://jira.onap.org/browse/EXTAPI-41>`_ - Retrieve AAI information (inventory information) for service instance level artifacts based on TMF638 open APIs - operation GET
124 - `EXTAPI-42 <https://jira.onap.org/browse/EXTAPI-42>`_ - Create and retrieve SO service request for service level based on TMF641 open APIS - Operations POST & GET
125
126 Detail of features described in the readTheDoc documentation.
127
128 **Bug Fixes**
129
130 Not applicable - This is an initial release
131
132 **Known Issues**
133
134 For service catalog:
135
136 - Find criteria are limited
137
138 For service inventory:
139
140 - Customer information must be passed to get complete service representation.
141 - Find criteria are limited.
142
143 For service order:
144
145 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
146 - Only service level request is performed.
147 - No request for VNF/VF and no call to SDNC.
148 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
149 - Only active service state is considered to add a service.
150
151 Detail of limitations described in the readTheDoc documentation.
152
153 **Security Notes**
154
155 External API code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The External API open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_.
156 Authentication management and Data Access rights have not been implemented.
157
158 Quick Links:
159
160 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
161 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
162 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
163
164 **Upgrade Notes**
165
166 Not applicable - This is an initial release
167
168 **Deprecation Notes**
169
170 Not applicable - This is an initial release
171
172 **Other**
173
174 ===========
175
176 End of Release Notes