Update release notes and docs
[externalapi/nbi.git] / docs / releasenotes / releasenotes.rst
index 9f839e3..ec6cb0b 100755 (executable)
@@ -1,9 +1,134 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 .. Copyright 2019 ORANGE
+.. _release_notes:
 
 Release Notes
 =============
 
+Version: 8.0.1
+--------------
+
+:Release Date: 2021-03-19
+
+Honolulu Release tag - 8.0.1
+
+**Fix**
+
+- `EXTAPI-535 <https://jira.onap.org/browse/EXTAPI-535>`_ - Error in NBI serviceSpecification API 
+
+Details of NBI features for Honolulu are described in the readTheDoc documentation.
+
+https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/index.html#master-index
+
+**Known Issues**
+
+No new issues
+
+**Security Notes**
+
+External API pods security are as requested per TSC must have list
+
+Quick Links:
+
+- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
+
+**Upgrade Notes**
+
+No major API changes. The API Major version is still 4.
+
+
+Version: 7.0.2
+--------------
+
+:Release Date: 2020-11-16
+
+Guilin Release tag - 7.0.2
+
+**Fix**
+
+- `EXTAPI-510 <https://jira.onap.org/browse/EXTAPI-510>`_ - 1 NBI pod has no limit 
+- `EXTAPI-509 <https://jira.onap.org/browse/EXTAPI-509>`_ - NBI has root pods 
+- `EXTAPI-197 <https://jira.onap.org/browse/EXTAPI-197>`_ - MSB registration 
+
+Details of NBI features for Guilin are described in the readTheDoc documentation.
+
+https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/index.html#master-index
+
+**Known Issues**
+
+No new issues
+
+**Security Notes**
+
+Updates may to External API pods security are per TSC must have list
+
+Quick Links:
+
+- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
+
+**Upgrade Notes**
+
+No major API changes. The API Major version is still 4.
+
+
+Version: 6.0.3
+--------------
+
+:Release Date: 2020-06-04
+
+Frankfurt Release tag - 6.0.3
+
+**Fix**
+
+- `OJSI-136 <https://jira.onap.org/browse/OJSI-136>`_ - In default deployment EXTAPI (nbi) exposes HTTP port 30274 outside of cluster.
+- `EXTAPI-347 <https://jira.onap.org/browse/EXTAPI-347>`_ - Move to mariadb galera instead of mariadb 
+- `EXTAPI-222 <https://jira.onap.org/browse/EXTAPI-222>`_ - Add support for HTTPS with AAF artefacts 
+- `EXTAPI-294 <https://jira.onap.org/browse/EXTAPI-294>`_ - Add support for Service Orders using new "Object" type 
+- `EXTAPI-304 <https://jira.onap.org/browse/EXTAPI-304>`_ - Update SO request to use GR_API instead of VNF_API 
+- `EXTAPI-342 <https://jira.onap.org/browse/EXTAPI-342>`_ - NBI to SO: new URL and new Header params 
+- `EXTAPI-343 <https://jira.onap.org/browse/EXTAPI-343>`_ - NBI to SO: cloudowner value to be taken from application.properties 
+- `EXTAPI-258 <https://jira.onap.org/browse/EXTAPI-258>`_ - Identify whether the Service is of A-la-carte or macro type 
+- `EXTAPI-370 <https://jira.onap.org/browse/EXTAPI-370>`_ - Java 11 & oparent 3.0.0-SNAPSHOT 
+- `EXTAPI-378 <https://jira.onap.org/browse/EXTAPI-378>`_ - Update swagger based on spectral 
+- `EXTAPI-384 <https://jira.onap.org/browse/EXTAPI-384>`_ - SECCOM Java 11 migration from v8 [REQ-219] in NBI 
+- `EXTAPI-397 <https://jira.onap.org/browse/EXTAPI-397>`_ - Update Service Order Swagger to align to ONAP Style Guidelines
+- `EXTAPI-399 <https://jira.onap.org/browse/EXTAPI-399>`_ - Fix Docker File Image to point to correct base and use 3.0.0 in pom
+- `EXTAPI-400 <https://jira.onap.org/browse/EXTAPI-400>`_ - Migrate and Fix sonarcloud code coverage issue
+- `EXTAPI-401 <https://jira.onap.org/browse/EXTAPI-401>`_ - remove sonar.jacoco.reportMissing.force.zero 
+- `EXTAPI-415 <https://jira.onap.org/browse/EXTAPI-415>`_ - Configure NBI with http xor https support, using basic spring capabilities 
+- `EXTAPI-417 <https://jira.onap.org/browse/EXTAPI-417>`_ - Support http local docker and https OOM via Env Variable 
+- `EXTAPI-423 <https://jira.onap.org/browse/EXTAPI-423>`_ - Check for CST template is case sensitive 
+- `EXTAPI-424 <https://jira.onap.org/browse/EXTAPI-424>`_ - Public HTTP port open 
+- `EXTAPI-427 <https://jira.onap.org/browse/EXTAPI-427>`_ - DMaap https port enable 
+
+Detail of NBI features are described in the readTheDoc documentation.
+
+https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/index.html
+
+
+**Known Issues**
+
+No new issues
+
+**Security Notes**
+
+In the Frankfurt release, External API has been updated to expose a https interface via OOM installations, in response to OJSI-136. 
+NBI has also upgraded to Java 11, using the base registry.gitlab.com/onap-integration/docker/onap-java image. 
+
+Quick Links:
+
+- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
+
+**Upgrade Notes**
+
+No major API changes. The API Major version is still 4.
+
+/nbi/api/v4
+
+Frankfurt API version is 4.1.0 i.e. Minor API changes only,  as most changes are related to security updates. No new APIs.
+Swagger changes are mainly in the use of additional markdown for API understanding and conformance to ONAP API Swagger Style Guidelines 
+https://wiki.onap.org/pages/viewpage.action?pageId=71834147
+
 Version: 5.0.1
 --------------
 
@@ -250,7 +375,7 @@ For service inventory:
 
 For service order:
 
-- ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change).
+- ServiceOrder will manage only 'add' and 'delete' operation (no change).
 - Only service level request is performed.
 - No request for VNF/VF and no call to SDNC.
 - `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue).