Merge pull request #169 from hdamker/pre-release-v0.9.0-rc

Pre release v0.9.0 rc

CHANGELOG.md

@@ -2,15 +2,63 @@
 
 ## Table of Contents
 
-
+- [v0.9.0-rc](#v090-rc)
 - [v0.8.1](#v081)
 - [v0.8.0](#v080)
 - [v0.1.0 - Initial contribution](#v010---initial-contribution)
 
-Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts with local implementations.
+Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts with local implementations.
 
 **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.**
 
+# v0.9.0-rc
+
+**This is the release candidate of v0.9.0 - the (third alpha (tbc)) release of the Quality-On-Demand (QoD) API**
+
+- [API definition with inline documentation](https://github.com/camaraproject/QualityOnDemand/releases/tag/release-0.9.0-rc/code/API_definitions)
+
+## Please note:
+
+- **This release contains significant changes compared to v0.8.1, and it is not backward compatible**
+  - Especially a lot of the parameter names changed in line with the agreed glossary within CAMARA Commonalities
+- **This is only the pre-release, it should be considered as a draft of the upcoming release v0.9.0**
+- The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.
+
+### Added
+
+* Introduced `qosStatus` and corresponding notification event to fix issue #38 by @emil-cheung in https://github.com/camaraproject/QualityOnDemand/pull/67
+* Added basic tests with Cucumber framework using Java and Maven implementation by @mdomale in https://github.com/camaraproject/QualityOnDemand/pull/134
+* Added new methods to get service provider defined QoS Profile by @RandyLevensalor in https://github.com/camaraproject/QualityOnDemand/pull/138
+* Scopes specified and OAuth2 authorizationCode flow added as security mechanism, for operations dealing with QoD sessions by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/163
+* Added new model `EventQosStatus` by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/167
+
+
+### Changed
+
+* Aligned error format with CAMARA design guidelines by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/104
+* Renamed properties to new terms agreed in CAMARA Commonalitites by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/129
+* Updated method for identifying devices by IPv4 address by @eric-murray in https://github.com/camaraproject/QualityOnDemand/pull/139
+* Updated of the notification event related fields based on the CAMARA design guideline by @akoshunyadi in https://github.com/camaraproject/QualityOnDemand/pull/155
+* CAMARA documentation is now embedded within the OAS definition, and not separate by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/151
+
+### Fixed
+
+* Added error code 501 "Not Implemented" by @dfischer-tech in https://github.com/camaraproject/QualityOnDemand/pull/124
+
+### Removed
+
+* Removed format lines from Datatypes `Ipv4Address` and `Ipv6Address` by @tlohmar in https://github.com/camaraproject/QualityOnDemand/pull/153
+* Removed markdown documentation (now embedded within the OAS definition, see above)
+
+## New Contributors
+* @jlurien made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/104
+* @dfischer-tech made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/124
+* @maheshc01 made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/132
+* @eric-murray made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/139
+* @mdomale made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/134
+* @RandyLevensalor made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/138
+
+**Full Changelog**: https://github.com/camaraproject/QualityOnDemand/compare/v0.8.1...v0.9.0-rc
 
 # v0.8.1
 

code/API_definitions/qod-api.yaml

@@ -66,7 +66,7 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.9.0-wip
+  version: 0.9.0-rc
 externalDocs:
   description: Product documentation at Camara
   url: https://github.com/camaraproject/