Skip to content

[Changed] Make lastStatusTime nullable, and add an example #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
eric-murray wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

[Changed] Make lastStatusTime nullable, and add an example #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1682344
Update device-roaming-status.yaml
eric-murray Jul 10, 2026
1e75ee8
Enhance device roaming status YAML with description
eric-murray Jul 10, 2026
5abecf0
Update lastStatusTime property validation to allow null
eric-murray Jul 30, 2026
b726b42
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Aug 7, 2026
31cee8b
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Sep 1, 2026
67f920c
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Sep 14, 2026
db2ddf4
Merge branch 'camaraproject:main' into eric-murray-patch-1
eric-murray Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions code/API_definitions/device-roaming-status.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
- return the roaming status for a single device in the multi-SIM group, which may not be the intended device.

Possible solutions in such a scenario include:
- Using the authorisation code flow to obtain an access token, which will automatically identify the intended device

Check warning on line 78 in code/API_definitions/device-roaming-status.yaml

View workflow job for this annotation

GitHub Actions / validation / Validate

info.description mandatory template content drift 

[P-027] info.description template 'additional-error-responses' has drifted from canonical at paragraph 3.   canonical: Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable C...   found:     Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable C... Re-copy the BEGIN..END block from 'code/common/info-description-templates.yaml'. | Suggestion: Re-copy the BEGIN..END block from code/common/info-description-templates.yaml to replace the drifted content; the message identifies the first differing paragraph.
- Identifying the intended device from a unique identifier for that device, such as its source IP address and port
- Check with the SIM provider whether a unique "secondary" phone number is already associated with each device, and use the secondary phone number to identify the intended device if available.

Expand Down Expand Up @@ -204,6 +204,13 @@
roaming: true
countryCode: 340
countryName: ["BL", "GF", "GP", "MF", "MQ"]
Last Status Update Time Unknown:
description: The API provider has recorded that the device is currently roaming, but has no information as to when that status was last confirmed to be correct. The API consumer must take this uncertainty into account when deciding on the value of the information to them.
value:
lastStatusTime: null
roaming: true
countryCode: 262
countryName: ["DE"]
"400":
$ref: "../common/CAMARA_common.yaml#/components/responses/Generic400"
"401":
Expand All @@ -229,8 +236,11 @@
description: |
The last time that the device roaming status was confirmed to be correct by the API provider. It might not be possible to provide the current status because, for example, the device may not be connected to any mobile network.
It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and must have time zone.
allOf:
- $ref: "../common/CAMARA_common.yaml#/components/schemas/DateTime"
type: string
format: date-time
maxLength: 64
nullable: true
example: "2018-04-05T17:31:00Z"

ActiveRoaming:
description: Roaming status. True, if it is roaming
Expand Down
4 changes: 2 additions & 2 deletions code/Test_definitions/device-roaming-status.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Feature: CAMARA Device Roaming Status API, vwip - Operation getRoamingStatus
And the response property "$.roaming" is "true"
And the response property "$.countryCode" has the value "262" as the Mobile Country Code (MCC) for Germany
And the response property "$.countryName" is a non-empty array containing the ISO 3166 ALPHA-2 country-code ["DE"]
And the response property "$.lastStatusTime" is present and has a valid date-time format for a time in the past
And the response property "$.lastStatusTime" is present and either has a valid date-time format for a time in the past, or is null

@device_roaming_status_02_roaming_status_false
Scenario: Check the roaming state synchronously if the device is not in the roaming mode
Expand All @@ -50,7 +50,7 @@ Feature: CAMARA Device Roaming Status API, vwip - Operation getRoamingStatus
And the response property "$.roaming" is "false"
And the response property "$.countryCode" is not present
And the response property "$.countryName" is not present
And the response property "$.lastStatusTime" is present and has a valid date-time format for a time in the past
And the response property "$.lastStatusTime" is present and either has a valid date-time format for a time in the past, or is null

#################
# Error scenarios for management of input parameter device
Expand Down
Loading