1 .. SPDX-License-Identifier: CC-BY-4.0
2 .. Copyright 2019 ORANGE
10 :Release Date: 2019-05-30
12 New major version v4 for the API, see Upgrade Notes
14 Dedicated Postman collection can be found in the integration project see `test/postman <https://git.onap.org/integration/tree/test/postman?h=dublin>`_
16 All tests suites have been re written in Karate, see `src/test/resources/karatetest <https://git.onap.org/externalapi/nbi/tree/src/test/resources/karatetest?h=dublin>`_ for inspiration.
20 Main new features are supports of
22 - `BroadBand Service Use Case ( BBS ) <https://wiki.onap.org/pages/viewpage.action?pageId=45297636>`_
23 - `Cross Domain and Cross Layer VPN ( CCVPN ) <https://wiki.onap.org/display/DW/CCVPN%28Cross+Domain+and+Cross+Layer+VPN%29+USE+CASE>`_
25 Main functional changes for BBS:
27 - `EXTAPI-98 <https://jira.onap.org/browse/EXTAPI-98>`_ - Service inventory notification`
28 - `EXTAPI-161 <https://jira.onap.org/browse/EXTAPI-161>`_ - New service specificationInputSchemas operation`
30 Main functional change for CCVPN
32 - `EXTAPI-182 <https://jira.onap.org/browse/EXTAPI-182>`_ - Create SO -> ExtAPI interface`
34 Many other changes and improvement are listed in JIRA:
36 - `All Dublin issues <https://jira.onap.org/issues/?filter=11786>`_
40 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - Bad hostname while registering on MSB`
41 - `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS`
45 NBI has been improved to reduce signs of vulnerabilities,
46 especially by migrating from Springboot 1.x to Springboot 2 and using ONAP Parent pom.xml
48 Warning: NBI exposes non TLS API endpoint on port 30274, meaning full plain text exchange with NBI API.
49 TLS configuration, with ONAP Root CA signed certificate will be proposed in El Alto.
51 As a workaround it is quite easy to add HTTPS support to NBI by configuring SSL and activating strict https.
52 Presuming you have a valid JKS keystore, with private key and a signed certificate:
56 src/main/resources/application.properties
61 server.ssl.key-store-type=JKS
62 server.ssl.key-store=classpath:certificate/yourkeystore.jks
63 server.ssl.key-store-password=password
64 server.ssl.key-alias=youralias
66 # disable http and activate https
67 security.require-ssl=true
69 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
73 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
77 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
80 So don't forget to use this new path:
99 :Release Date: 2019-01-31
101 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
105 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
106 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
108 Detail of features described in the readTheDoc documentation.
116 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
120 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
123 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
130 :Release Date: 2018-11-30
136 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
137 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
138 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
139 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
140 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
141 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
142 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
144 Detail of features described in the readTheDoc documentation.
148 No new issue (see Beijing ones)
152 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
156 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
160 No upgrade available from Beijing
162 **Deprecation Notes**
173 :Release Date: 2018-06-07
179 - `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
180 - `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
181 - `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
183 Detail of features described in the readTheDoc documentation.
187 Not applicable - This is an initial release
193 - Find criteria are limited
195 For service inventory:
197 - Customer information must be passed to get complete service representation.
198 - Find criteria are limited.
202 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
203 - Only service level request is performed.
204 - No request for VNF/VF and no call to SDNC.
205 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
206 - Only active service state is considered to add a service.
208 Detail of limitations described in the readTheDoc documentation.
212 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>`_.
213 Authentication management and Data Access rights have not been implemented.
217 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
218 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
219 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
223 Not applicable - This is an initial release
225 **Deprecation Notes**
227 Not applicable - This is an initial release