docs/releasenotes/releasenotes.rst

   1 .. SPDX-License-Identifier: CC-BY-4.0
   2 .. Copyright 2019 ORANGE
   3
   4 Release Notes
   5 =============
   6
   7 Version: 4.0.0
   8 --------------
   9
  10 :Release Date: 2019-05-30
  11
  12 New major version v4 for the API, see Upgrade Notes
  13
  14 Dedicated Postman collection can be found in the integration project see `test/postman <https://git.onap.org/integration/tree/test/postman?h=dublin>`_
  15
  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.
  17
  18 **New Features**
  19
  20 Main new features are supports of
  21
  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>`_
  24
  25 Main functional changes for BBS:
  26
  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`
  29
  30 Main functional change for CCVPN
  31
  32 - `EXTAPI-182 <https://jira.onap.org/browse/EXTAPI-182>`_ - Create SO -> ExtAPI interface`
  33
  34 Many other changes and improvement are listed in JIRA:
  35
  36 - `All Dublin issues <https://jira.onap.org/issues/?filter=11786>`_
  37
  38 **Known Issues**
  39
  40 - `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - Bad hostname while registering on MSB`
  41
  42 Will be fixed in the next release El Alto
  43
  44 **Security Notes**
  45
  46 NBI still exposes non TLS API endpoint. TLS will be proposed in next the release, El Alto.
  47
  48 NBI has been improved to reduce signs of vulnerabilities, especially by migrating from Springboot 1.x to Springboot 2 and using the ONAP Parent pom.xml
  49
  50 - `Dublin Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=51282484>`_
  51
  52 Quick Links:
  53
  54 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
  55
  56 **Upgrade Notes**
  57
  58 API is a new MAJOR v4 version due to the deletion of the 'hasStarted' attribute from getServiceById response
  59 GET /service/{id}
  60
  61 So don't forget to use this new path:
  62
  63 /nbi/api/v4
  64
  65 before:
  66
  67 /nbi/api/v3
  68
  69 **Deprecation Notes**
  70
  71 API v3 is deprecated
  72
  73 **Other**
  74
  75 ===========
  76
  77 Version: 3.0.2
  78 --------------
  79
  80 :Release Date: 2019-01-31
  81
  82 Part of Casablanca Maintenance Release tag - 3.0.1 January 31st, 2019
  83
  84 **Fix**
  85
  86 - `EXTAPI-164 <https://jira.onap.org/browse/EXTAPI-164>`_ - Start up failed without msb
  87 - `EXTAPI-172 <https://jira.onap.org/browse/EXTAPI-172>`_ - Multiple service orders in a single request
  88
  89 Detail of features described in the readTheDoc documentation.
  90
  91 **Known Issues**
  92
  93 No new issues
  94
  95 **Security Notes**
  96
  97 - `Casablanca Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45310585>`_
  98
  99 Quick Links:
 100
 101 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 102
 103
 104 https://wiki.onap.org/pages/viewpage.action?pageId=51282484
 105
 106 ===========
 107
 108 Version: 3.0.1
 109 --------------
 110
 111 :Release Date: 2018-11-30
 112
 113 **New Features**
 114
 115 Main features are:
 116
 117 - `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
 118 - `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
 119 - `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
 120 - `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
 121 - `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
 122 - `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
 123 - `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Add support for progress percentage on ServiceOrder tracking
 124
 125 Detail of features described in the readTheDoc documentation.
 126
 127 **Known Issues**
 128
 129 No new issue (see Beijing ones)
 130
 131 **Security Notes**
 132
 133 - `Vulnerability Report <https://wiki.onap.org/pages/viewpage.action?pageId=45301150>`_
 134
 135 Quick Links:
 136
 137 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 138
 139 **Upgrade Notes**
 140
 141 No upgrade available from Beijing
 142
 143 **Deprecation Notes**
 144
 145 NA
 146
 147 **Other**
 148
 149 ===========
 150
 151 Version: 1.0.0
 152 --------------
 153
 154 :Release Date: 2018-06-07
 155
 156 **New Features**
 157
 158 Main features are:
 159
 160 - `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
 161 - `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
 162 - `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
 163
 164 Detail of features described in the readTheDoc documentation.
 165
 166 **Bug Fixes**
 167
 168 Not applicable - This is an initial release
 169
 170 **Known Issues**
 171
 172 For service catalog:
 173
 174 - Find criteria are limited
 175
 176 For service inventory:
 177
 178 - Customer information must be passed to get complete service representation.
 179 - Find criteria are limited.
 180
 181 For service order:
 182
 183 - ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
 184 - Only service level request is performed.
 185 - No request for VNF/VF and no call to SDNC.
 186 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).
 187 - Only active service state is considered to add a service.
 188
 189 Detail of limitations described in the readTheDoc documentation.
 190
 191 **Security Notes**
 192
 193 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>`_.
 194 Authentication management and Data Access rights have not been implemented.
 195
 196 Quick Links:
 197
 198 - `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
 199 - `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
 200 - `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
 201
 202 **Upgrade Notes**
 203
 204 Not applicable - This is an initial release
 205
 206 **Deprecation Notes**
 207
 208 Not applicable - This is an initial release
 209
 210 **Other**
 211
 212 ===========
 213
 214 End of Release Notes