Merge pull request #216 from akoshunyadi/prepare-release-r1.3

Prepare release r1.3

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Changelog DeviceStatus
 ## Table of Contents
+- [r1.3](#r13)
 - [r1.2](#r12)
 - [r1.1](#r11)
 - [r0.6](#r06)
@@ -17,6 +18,93 @@ 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.3
+## Release Notes
+
+This patch release contains the definition and documentation of
+* device-roaming-status v0.6.1
+* device-roaming-status-subscriptions v0.6.1
+* device-reachability-status v0.6.1
+* device-reachability-status-subscriptions v0.6.1
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.1
+
+Note: these patch release notes are listing only the change compared to the [r1.2](https://github.com/camaraproject/DeviceStatus/releases/tag/r1.2) release. For the full list of changes of the 0.6.0 API versions compared to 0.5.x see [r1.2](#r12).
+
+## device-roaming-status v0.6.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.3/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.3/code/API_definitions/device-roaming-status.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.3/code/API_definitions/device-roaming-status.yaml)
+
+### Added
+
+### Changed
+
+### Fixed
+* Minor corrections in info.description by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/216
+
+### Removed
+
+## device-roaming-status-subscriptions v0.6.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.3/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.3/code/API_definitions/device-roaming-status-subscriptions.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.3/code/API_definitions/device-roaming-status-subscriptions.yaml)
+
+### Added
+
+### Changed
+
+### Fixed
+* Add missing `protocol`-components for device-roaming-status-subscriptions by @maxl2287 in https://github.com/camaraproject/DeviceStatus/pull/208
+* Correct the examples for sub - initialEvent and error MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED by @dfischer-tech in https://github.com/camaraproject/DeviceStatus/pull/210
+* Minor corrections in info.description by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/216
+
+### Removed
+
+
+## device-reachability-status v0.6.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.3/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.3/code/API_definitions/device-reachability-status.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.3/code/API_definitions/device-reachability-status.yaml)
+
+### Added
+
+### Changed
+* Update description of the reachability types by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/215
+
+### Fixed
+* Minor corrections in info.description by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/216
+
+### Removed
+
+## device-reachability-status-subscriptions v0.6.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceStatus/r1.3/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.3/code/API_definitions/device-reachability-status-subscriptions.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceStatus/blob/r1.3/code/API_definitions/device-reachability-status-subscriptions.yaml)
+
+### Added
+
+### Changed
+* Update description of the reachability types by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/215
+
+### Fixed
+* Correct the examples for sub - initialEvent and error MULTIEVENT_SUBSCRIPTION_NOT_SUPPORTED by @dfischer-tech in https://github.com/camaraproject/DeviceStatus/pull/210
+* Minor corrections in info.description by @akoshunyadi in https://github.com/camaraproject/DeviceStatus/pull/216
+
+### Removed
+
+**Full Changelog**: https://github.com/camaraproject/DeviceStatus/compare/r1.2...r1.3
+
 # r1.2
 ## Release Notes
 

README.md

@@ -7,12 +7,12 @@
 <a href="https://github.com/camaraproject/DeviceStatus/releases/latest" title="Latest Release"><img src="https://img.shields.io/github/release/camaraproject/DeviceStatus?style=plastic"></a>
 
 # DeviceStatus
-Repository to describe, develop, document and test the DeviceStatus API family
+Repository to describe, develop, document and test the DeviceStatus APIs
 
 ## Scope
 * Service APIs for “Device Status” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md))  
-* It provides the customer with the ability to:  
-  - check if a device is reachable or has lost connectivity to the network
+* It provides the API consumer with the ability to:  
+  - check if a device is reachable or is not connected to the network
   - check if a device is roaming, and in which country
   - receive notifications if the connectivity or roaming status of the device changes
 * Describe, develop, document and test the APIs (with 1-2 Telcos)  
@@ -29,7 +29,7 @@ Repository to describe, develop, document and test the DeviceStatus API family
 
 ## Contributing
 * Meetings
-  * Bi-weekly on Wednesday, 11:00 CET/CEST (08:00 UTC, 09:00 UTC during European DST)
+  * Bi-weekly on Wednesday, 09:00 UTC
   * [Registration / Join](https://zoom-lfx.platform.linuxfoundation.org/meeting/93413850406?password=3aeb0f1b-d9f9-42c5-91d8-3d2b20421ef1)
   * Access [meeting minutes](https://lf-camaraproject.atlassian.net/wiki/x/fzLe) 
 * Mailing List

code/API_definitions/device-reachability-status-subscriptions.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Device Reachability Status Subscriptions
   description: |
-    This API provides the customer with the ability to subscribe to Reachability status events.
+    This API provides the API consumer with the ability to subscribe to Reachability status events.
 
     # Introduction
 
@@ -14,7 +14,7 @@ info:
     # Relevant terms and definitions
 
     * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.
-      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
+      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
 
     # API Functionality
 
@@ -57,9 +57,9 @@ info:
 
     (FAQs will be added in a later version of the documentation)
 
-    # Authorization and authentication
+    ### Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -68,11 +68,11 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.6.1
   x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/
+  url: https://github.com/camaraproject/DeviceStatus
 
 servers:
   - url: "{apiRoot}/device-reachability-status-subscriptions/v0.6"

code/API_definitions/device-reachability-status.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Device Reachability Status
   description: |
-    This API provides the customer with the ability to query device reachability status.
+    This API provides the API consumer with the ability to query device reachability status.
 
     # Introduction
 
@@ -13,7 +13,7 @@ info:
     ## Relevant terms and definitions
 
     * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.
-      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
+      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
 
     * **Reachability** : Reachability status.
       - `CONNECTED_SMS`, if device is connected to the network only via SMS usage
@@ -30,9 +30,9 @@ info:
 
     The endpoint `POST /retrieve` allows to get current connectivity status information synchronously.
 
-    # Authorization and authentication
+    ### Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -69,11 +69,11 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.6.1
   x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/
+  url: https://github.com/camaraproject/DeviceStatus
 
 servers:
   - url: "{apiRoot}/device-reachability-status/v0.6"

code/API_definitions/device-roaming-status-subscriptions.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Device Roaming Status Subscriptions
   description: |
-    This API provides the customer with the ability to subscribe to Roaming status events.
+    This API provides the API consumer with the ability to subscribe to Roaming status events.
 
     # Introduction
 
@@ -14,7 +14,7 @@ info:
     # Relevant terms and definitions
 
     * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.
-      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
+      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
 
     # API Functionality
 
@@ -59,9 +59,9 @@ info:
 
     (FAQs will be added in a later version of the documentation)
 
-    # Authorization and authentication
+    ### Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -70,11 +70,11 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.6.1
   x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/
+  url: https://github.com/camaraproject/DeviceStatus
 
 servers:
   - url: "{apiRoot}/device-roaming-status-subscriptions/v0.6"

code/API_definitions/device-roaming-status.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Device Roaming Status
   description: |
-    This API provides the customer with the ability to query device roaming Status
+    This API provides the API consumer with the ability to query device roaming Status
 
     # Introduction
 
@@ -21,7 +21,7 @@ info:
     ## Relevant terms and definitions
 
     * **Device**: A device refers to any physical entity that can connect to a network and participate in network communication.
-      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier assigned by the mobile network operator for the device.
+      At least one identifier for the device (user equipment) out of four options: IPv4 address, IPv6 address, Phone number, or Network Access Identifier (not supported for this API version) assigned by the mobile network operator for the device.
 
     * **Roaming** : Roaming status - `true`, if device is in roaming situation - `false` else.
 
@@ -37,9 +37,9 @@ info:
 
     The endpoint `POST /retrieve` allows to get roaming status and country information (if device in roaming situation) synchronously.
 
-    # Authorization and authentication
+    ### Authorization and authentication
 
-    [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md) provides details on how a client requests an access token.
+    The "Camara Security and Interoperability Profile" provides details on how a client requests an access token. Please refer to Identify and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the Profile.
 
     Which specific authorization flows are to be used will be determined during onboarding process, happening between the API Client and the Telco Operator exposing the API, taking into account the declared purpose for accessing the API, while also being subject to the prevailing legal framework dictated by local legislation.
 
@@ -76,11 +76,11 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: wip
+  version: 0.6.1
   x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at CAMARA
-  url: https://github.com/camaraproject/
+  url: https://github.com/camaraproject/DeviceStatus
 
 servers:
   - url: "{apiRoot}/device-roaming-status/v0.6"

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 in r1.2.
+Checklist for device-reachability-status 0.6.1 in r1.3.
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|

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 in r1.2.
+Checklist for device-reachability-status-subscriptions 0.6.1 in r1.3.
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|

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 in r1.2.
+Checklist for device-roaming-status 0.6.1 in r1.3.
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|

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 in r1.2.
+Checklist for device-roaming-status-subscriptions 0.6.1 in r1.3.
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|