Report ReadTheDoc from Casablanca to Master
[externalapi/nbi.git] / docs / releasenotes / releasenotes.rst
1 .. SPDX-License-Identifier: CC-BY-4.0
2 .. Copyright 2018 ORANGE
3
4 Release Notes
5 =============
6
7 Version: 3.0.2
8 --------------
9
10 :Release Date: 2019-01-31
11
12 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
13
14 **Fix**
15
16 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
17 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
18
19 Detail of features described in the readTheDoc documentation.
20
21 **Known Issues**
22
23 No new issues
24
25 **Security Notes**
26
27 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
28
29 Quick Links:
30
31 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
32
33
34
35 Version: 3.0.1
36 --------------
37
38 :Release Date: 2018-11-30
39
40 **New Features**
41
42 Main features are:
43
44 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
45 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
46 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
47 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
48 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
49 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
50 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
51
52 Detail of features described in the readTheDoc documentation.
53
54 **Known Issues**
55
56 No new issue (see Beijing ones)
57
58 **Security Notes**
59
60 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
61
62 Quick Links:
63
64 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
65
66 **Upgrade Notes**
67
68 No upgrade available from Beijing
69
70 **Deprecation Notes**
71
72 NA
73
74 **Other**
75
76 ===========
77
78 Version: 1.0.0
79 --------------
80
81 :Release Date: 2018-06-07
82
83 **New Features**
84
85 Main features are:
86
87 - `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
88 - `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
89 - `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
90
91 Detail of features described in the readTheDoc documentation.
92
93 **Bug Fixes**
94
95 Not applicable - This is an initial release
96
97 **Known Issues**
98
99 For service catalog:
100
101 - Find criteria are limited
102
103 For service inventory:
104
105 - Customer information must be passed to get complete service representation.
106 - Find criteria are limited.
107
108 For service order:
109
110 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
111 - Only service level request is performed.
112 - No request for VNF/VF and no call to SDNC.
113 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
114 - Only active service state is considered to add a service.
115
116 Detail of limitations described in the readTheDoc documentation.
117
118 **Security Notes**
119
120 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>`_.
121 Authentication management and Data Access rights have not been implemented.
122
123 Quick Links:
124
125 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
126 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
127 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
128
129 **Upgrade Notes**
130
131 Not applicable - This is an initial release
132
133 **Deprecation Notes**
134
135 Not applicable - This is an initial release
136
137 **Other**
138
139 ===========
140
141 End of Release Notes