Skip to content

Commit

Permalink
Addition of "lastStatusTime" Field
Browse files Browse the repository at this point in the history
  • Loading branch information
sachinvodafone authored Apr 26, 2024
1 parent d846f09 commit 62b8566
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion code/API_definitions/device-status.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Check failure on line 47 in code/API_definitions/device-status.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

47:1 [trailing-spaces] trailing spaces
* **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.

Check failure on line 49 in code/API_definitions/device-status.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

49:1 [trailing-spaces] trailing spaces
# API Functionality
The API exposes following capabilities:
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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"]
Expand Down Expand Up @@ -469,13 +477,21 @@ components:
required:
- roaming
properties:
lastStatusTime:
$ref: "#/components/schemas/LastStatusTime"
roaming:
$ref: "#/components/schemas/ActiveRoaming"
countryCode:
$ref: "#/components/schemas/CountryCode"
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"

Check failure on line 494 in code/API_definitions/device-status.yaml

View workflow job for this annotation

GitHub Actions / MegaLinter

494:1 [trailing-spaces] trailing spaces
ActiveRoaming:
description: Roaming status. True, if it is roaming
type: boolean
Expand All @@ -485,6 +501,8 @@ components:
required:
- connectivityStatus
properties:
lastStatusTime:
$ref: "#/components/schemas/LastStatusTime"
connectivityStatus:
$ref: "#/components/schemas/ConnectivityStatus"

Expand Down

0 comments on commit 62b8566

Please sign in to comment.