docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017 AT&T Intellectual Property.  All rights reserved.
   4
   5
   6 A&AI Release Notes
   7 ==================
   8
   9 .. note::
  10         * This Release Notes must be updated each time the team decides to Release new artifacts.
  11         * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
  12         * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  13         * 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.
  14         * This note must be removed after content has been added.
  15
  16
  17 Version: x.y.z
  18 --------------
  19
  20
  21 :Release Date: yyyy-mm-dd
  22
  23
  24
  25 **New Features**
  26         Initial release of Active and Available Inventory (AAI) for Open Network Automation Platform (ONAP)
  27
  28
  29 **Bug Fixes**
  30         - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
  31 **Known Issues**
  32         - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
  33           One sentences explaining what is the issue.
  34
  35           Another sentence explaining the impact of the issue.
  36
  37           And an optional sentence providing a workaround.
  38
  39 **Security Issues**
  40         You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
  41
  42
  43 **Upgrade Notes**
  44
  45 **Deprecation Notes**
  46         AAI Amsterdam provides support for legacy versions of the API, v8 and v11 in this release.  v11 is the latest and preferred version.
  47
  48 **Other**
  49
  50 ===========
  51
  52 End of Release Notes