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