From 6dcbe353a03bb816fbd9c7e690e60a576d737cc8 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Fri, 16 Jun 2023 13:54:40 +0200 Subject: [PATCH 1/5] CHANGELOG.md update for v0.9.0-rc pre-release --- CHANGELOG.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5414a6f87e..8d34ea0d75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## 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) @@ -11,6 +11,51 @@ Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts wit **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 + +- [API definition with inline documentation](https://github.com/camaraproject/QualityOnDemand/tree/release-0.9.0-rc/code/API_definitions) + +**This is a pre-release/release candidate of v0.9.0 - the (third alpha/first beta) release of the Quality-On-Demand (QoD) API** +- links to be added + +## Please note: + +- **This release contains significant changes compared to v0.8.0, and is not backward compatible ** +- This is only the pre-release, it should be considered as a draft. +- There are bug fixes to be expected and incompatible changes +- The pre-release is suitable 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 initial QoD Cucumber Tests 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 +* Add oauth authorizationCode security to sensible endpoints by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/163 +* Documentation ... + +### Changed + +* Aligned error format with Commonalities 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 +* Aligned notifications with new design guideline by @akoshunyadi in https://github.com/camaraproject/QualityOnDemand/pull/155 + +### 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 .md documentation (got added to API definition .yaml file, 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 # v0.8.1 From 4847addbfb65288570dbf5fc08faf22ecca1a04b Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Fri, 16 Jun 2023 13:57:56 +0200 Subject: [PATCH 2/5] Update version within qod-api.yaml to v0.9.0-rc --- code/API_definitions/qod-api.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/qod-api.yaml b/code/API_definitions/qod-api.yaml index 15e35af9b2..fd74f82c4a 100644 --- a/code/API_definitions/qod-api.yaml +++ b/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/ From 6e2c03f81c36283a2d2cbceaae0bbf1284d50055 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Sat, 17 Jun 2023 12:16:07 +0200 Subject: [PATCH 3/5] Update of CHANGELOG.md --- CHANGELOG.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d34ea0d75..af8b159a87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,32 +13,33 @@ Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts wit # v0.9.0-rc -- [API definition with inline documentation](https://github.com/camaraproject/QualityOnDemand/tree/release-0.9.0-rc/code/API_definitions) +**This is a pre-release/release candidate of v0.9.0 - the (third alpha/first beta (tbd)) release of the Quality-On-Demand (QoD) API** -**This is a pre-release/release candidate of v0.9.0 - the (third alpha/first beta) release of the Quality-On-Demand (QoD) API** -- links to be added +- [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.0, and is not backward compatible ** -- This is only the pre-release, it should be considered as a draft. -- There are bug fixes to be expected and incompatible changes -- The pre-release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. +- **This pre-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 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 initial QoD Cucumber Tests by @mdomale in https://github.com/camaraproject/QualityOnDemand/pull/134 +* 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 -* Add oauth authorizationCode security to sensible endpoints by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/163 -* Documentation ... +* 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` @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/167 + ### Changed -* Aligned error format with Commonalities guidelines by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/104 +* 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 -* Aligned notifications with new design guideline by @akoshunyadi in https://github.com/camaraproject/QualityOnDemand/pull/155 +* 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 @@ -46,8 +47,8 @@ Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts wit ### Removed -* Removed format lines from Datatypes 'Ipv4Address' and 'Ipv6Address' by @tlohmar in https://github.com/camaraproject/QualityOnDemand/pull/153 -* Removed .md documentation (got added to API definition .yaml file, see above) +* 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 @@ -57,6 +58,8 @@ Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts wit * @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 **This is the second alpha release of the Quality-On-Demand (QoD) API** From a0fcd5feaac0ce0703133846dfb8ba59cb3217ed Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Sat, 17 Jun 2023 12:25:29 +0200 Subject: [PATCH 4/5] Update CHANGELOG.md --- CHANGELOG.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index af8b159a87..86b144b212 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,21 +7,21 @@ - [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 a pre-release/release candidate of v0.9.0 - the (third alpha/first beta (tbd)) release of the Quality-On-Demand (QoD) API** +**This is the release candidate of v0.9.0 - the (third alpha/first beta (tbd)) 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 pre-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 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 +- **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 @@ -30,7 +30,7 @@ Version number 0.2.x to 0.7.x were intentionally not used to avoid conflicts wit * 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` @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/167 +* Added new model `EventQosStatus` by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/167 ### Changed From c5e398c48534573f80f66e3dae56d03fe7b4fa6d Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Fri, 23 Jun 2023 09:18:07 +0200 Subject: [PATCH 5/5] Update CHANGELOG.md Removed "beta" release option --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86b144b212..856983cc3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi # v0.9.0-rc -**This is the release candidate of v0.9.0 - the (third alpha/first beta (tbd)) release of the Quality-On-Demand (QoD) API** +**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)