docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Release Notes
   4 =============
   5
   6 .. note::
   7    * This Release Notes must be updated each time the team decides to Release new artifacts.
   8    * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
   9    * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  10    * 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.
  11    * This note must be removed after content has been added.
  12
  13
  14 Version: x.y.z
  15 --------------
  16
  17
  18 :Release Date: 2017-11-16
  19
  20
  21
  22 **New Features**
  23
  24  - Pub/sub messaging metaphor to broaden data processing opportunities.
  25  - A single solution for most event distribution needs to support a range of environments.
  26  - Standardized topic names
  27  - Implements a RESTful HTTP API for provisioning
  28  - Implements a RESTful HTTP API for message transactions (i.e. pub, sub)
  29  - Implements a RESTful HTTP API for transaction metrics
  30  - Topic registry and discovery
  31
  32
  33
  34 **Bug Fixes**
  35    - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
  36 **Known Issues**
  37    - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
  38      One sentences explaining what is the issue.
  39
  40      Another sentence explaining the impact of the issue.
  41
  42      And an optional sentence providing a workaround.
  43
  44 **Security Issues**
  45    You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
  46
  47
  48 **Upgrade Notes**
  49
  50 **Deprecation Notes**
  51
  52 **Other**
  53
  54 ===========