From 4dcbf93ccb9816a03c93b208c7f131a41fc07e44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 14 May 2024 17:48:16 +0200 Subject: [PATCH 1/9] Update device-status.yaml --- code/API_definitions/device-status.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 5cb832e8..8910ab56 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -101,7 +101,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.6.0-alpha.1 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ From 059b364cb67f168ba843a944208c3fc031e8c59c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 14 May 2024 17:57:53 +0200 Subject: [PATCH 2/9] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 026fa1d8..41b935c3 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,11 @@ Repository to describe, develop, document and test the DeviceStatus API family * 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 public release**. -* The latest available and released version 0.5.1 of the API is available within the [release-0.5.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.1) +* The latest available and released version v0.6.0-alpha.1 of the API is available within the [release-0.6 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.6) - API definition with inline documentation: - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.6/code/API_definitions/device-status.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml) ## Contributing * Meetings From e2f3d2dace3299aa6793d551341401a3b9bf0fc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 14 May 2024 18:25:32 +0200 Subject: [PATCH 3/9] Update CHANGELOG.md --- CHANGELOG.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 76281e3e..162f5158 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,48 @@ # Changelog DeviceStatus ## Table of Contents +- [r0.6](#r06) - [v0.5.1](#v051) - [v0.5.0](#v050) - [v0.5.0-rc](#v050-rc) - [v0.4.1](#v041) - [v0.2.0](#v020) +# r0.6 +## Please note: +- This is an alpha version, it should be considered as a draft. +- There are bug fixes to be expected and incompatible changes in upcoming versions. +- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. + +## Device Status - v0.6.0-alpha.1 +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.6/code/API_definitions/device-status.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml) +### Main Changes +* Endpoints renamed +* New response parameter lastStatusTime + +### Added +* Addition of "lastStatusTime" Field by @sachinvodafone in https://github.com/camaraproject/DeviceStatus/pull/146 +* include x-correlator by @fernandopradocabrillo in https://github.com/camaraproject/DeviceStatus/pull/112 + +### Changed +* Change endpoint names to comply with guideline by @gmuratk in https://github.com/camaraproject/DeviceStatus/pull/131 +* renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/141 +* Make '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/144 + +### Fixed +* NA + +### Removed +* NA + +## New Contributors +* NA + +**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.0...r0.6 + + # v0.5.1 **This is a bugfix release for the third alpha version of the CAMARA DeviceStatus API** - API definition **with inline documentation**: From 4324876c21c8c0a80ad7739ad3cee95f821423f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 14 May 2024 18:26:42 +0200 Subject: [PATCH 4/9] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 162f5158..7d527aac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,7 +40,7 @@ ## New Contributors * NA -**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.0...r0.6 +**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r0.6 # v0.5.1 From 16c2a03887c1cf0590cab2d438d81353cde6726b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 14 May 2024 18:32:27 +0200 Subject: [PATCH 5/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 41b935c3..0653816f 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Repository to describe, develop, document and test the DeviceStatus API family * 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 public release**. -* The latest available and released version v0.6.0-alpha.1 of the API is available within the [release-0.6 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.6) +* The latest available release version 0.6 (with API version 0.6.0-alpha.1) is available within the [release-0.6 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.6) - API definition with inline documentation: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.6/code/API_definitions/device-status.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml&nocors) From 7b64df87e208e3e1a6cccc00c52c08ea83ef6514 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 21 May 2024 21:19:30 +0200 Subject: [PATCH 6/9] Apply suggestions from code review Co-authored-by: Herbert Damker <52109189+hdamker@users.noreply.github.com> --- CHANGELOG.md | 2 +- README.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d527aac..74bd3e65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ # r0.6 ## Please note: -- This is an alpha version, it should be considered as a draft. +- This release contains an alpha version of the API, it should be considered as a draft. - There are bug fixes to be expected and incompatible changes in upcoming versions. - The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. diff --git a/README.md b/README.md index 0653816f..1fa7a3b4 100644 --- a/README.md +++ b/README.md @@ -27,11 +27,11 @@ Repository to describe, develop, document and test the DeviceStatus API family * 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 public release**. -* The latest available release version 0.6 (with API version 0.6.0-alpha.1) is available within the [release-0.6 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.6) +* The latest available release version 0.6 (with API version 0.6.0-alpha.1) is available [here](https://github.com/camaraproject/DeviceStatus/tree/r0.6) - API definition with inline documentation: - - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.6/code/API_definitions/device-status.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.6/code/API_definitions/device-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r0.6/code/API_definitions/device-status.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r0.6/code/API_definitions/device-status.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r0.6/code/API_definitions/device-status.yaml) ## Contributing * Meetings From 8c45a20a26f21f30fa9355c2d4276e2dbbb7dc57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 21 May 2024 21:23:36 +0200 Subject: [PATCH 7/9] Update device-status.yaml Update url with alpha version --- code/API_definitions/device-status.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 8910ab56..a284a8e6 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -107,7 +107,7 @@ externalDocs: url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-status/v0" + - url: "{apiRoot}/device-status/v0.6alpha1" variables: apiRoot: default: http://localhost:9091 From 4a9fa698a934ed6c64526cda0c8090b5129a5233 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 21 May 2024 21:24:47 +0200 Subject: [PATCH 8/9] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 74bd3e65..9494126d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,6 @@ ## Please note: - This release contains an alpha version of the API, it should be considered as a draft. - There are bug fixes to be expected and incompatible changes in upcoming versions. -- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. ## Device Status - v0.6.0-alpha.1 - API definition **with inline documentation**: From b39e65068feda712d2dc37e2e95cff9cc206a972 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81kos=20Hunyadi?= <67875049+akoshunyadi@users.noreply.github.com> Date: Tue, 21 May 2024 21:27:49 +0200 Subject: [PATCH 9/9] Update CHANGELOG.md --- CHANGELOG.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9494126d..96386cbe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -43,14 +43,14 @@ # v0.5.1 -**This is a bugfix release for the third alpha version of the CAMARA DeviceStatus API** +**This is a bugfix release for the third initial version of the CAMARA DeviceStatus API** - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.1/code/API_definitions/device-status.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml&nocors) - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.1/code/API_definitions/device-status.yaml) ## Please note: -- This is an alpha version, it should be considered as a draft. +- This is an initial version, it should be considered as a draft. - There are bug fixes to be expected and incompatible changes in upcoming versions. - The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. @@ -81,7 +81,7 @@ # v0.5.0 -**This is the third alpha version of the CAMARA DeviceStatus API** +**This is the third initial version of the CAMARA DeviceStatus API** - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0/code/API_definitions/device-status.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml&nocors) @@ -89,7 +89,7 @@ ## Please note: - **This release contains significant changes compared to v0.4.1, and it is not backward compatible** -- This is an alpha version, it should be considered as a draft. +- This is an initial version, it should be considered as a draft. - There are bug fixes to be expected and incompatible changes in upcoming versions. - The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments. @@ -127,7 +127,7 @@ # v0.5.0-rc -**This is the release candidate of v0.5.0 - containing the upcoming 3rd alpha version of the DeviceStatus API** +**This is the release candidate of v0.5.0 - containing the upcoming 3rd initial version of the DeviceStatus API** - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0-rc/code/API_definitions/device-status.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0-rc/code/API_definitions/device-status.yaml&nocors)