Merge pull request #103 from akoshunyadi/prepare-release-0.5.0

Prepare release 0.5.0

CHANGELOG.md

@@ -1,9 +1,56 @@
 # Changelog DeviceStatus
 ## Table of Contents
+- [v0.5.0](#v050)
 - [v0.5.0-rc](#v050-rc)
 - [v0.4.1](#v041)
 - [v0.2.0](#v020)
 
+# v0.5.0
+**This is the third alpha 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)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml)
+
+## 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.
+- 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.
+
+### Main Changes
+* Added a new endpoint (/connectivity) to query the connectivity status of a device.
+* Added the support for event notifications, based on CloudEvents, for both roaming and connectivity events.
+* Reworked API security, now only Open-ID connect is allowed.
+
+### Added
+* Added new endpoints to manage event-notifications for roaming events by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/31
+* Aligned event notification management with CloudEvents spec and added Open-Id connect as security method by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/75
+* Added a new endpoint and events to query the connectivity status of a device by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/69
+
+### Changed
+* Aligned error definition with guidelines by @monamok in https://github.com/camaraproject/DeviceStatus/pull/35
+
+### Fixed
+* Aligned with common usage of allOf by @patrice-conil in https://github.com/camaraproject/DeviceStatus/pull/60
+* Replaced subscriptionId with eventSubscriptionId by @patrice-conil in https://github.com/camaraproject/DeviceStatus/pull/64
+* Corrections resolving linting errors by @rartych in https://github.com/camaraproject/DeviceStatus/pull/95
+
+### Removed
+* NA
+
+## New Contributors
+* @bigludo7 made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/50
+* @sachinvodafone made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/51
+* @patrice-conil made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/59
+* @SyeddR made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/63
+* @Sachinsiso made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/68
+* @rartych made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/79
+* @maxl2287 made their first contribution in https://github.com/camaraproject/DeviceStatus/pull/69
+
+**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.4.1...v0.5.0
+
+
 # v0.5.0-rc
 **This is the release candidate of v0.5.0 - containing the upcoming 3rd alpha version of the DeviceStatus API**
 - API definition **with inline documentation**:

README.md

@@ -25,19 +25,11 @@ Repository to describe, develop, document and test the DeviceStatus API family
 ## 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 Release Candidate for v0.5.0 of the Device Status is available. The upcoming release will contain the 3rd alpha version of the DeviceStatus API**<br>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.5.0 is available in the [release-0.5.0-rc branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0-rc)
+* The latest available and released version 0.5.0 of the API is available within the [release-0.5.0 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.5.0)
   - 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)
-    - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0-rc/code/API_definitions/device-status.yaml)
-  - For changes between v0.5.0-rc and v0.4.1 see the [CHANGELOG.md](https://github.com/camaraproject/DeviceStatus/blob/release-0.5.0-rc/CHANGELOG.md)
-
-* The latest available and released version 0.4.1 of the API is available within the [release-0.4.1 branch](https://github.com/camaraproject/DeviceStatus/tree/release-0.4.1)
-  - API definition with inline documentation:
-    - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/release-0.4.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.4.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.4.1/code/API_definitions/device-status.yaml) 
+    - 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)
+    - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/release-0.5.0/code/API_definitions/device-status.yaml) 
 
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-dst>.

code/API_definitions/device-status.yaml

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