Skip to content

[Changed] Improve documentation and fix typos - #85

Open
eric-murray wants to merge 24 commits into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2
Open

eric-murray wants to merge 24 commits into
camaraproject:mainfrom
eric-murray:eric-murray-patch-2

Conversation

@eric-murray

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

This PR improves the API documentation and fixes typos

Which issue(s) this PR fixes:

Fixes #

Special notes for reviewers:

None

Changelog input

 release-note
 - Improve documentation and fix typos

Additional documentation

None

Updated the table formatting for clarity on event triggering based on device reachability status.
Updated the description of the event notification format and the callback endpoint requirements for API consumers.
@eric-murray
eric-murray marked this pull request as draft August 12, 2026 09:04
sachinvodafone
sachinvodafone previously approved these changes Aug 12, 2026
Revised the description of reachability status notifications and clarified subscription management for device reachability events.
Removed redundant definitions for 'Reachable' and 'Connectivity' to streamline the document.
Updated the API documentation to clarify the reachability status.
Added definition for 'Connectivity' in device reachability status.
Updated event type descriptions for clarity and consistency.
@eric-murray
eric-murray marked this pull request as ready for review October 2, 2026 15:40
Updated terminology for clarity and consistency in the API documentation.
Clarified the usage of the `subscription-ended` event and updated the wording for consistency.
Updated the response description for device identifier selection.
Corrected capitalization of 'Phone' and 'Network Access Identifier' for consistency.

@bigludo7 bigludo7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants