Skip to content
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.

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

Clarification for initialEvent use in documentation #237

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

bigludo7
Copy link
Collaborator

What type of PR is this?

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

Clarify behavior of subscription/event server regarding use of initialEvent
Clarify roaming country change behavior

Which issue(s) this PR fixes:

Fixes #222

Special notes for reviewers:

Adding @gmuratk as reviewer.

Changelog input

 release-note
device-reachability-status-subscriptions:
- update yaml documentation part for initialEvent
device-roaming-status-subscriptions:
- update yaml documentation part for initialEvent
- update yaml documentation part for initialEvent roaming country change behavior

Additional documentation

This section can be blank.

docs

Copy link

github-actions bot commented Dec 22, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.02s
✅ OPENAPI spectral 5 0 8.04s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.77s
✅ YAML yamllint 5 0 1.0s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security


Following table illustrate behaviour regarding event triggering depending on **initial** reachability state of the device:

| subscrived event-type | device reachability status at subscription time | event send if ``initialEvent`` set to true |
Copy link
Contributor

Choose a reason for hiding this comment

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

minor typos in table header:
subscrived --> subscribed
event send --> event sent


Following table illustrate behaviour regarding event triggering depending on **initial** roaming state of the device:

| subscrived event-type | device roaming status at subscription time | event send if ``initialEvent`` set to true |
Copy link
Contributor

Choose a reason for hiding this comment

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

minor typos in table header:
subscrived --> subscribed
event send --> event sent


**Clarification on ``roaming-change-country`` event-type:**

``roaming-change-country`` event is send only when the device stays in roaming situation and change country.
Copy link
Contributor

Choose a reason for hiding this comment

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

event is 'sent'

Fix typos in table header
Fix typos
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.

Enhance API documentation
2 participants