From dc7588271af715296f53a4528cf7195eabf95be0 Mon Sep 17 00:00:00 2001 From: Dan Timoney Date: Wed, 8 Nov 2017 20:27:44 -0500 Subject: [PATCH] Add release notes Add release notes and restructure readthedocs documentation for SDNC Change-Id: I22eaedde119a49e67f241274cfa376788e382681 Issue-ID: SDNC-72 Signed-off-by: Dan Timoney Former-commit-id: 7dadacb67020f018f1e1f151aced2e9fca2759df --- docs/apis/genericresource.rst | 4 ++++ docs/apis/vnfapi.rst | 4 ++++ docs/offeredapis.rst | 6 +++++- docs/release-notes.rst | 30 +++++++++++++----------------- 4 files changed, 26 insertions(+), 18 deletions(-) create mode 100644 docs/apis/genericresource.rst create mode 100644 docs/apis/vnfapi.rst diff --git a/docs/apis/genericresource.rst b/docs/apis/genericresource.rst new file mode 100644 index 00000000..11a165f1 --- /dev/null +++ b/docs/apis/genericresource.rst @@ -0,0 +1,4 @@ +GENERIC-RESOURCE-API(2016-11-11) +================================ + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=generic-resource-api/model/src/main/resources/generic-resource-api.20161111.json diff --git a/docs/apis/vnfapi.rst b/docs/apis/vnfapi.rst new file mode 100644 index 00000000..2595a09c --- /dev/null +++ b/docs/apis/vnfapi.rst @@ -0,0 +1,4 @@ +VNF-API(2015-07-20) +=================== + +.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=sdnc/northbound.git;a=blob_plain;f=vnfapi/model/src/main/resources/vnf-api.20150720.json \ No newline at end of file diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index e20c786c..c79cb977 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -1,6 +1,10 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 + Offered APIs ============ +.. toctree:: + :maxdepth: 1 + apis/genericresource.rst + apis/vnfapi.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 21ff338c..c5863638 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,35 +3,31 @@ Release Notes ============= -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z +Version: 1.2.0 -------------- -:Release Date: yyyy-mm-dd +:Release Date: 2018-11-16 **New Features** -One or two sentences explaining the purpose of this Release. +The ONAP Amsterdam release introduces the following changes to SDNC from +the original openECOMP seed code: + - Refactored / moved common platform code to new CCSDK project + - Refactored code to rename openecomp to onap + - Introduced new GENERIC-RESOURCE-API api, used by vCPE and VoLTE use cases + - Introduced new docker containers for SDC and DMAAP interfaces **Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. **Known Issues** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. +The following known high priority issues are being worked and are expected to be delivered +in release 1.2.1: + - `SDNC-179 `_ Failed to make HTTPS connection in restapicall node + - `SDNC-181 `_ Change call to brg-wan-ip-address vbrg-wan-ip brg topo activate DG + - `SDNC-182 `_ Fix VNI Consistency: Add vG vxlan tunnel setup and bridge domain setup to brg-topo-activate DG - And an optional sentence providing a workaround. **Security Issues** You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ -- 2.16.6