Repository navigation
[Changed] Documentation update for improved clarity - #96
Merged
eric-murray merged 23 commits intoOct 15, 2026
Merged
Conversation
Updated descriptions for clarity and consistency in the API documentation. Adjusted event type definitions and clarified event triggering conditions.
Updated the wording for clarity in the device roaming status subscription documentation.
Updated formatting for terms and definitions in the device roaming status API documentation.
Clarified the description of LastStatusTime to indicate confirmation by the API provider and potential connectivity issues.
Updated definitions for 'Roaming' and 'Device', and added new definition for 'Country'.
Updated the section title and clarified the endpoint description for better understanding.
eric-murray
requested review from
akoshunyadi,
bigludo7 and
sachinvodafone
as code owners
August 13, 2026 08:16
eric-murray
marked this pull request as draft
August 13, 2026 08:17
eric-murray
changed the title
eric-murray
marked this pull request as ready for review
September 25, 2026 12:20
Updated the device roaming status API documentation to include detailed error handling and examples for identifying devices by various methods.
Clarified the definition of 'Device' to specify it as physical hardware and updated the API response description to include roaming status.
Corrected capitalization of 'Phone' and 'Network Access Identifier' to 'phone' and 'network access identifier' for consistency.
sachinvodafone
approved these changes
Oct 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
This PR updates the API inline documentation for improved clarity.
Which issue(s) this PR fixes:
Fixes #
Special notes for reviewers:
There are no functional changes introduced by this PR.
Changelog input
Additional documentation
None