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