From 62b85666bb93df3f7a22e9f0849f959fbaa148ff Mon Sep 17 00:00:00 2001 From: sachinvodafone <84573274+sachinvodafone@users.noreply.github.com> Date: Fri, 26 Apr 2024 12:28:38 +0100 Subject: [PATCH 1/5] Addition of "lastStatusTime" Field --- code/API_definitions/device-status.yaml | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 3071def2..12bac42d 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -44,7 +44,9 @@ info: - `CONNECTED_SMS`, if device is connected to the network via SMS usage - `CONNECTED_DATA`, if device is connected to the network via data usage - `NOT_CONNECTED`, if device is not connected to the network - + + * **LastStatusTime** : This property specifies the time when the status was last checked. Its inclusion in the response indicates that the information may not be current, while its absence suggests that the status information is fresh. + # API Functionality The API exposes following capabilities: @@ -151,12 +153,15 @@ paths: examples: Connected-With-SMS: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: CONNECTED_SMS Connected-With-DATA: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: CONNECTED_DATA Not-Connected: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" connectivityStatus: NOT_CONNECTED "400": $ref: "#/components/responses/Generic400" @@ -201,16 +206,19 @@ paths: examples: No-Country-Name: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 901 countryName: [] Single-Country-Code: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 262 countryName: ["DE"] Multiple-Country-Codes: value: + lastStatusTime: "2024-02-20T10:41:38.657Z" roaming: true countryCode: 340 countryName: ["BL", "GF", "GP", "MF", "MQ"] @@ -469,6 +477,8 @@ components: required: - roaming properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" roaming: $ref: "#/components/schemas/ActiveRoaming" countryCode: @@ -476,6 +486,12 @@ components: countryName: $ref: "#/components/schemas/CountryName" + LastStatusTime: + description: Last time that the associated device roaming status/connectivity was checked and, if necessary, updated + type: string + format: date-time + example: "2024-02-20T10:41:38.657Z" + ActiveRoaming: description: Roaming status. True, if it is roaming type: boolean @@ -485,6 +501,8 @@ components: required: - connectivityStatus properties: + lastStatusTime: + $ref: "#/components/schemas/LastStatusTime" connectivityStatus: $ref: "#/components/schemas/ConnectivityStatus" From 96a7fc36054ac3fe5e7b0b18afe932ed9a750429 Mon Sep 17 00:00:00 2001 From: sachinvodafone <84573274+sachinvodafone@users.noreply.github.com> Date: Fri, 26 Apr 2024 12:36:38 +0100 Subject: [PATCH 2/5] Update device-status.yaml --- code/API_definitions/device-status.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index 12bac42d..bfda7060 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -46,7 +46,7 @@ info: - `NOT_CONNECTED`, if device is not connected to the network * **LastStatusTime** : This property specifies the time when the status was last checked. Its inclusion in the response indicates that the information may not be current, while its absence suggests that the status information is fresh. - + # API Functionality The API exposes following capabilities: @@ -491,7 +491,7 @@ components: type: string format: date-time example: "2024-02-20T10:41:38.657Z" - + ActiveRoaming: description: Roaming status. True, if it is roaming type: boolean @@ -846,11 +846,11 @@ components: type: string format: date-time description: | - Timestamp of when the occurrence happened. - If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the current time) by the CloudEvents producer, - however all producers for the same source MUST be consistent in this respect. In other words, - either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used. - It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. + Timestamp of when the occurrence happened. + If the time of the occurrence cannot be determined then this attribute MAY be set to some other time (such as the current time) by the CloudEvents producer, + however all producers for the same source MUST be consistent in this respect. In other words, + either they all use the actual time of the occurrence or they all use the same algorithm to determine the value used. + It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z) example: "2018-04-05T17:31:00Z" From 60047ce64b705a739b326ea7de837df5a44d8792 Mon Sep 17 00:00:00 2001 From: sachinvodafone <84573274+sachinvodafone@users.noreply.github.com> Date: Fri, 26 Apr 2024 12:39:05 +0100 Subject: [PATCH 3/5] 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 bfda7060..910de76f 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -44,7 +44,7 @@ info: - `CONNECTED_SMS`, if device is connected to the network via SMS usage - `CONNECTED_DATA`, if device is connected to the network via data usage - `NOT_CONNECTED`, if device is not connected to the network - + * **LastStatusTime** : This property specifies the time when the status was last checked. Its inclusion in the response indicates that the information may not be current, while its absence suggests that the status information is fresh. # API Functionality From 394cd9d94a2128a6f397e1ed7cfa7c514c7e72c6 Mon Sep 17 00:00:00 2001 From: sachinvodafone <84573274+sachinvodafone@users.noreply.github.com> Date: Fri, 26 Apr 2024 12:55:39 +0100 Subject: [PATCH 4/5] 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 910de76f..da07ee3f 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -781,7 +781,7 @@ components: type: string format: uuid description: Identifier of the event subscription - This attribute must not be present in the POST request as it is provided by API server - example: qs15-h556-rt89-1298 + example: 550e8400-e29b-41d4-a716-446655440000 CloudEvent: description: The notification callback From fe37fb5d3c86a4f3ae5d30b941bd254633a16b12 Mon Sep 17 00:00:00 2001 From: sachinvodafone <84573274+sachinvodafone@users.noreply.github.com> Date: Tue, 7 May 2024 15:11:36 +0100 Subject: [PATCH 5/5] Update device-status.yaml --- code/API_definitions/device-status.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/device-status.yaml b/code/API_definitions/device-status.yaml index da07ee3f..5cb832e8 100644 --- a/code/API_definitions/device-status.yaml +++ b/code/API_definitions/device-status.yaml @@ -45,7 +45,7 @@ info: - `CONNECTED_DATA`, if device is connected to the network via data usage - `NOT_CONNECTED`, if device is not connected to the network - * **LastStatusTime** : This property specifies the time when the status was last checked. Its inclusion in the response indicates that the information may not be current, while its absence suggests that the status information is fresh. + * **LastStatusTime** : This property specifies the time when the status was last updated. Its presence in the response indicates the freshness of the information, while its absence implies the information may be outdated or its freshness is uncertain. # API Functionality @@ -487,7 +487,7 @@ components: $ref: "#/components/schemas/CountryName" LastStatusTime: - description: Last time that the associated device roaming status/connectivity was checked and, if necessary, updated + description: Last time that the associated device roaming status/connectivity was updated type: string format: date-time example: "2024-02-20T10:41:38.657Z"