diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c7d899..4d15442 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ # Changelog DeviceStatus ## Table of Contents +- [r1.2](#r12) - [r1.1](#r11) - [r0.6](#r06) - [v0.5.1](#v051) @@ -16,6 +17,126 @@ The below sections record the changes for each API version in each release as fo * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release * for a public API version, the consolidated changes since the release of the previous public API version +# r1.2 +## Release Notes + +This release contains the definition and documentation of +* device-roaming-status v0.6.0 +* device-roaming-status-subscriptions v0.6.0 +* device-reachability-status v0.6.0 +* device-reachability-status-subscriptions v0.6.0 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +Note: the previous device-status API with roaming and connectivity endpoints has been split into 4 specific APIs + +## device-roaming-status v0.6.0 + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-roaming-status.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-roaming-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.2/code/API_definitions/device-roaming-status.yaml) + +### 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 +* Create Gherkin tests for device-status-reachability and device-status-roaming by @mdomale in https://github.com/camaraproject/DeviceStatus/pull/186 + +### Changed +* Change endpoint names to comply with guideline by @gmuratk in https://github.com/camaraproject/DeviceStatus/pull/131 +* Make '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/144 +* Separate endpoint yamls proposal for direct API by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/152 +* Switch device structure to optional by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/179 +* `device-reachability-status` & `device-roaming-status`: Alignment of errors with Commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/183 +* Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/195 + +### Fixed +* Renamed RequestRoamingStatus to RoamingStatusRequest by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/194 + +### Removed +* Remove `terms of service` and `contact` by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/185 +* Remove response code 405 by bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/198 + +## device-roaming-status-subscriptions v0.6.0 + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.2/code/API_definitions/device-roaming-status-subscriptions.yaml) + +### Added +* Add termination reason `SUBSCRIPTION_DELETED` when subscription deleted by the user by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/121 +* include x-correlator by @fernandopradocabrillo in https://github.com/camaraproject/DeviceStatus/pull/112 +* Create Gherkin tests for device-reachability-status-subscriptions & device-roaming-status-subscriptions by @mdomale in https://github.com/camaraproject/DeviceStatus/pull/187 + +### Changed +* Make '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/144 +* split `/subscription`-endpoints into seperate APIs by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/161 +* renaming "EventType"-components to be more clear & update component descriptions by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/141 +* Update the subscription models to align on CAMARA commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/170 +* Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/195 +* Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/193 + +### Fixed + +### Removed +* Remove `terms of service` and `contact` by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/185 + +## device-reachability-status v0.6.0 + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-reachability-status.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-reachability-status.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.2/code/API_definitions/device-reachability-status.yaml) + +### 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 +* Create Gherkin tests for device-status-reachability and device-status-roaming by @mdomale in https://github.com/camaraproject/DeviceStatus/pull/186 + +### Changed +* Change endpoint names to comply with guideline by @gmuratk in https://github.com/camaraproject/DeviceStatus/pull/131 +* Make '+' mandatory for phoneNumber by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/144 +* Separate endpoint yamls proposal for direct API by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/152 +* Switch device structure to optional by @bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/179 +* `device-reachability-status` & `device-roaming-status`: Alignment of errors with Commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/183 +* Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/195 + +### Fixed + +### Removed +* Remove `terms of service` and `contact` by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/185 +* Remove response code 405 by bigludo7 in https://github.com/camaraproject/DeviceStatus/pull/198 + +## device-reachability-status-subscriptions v0.6.0 + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-reachability-status-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.2/code/API_definitions/device-reachability-status-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.2/code/API_definitions/device-reachability-status-subscriptions.yaml) + +### Added +* Add termination reason `SUBSCRIPTION_DELETED` when subscription deleted by the user by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/121 +* include x-correlator by @fernandopradocabrillo in https://github.com/camaraproject/DeviceStatus/pull/112 +* Create Gherkin tests for device-reachability-status-subscriptions & device-roaming-status-subscriptions by @mdomale in https://github.com/camaraproject/DeviceStatus/pull/187 + +### Changed +* 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 +* split `/subscription`-endpoints into seperate APIs by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/161 +* Update the subscription models to align on CAMARA commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/170 +* Removing note that the API-scope is limited to 4G and 5G by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/195 +* Subscription-APIs: Alignment of errors with Commonalities by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/193 + +### Fixed + +### Removed +* Remove `terms of service` and `contact` by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/185 + +**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/v0.5.1...r1.2 + # r1.1 ## Release Notes diff --git a/README.md b/README.md index ef0dd13..61d41eb 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,6 @@ 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 pre-release is [r1.1](https://github.com/camaraproject/DeviceStatus/tree/r1.1) -The release r1.1 contains the following API definitions (with inline documentation): - - device-roaming-status [[YAML]](https://github.com/camaraproject/DeviceStatus/blob/r1.1/code/API_definitions/device-roaming-status.yaml) -[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-roaming-status.yaml&nocors) -[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-roaming-status.yaml) - - device-roaming-status-subscriptions [[YAML]](https://github.com/camaraproject/DeviceStatus/blob/r1.1/code/API_definitions/device-roaming-status-subscriptions.yaml) -[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-roaming-status-subscriptions.yaml&nocors) -[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-roaming-status-subscriptions.yaml) - - device-reachability-status [[YAML]](https://github.com/camaraproject/DeviceStatus/blob/r1.1/code/API_definitions/device-reachability-status.yaml) -[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-reachability-status.yaml&nocors) -[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-reachability-status.yaml) - - device-reachability-status-subscriptions [[YAML]](https://github.com/camaraproject/DeviceStatus/blob/r1.1/code/API_definitions/device-reachability-status-subscriptions.yaml) -[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-reachability-status-subscriptions.yaml&nocors) -[[View it on Swagger Editor]](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.1/code/API_definitions/device-reachability-status-subscriptions.yaml) - ## Contributing * Meetings * Bi-weekly on Wednesday, 11:00 CET/CEST (08:00 UTC, 09:00 UTC during European DST) diff --git a/code/API_definitions/device-reachability-status-subscriptions.yaml b/code/API_definitions/device-reachability-status-subscriptions.yaml index 183b3b6..af3583d 100644 --- a/code/API_definitions/device-reachability-status-subscriptions.yaml +++ b/code/API_definitions/device-reachability-status-subscriptions.yaml @@ -68,14 +68,14 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.6.0-rc.1 + version: 0.6.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-reachability-status-subscriptions/v0.6rc1" + - url: "{apiRoot}/device-reachability-status-subscriptions/v0.6" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/device-reachability-status.yaml b/code/API_definitions/device-reachability-status.yaml index 3ec71c8..d9afdd6 100644 --- a/code/API_definitions/device-reachability-status.yaml +++ b/code/API_definitions/device-reachability-status.yaml @@ -69,14 +69,14 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.6.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-reachability-status/v0.6rc1" + - url: "{apiRoot}/device-reachability-status/v0.6" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/device-roaming-status-subscriptions.yaml b/code/API_definitions/device-roaming-status-subscriptions.yaml index 0e87516..3259db6 100644 --- a/code/API_definitions/device-roaming-status-subscriptions.yaml +++ b/code/API_definitions/device-roaming-status-subscriptions.yaml @@ -70,14 +70,14 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.6.0-rc.1 + version: 0.6.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-roaming-status-subscriptions/v0.6rc1" + - url: "{apiRoot}/device-roaming-status-subscriptions/v0.6" variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/device-roaming-status.yaml b/code/API_definitions/device-roaming-status.yaml index 18e9e1f..0d486ac 100644 --- a/code/API_definitions/device-roaming-status.yaml +++ b/code/API_definitions/device-roaming-status.yaml @@ -76,14 +76,14 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.6.0 x-camara-commonalities: 0.4.0 externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/device-roaming-status/v0.6rc1" + - url: "{apiRoot}/device-roaming-status/v0.6" variables: apiRoot: default: http://localhost:9091 diff --git a/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md b/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md index 1c76f85..686142a 100644 --- a/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md +++ b/documentation/API_documentation/device-reachability-status-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for device-reachability-status 0.6.0-rc.1 in r1.1. +Checklist for device-reachability-status 0.6.0 in r1.2. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -10,7 +10,7 @@ Checklist for device-reachability-status 0.6.0-rc.1 in r1.1. | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | tbd | Will be provided for 0.6.0-rc.2 | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | code/Test_definitions/device-reachability-status.feature | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | diff --git a/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md index 65c05c9..3d6cbb8 100644 --- a/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/device-reachability-status-subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for device-reachability-status-subscriptions 0.6.0-rc.1 in r1.1. +Checklist for device-reachability-status-subscriptions 0.6.0 in r1.2. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -10,7 +10,7 @@ Checklist for device-reachability-status-subscriptions 0.6.0-rc.1 in r1.1. | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | tbd | Will be provided for 0.6.0-rc.2 | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | code/Test_definitions/device-reachability-status-subscriptions.feature | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | diff --git a/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md b/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md index 80b6822..44e3dae 100644 --- a/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md +++ b/documentation/API_documentation/device-roaming-status-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for device-roaming-status 0.6.0-rc.1 in r1.1. +Checklist for device-roaming-status 0.6.0 in r1.2. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -10,7 +10,7 @@ Checklist for device-roaming-status 0.6.0-rc.1 in r1.1. | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | tbd | Will be provided for 0.6.0-rc.2 | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | code/Test_definitions/device-roaming-status.feature | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | diff --git a/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md b/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md index 04e5dc5..977e8d2 100644 --- a/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md +++ b/documentation/API_documentation/device-roaming-status-subscriptions-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for device-roaming-status-subscriptions 0.6.0-rc.1 in r1.1. +Checklist for device-roaming-status-subscriptions 0.6.0 in r1.2. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -10,7 +10,7 @@ Checklist for device-roaming-status-subscriptions 0.6.0-rc.1 in r1.1. | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | N | | -| 7 | Basic API test cases & documentation | O | M | M | M | tbd | Will be provided for 0.6.0-rc.2 | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | code/Test_definitions/device-roaming-status-subscriptions.feature | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | |