summaryrefslogtreecommitdiffstats
path: root/docs/releasenotes/releasenotes.rst
diff options
context:
space:
mode:
authorromaingimbert <romain.gimbert@orange.com>2018-09-14 14:52:20 +0200
committerromaingimbert <romain.gimbert@orange.com>2018-09-14 14:52:20 +0200
commit8f141d17f3ea7720df479f4ae51b5a2e169548cb (patch)
tree4d309f3d24202153d6ad50dfa41c2d8ee99b70c2 /docs/releasenotes/releasenotes.rst
parent956d451af5e5ad5b5f0bbca34c5462455cc6d0ad (diff)
Add API Documentation for Casablanca
-update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert <romain.gimbert@orange.com>
Diffstat (limited to 'docs/releasenotes/releasenotes.rst')
-rwxr-xr-xdocs/releasenotes/releasenotes.rst122
1 files changed, 122 insertions, 0 deletions
diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
new file mode 100755
index 0000000..1551e3a
--- /dev/null
+++ b/docs/releasenotes/releasenotes.rst
@@ -0,0 +1,122 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2018 ORANGE
+
+Release Notes
+=============
+
+Version: 3.0.0
+--------------
+
+:Release Date: 2018-11-15
+
+**New Features**
+
+Main features are:
+
+- `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API
+- `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC
+- `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API
+- `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB
+- `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC
+- `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails
+- `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Hadd support for progress percentage on ServiceOrder tracking
+
+Detail of features described in the readTheDoc documentation.
+
+**Bug Fixes**
+
+- `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ - NBI should add relationship to tenant when creating service-subscription in AAI
+
+
+**Known Issues**
+
+No new issue (see Beijing ones)
+
+**Security Notes**
+
+To be completed
+
+Quick Links:
+
+- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
+- `Passing Badge information for External API <to be completed>`_
+- `Project Vulnerability Review Table for External API <to be completed>`_
+
+**Upgrade Notes**
+
+To be completed
+
+**Deprecation Notes**
+
+No deprecated feature from Beijing.
+
+**Other**
+
+===========
+
+Version: 1.0.0
+--------------
+
+:Release Date: 2018-06-07
+
+**New Features**
+
+Main features are:
+
+- `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
+- `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
+- `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
+
+Detail of features described in the readTheDoc documentation.
+
+**Bug Fixes**
+
+Not applicable - This is an initial release
+
+**Known Issues**
+
+For service catalog:
+
+- Find criteria are limited
+
+For service inventory:
+
+- Customer information must be passed to get complete service representation.
+- Find criteria are limited.
+
+For service order:
+
+- 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).
+- Only active service state is considered to add a service.
+
+Detail of limitations described in the readTheDoc documentation.
+
+**Security Notes**
+
+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>`_.
+Authentication management and Data Access rights have not been implemented.
+
+Quick Links:
+
+- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_
+- `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_
+- `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_
+
+**Upgrade Notes**
+
+Not applicable - This is an initial release
+
+**Deprecation Notes**
+
+Not applicable - This is an initial release
+
+**Other**
+
+===========
+
+End of Release Notes