From 9cd997b1798cb8d017d209da32bf4a3a02dcd80d Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Sun, 19 Nov 2023 19:23:03 +0100 Subject: [PATCH 1/5] Update CHANGELOG.md and README.md for v0.10.0-rc --- CHANGELOG.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 22 ++++++++++++++++------ 2 files changed, 69 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6402393385..349d130b31 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [v0.10.0-rc](#v0100-rc) - [v0.9.0](#v090) - [v0.9.0-rc](#v090-rc) - [v0.8.1](#v081) @@ -12,6 +13,58 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi **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.10.0-rc + +**This is the release candidate of v0.10.0 - containing the upcoming fourth alpha version of the Quality-On-Demand (QoD) API** + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/release-0.10.0-rc/code/API_definitions/qod-api.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.0-rc/code/API_definitions/qod-api.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.0-rc/code/API_definitions/qod-api.yaml) + +## Please note: + +- **This release will contain significant changes compared to v0.9.0, and it is not backward compatible** + - Especially ... +- **This is only the pre-release, it should be considered as a draft of the upcoming release v0.10.0** + - The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments. + +### Main Changes + +* Aligned event notification with CloudEvent spec which will allow API consumers and implementators to use standard libraries and tools which are available to handle cloud events +* Added a new operation `/sessions/{sessionId}/extend` which allows to extend the duration of an active session + + +### Added + +* TBD - #216 Added operation to extend session duration +* Introduced of linting with Megalinter and Swagger Editor Validator by @RandyLevensalor, @maxl2287 and @ravindrapalaskar17 in https://github.com/camaraproject/QualityOnDemand/pull/206, https://github.com/camaraproject/QualityOnDemand/pull/207, https://github.com/camaraproject/QualityOnDemand/pull/212, and https://github.com/camaraproject/QualityOnDemand/pull/215 +* Added global tags element by @rartych in https://github.com/camaraproject/QualityOnDemand/pull/227 + + +### Changed + +* TBD - #224 Aligned event notification with CloudEvent spec +* Moved "description" out of "allOf" declaration by @maxl2287 in https://github.com/camaraproject/QualityOnDemand/pull/205 + * Note: this change shouldn't have an impact for API consumers but is relevant for implementations of the API. +* TDB - #233 Default folder for test definition created and QoD_API_Test.feature copied into it + + +### Fixed + +* NA + +### Removed + +* NA + +## New Contributors +* @ravindrapalaskar17 made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/215 +* @rartych made their first contribution in https://github.com/camaraproject/QualityOnDemand/pull/227 + +**Full Changelog**: https://github.com/camaraproject/QualityOnDemand/compare/v0.9.0...v0.10.0-rc + + # v0.9.0 **This is the third alpha version of the Quality-On-Demand (QoD) API.** diff --git a/README.md b/README.md index ffbf691e8b..6ca1c76dc1 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,24 @@ Repository to describe, develop, document and test the QualityOnDemand API famil ## Status and released versions * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **The latest available release and version of Quality-On-Demand (QoD) API is 0.9.0. This is the third alpha version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. -* Release 0.9.0 of the API is available within the [release-0.9.0 branch](https://github.com/camaraproject/QualityOnDemand/tree/release-0.9.0): - - API definition **with inline documentation**: + +* **The Release Candidate for v0.10.0 of the Quality-On-Demand is available. The upcoming release will contain the fourth alpha version of the QoD API**
Until the release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments. +* The release candidate for v0.10.0 is available in the [release-0.10.0-rc branch](https://github.com/camaraproject/QualityOnDemand/tree/release-0.10.0-rc) + - API definition with inline documentation: + - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/release-0.10.0-rc/code/API_definitions/qod-api.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.0-rc/code/API_definitions/qod-api.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.10.0-rc/code/API_definitions/qod-api.yaml) + - For changes between v0.10.0-rc and v0.9.0 see the [CHANGELOG.md](https://github.com/camaraproject/QualityOnDemand/blob/main/CHANGELOG.md) + + +* The latest available and released version 0.9.0 of the API is available within the [release-0.9.0 branch](https://github.com/camaraproject/QualityOnDemand/tree/release-0.9.0) + - API definition with inline documentation: - OpenAPI [YAML spec file](https://github.com/camaraproject/QualityOnDemand/blob/release-0.9.0/code/API_definitions/qod-api.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.9.0/code/API_definitions/qod-api.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.9.0/code/API_definitions/qod-api.yaml) -* The previous version v0.8.1 of the QoD API is available within the [release-0.8.1 branch](https://github.com/camaraproject/QualityOnDemand/tree/release-0.8.1) -* Provider implementations (PI) will be provided within separate repositories: + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/QualityOnDemand/release-0.9.0/code/API_definitions/qod-api.yaml) + + +* Provider implementations (PI) are available within separate repositories: * [QualityOnDemand_PI1](https://github.com/camaraproject/QualityOnDemand_PI1) by Deutsche Telekom * [QualityOnDemand_PI2](https://github.com/camaraproject/QualityOnDemand_PI2) by Orange * [QualityOnDemand_PI3](https://github.com/camaraproject/QualityOnDemand_PI3) by Spry Fox Networks From ad7e20685f48c01c3fe4644c6d5fd75b20f48be4 Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Sun, 19 Nov 2023 19:23:30 +0100 Subject: [PATCH 2/5] Change of version number to v0.10.0-rc in YAML --- 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 5eae541023..0605e454dc 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.10.0-wip + version: 0.10.0-rc externalDocs: description: Product documentation at Camara url: https://github.com/camaraproject/ From 36bf69b93aa18ab21b36fb7bcc5425a01e36b1dd Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Mon, 27 Nov 2023 21:28:15 +0100 Subject: [PATCH 3/5] Update CHANGELOG.md with latest 3 merged PRs --- CHANGELOG.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 349d130b31..439a9f70d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,18 +37,16 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi ### Added -* TBD - #216 Added operation to extend session duration +* Added new endpoint to extend duration of an active session by @emil-cheung in https://github.com/camaraproject/QualityOnDemand/pull/216 * Introduced of linting with Megalinter and Swagger Editor Validator by @RandyLevensalor, @maxl2287 and @ravindrapalaskar17 in https://github.com/camaraproject/QualityOnDemand/pull/206, https://github.com/camaraproject/QualityOnDemand/pull/207, https://github.com/camaraproject/QualityOnDemand/pull/212, and https://github.com/camaraproject/QualityOnDemand/pull/215 * Added global tags element by @rartych in https://github.com/camaraproject/QualityOnDemand/pull/227 - ### Changed -* TBD - #224 Aligned event notification with CloudEvent spec +* Align event notification with CloudEvents spec by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/224 * Moved "description" out of "allOf" declaration by @maxl2287 in https://github.com/camaraproject/QualityOnDemand/pull/205 * Note: this change shouldn't have an impact for API consumers but is relevant for implementations of the API. -* TDB - #233 Default folder for test definition created and QoD_API_Test.feature copied into it - +* Aligned with changes in https://github.com/camaraproject/Template_Lead_Repository on test definitions by @rartych in https://github.com/camaraproject/QualityOnDemand/pull/233 ### Fixed From 87ec5d58e2424eb40bab2e9abb8a4cc1d389287c Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Wed, 29 Nov 2023 10:53:23 +0100 Subject: [PATCH 4/5] Update CHANGELOG.md with PR #237 --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 439a9f70d0..023343dd3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -31,7 +31,7 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi ### Main Changes -* Aligned event notification with CloudEvent spec which will allow API consumers and implementators to use standard libraries and tools which are available to handle cloud events +* Aligned event notification with CloudEvent spec which will allow API consumers and implementators to use standard libraries and tools which are available to handle CloudEvents (https://cloudevents.io/) * Added a new operation `/sessions/{sessionId}/extend` which allows to extend the duration of an active session @@ -47,6 +47,7 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi * Moved "description" out of "allOf" declaration by @maxl2287 in https://github.com/camaraproject/QualityOnDemand/pull/205 * Note: this change shouldn't have an impact for API consumers but is relevant for implementations of the API. * Aligned with changes in https://github.com/camaraproject/Template_Lead_Repository on test definitions by @rartych in https://github.com/camaraproject/QualityOnDemand/pull/233 +* Single IP addresses in Device model specified with standard formats instead of patterns by @jlurien in https://github.com/camaraproject/QualityOnDemand/pull/237 ### Fixed From 05fec910bd65d85435ac0f643abb6ee963198c3e Mon Sep 17 00:00:00 2001 From: Herbert Damker <52109189+hdamker@users.noreply.github.com> Date: Fri, 1 Dec 2023 08:26:06 +0100 Subject: [PATCH 5/5] Added list of breaking changes to CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 023343dd3c..37c6d4e920 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,8 @@ Version numbers 0.2.x to 0.7.x were intentionally not used to avoid conflicts wi ## Please note: - **This release will contain significant changes compared to v0.9.0, and it is not backward compatible** - - Especially ... + - Within notifications the schema `EventNotification`has been replace by `CloudEvent` in accordance with the updated CAMARA Design Guidelines + - If within `device` an IPv6 address is used it must be a single IPv6 address (out of the prefix used by the device) - **This is only the pre-release, it should be considered as a draft of the upcoming release v0.10.0** - The pre-release is meant for implementors, but it is not recommended to use the API with customers in productive environments.