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
42 - `EXTAPI-249 <https://jira.onap.org/browse/EXTAPI-249>`_ - Change to oom dockers causing permissions failing when tosca parsing
44 EXTAPI-249 has limited impact on BBS use case:
45 GET /serviceSpecification{id}
46 returns empty serviceSpecCharacteristic.
50 *Fixed Security Issues*
52 NBI has been improved to reduce signs of vulnerabilities,
53 especially by migrating from Springboot 1.x to Springboot 2 and using ONAP Parent pom.xml
55 *Known Security Issues*
57 - `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
58 NBI exposes non TLS API endpoint on port 30274, meaning full plain text exchange with NBI API.
59 TLS configuration, with ONAP Root CA signed certificate will be proposed in El Alto.
61 As a workaround it is quite easy to add HTTPS support to NBI by configuring SSL and activating strict https.
62 Presuming you have a valid JKS keystore, with private key and a signed certificate:
66 src/main/resources/application.properties
71 server.ssl.key-store-type=JKS
72 server.ssl.key-store=classpath:certificate/yourkeystore.jks
73 server.ssl.key-store-password=password
74 server.ssl.key-alias=youralias
76 # disable http and activate https
77 security.require-ssl=true
79 *Known Vulnerabilities in Used Modules*
81 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
85 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
89 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
92 So don't forget to use this new path:
100 **Deprecation Notes**
111 :Release Date: 2019-01-31
113 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
117 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
118 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
120 Detail of features described in the readTheDoc documentation.
128 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
132 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
135 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
142 :Release Date: 2018-11-30
148 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
149 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
150 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
151 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
152 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
153 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
154 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
156 Detail of features described in the readTheDoc documentation.
160 No new issue (see Beijing ones)
164 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
168 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
172 No upgrade available from Beijing
174 **Deprecation Notes**
185 :Release Date: 2018-06-07
191 - `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
192 - `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
193 - `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
195 Detail of features described in the readTheDoc documentation.
199 Not applicable - This is an initial release
205 - Find criteria are limited
207 For service inventory:
209 - Customer information must be passed to get complete service representation.
210 - Find criteria are limited.
214 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
215 - Only service level request is performed.
216 - No request for VNF/VF and no call to SDNC.
217 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
218 - Only active service state is considered to add a service.
220 Detail of limitations described in the readTheDoc documentation.
224 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>`_.
225 Authentication management and Data Access rights have not been implemented.
229 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
230 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
231 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
235 Not applicable - This is an initial release
237 **Deprecation Notes**
239 Not applicable - This is an initial release