-
Notifications
You must be signed in to change notification settings - Fork 33
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
Conversation
Clarification for initialEvent & roaming event type
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports |
|
||
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 | |
There was a problem hiding this comment.
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 | |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
| reachability-sms | disconnected | No | | ||
| reachability-disconnected | OK for Data or SMS usage | No | | ||
| reachability-disconnected | disconnected | Yes | | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am afraid that table is not coming nicely on the swagger editor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bigludo7 only the new connected-network-type-subscriptions file is missing here, then we could merge it... 🙂 |
@akoshunyadi This is because I do not have in my branch and I'm not able te retreive it :( |
@bigludo7 sure we can do it.... but..is there a specific error when you want to update the branch? |
I would like to populate my branch with latest code but it trigger a PR to the project :( |
|
that's weird, anyway then I review this one and the 3rd api will be done in a new PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Just a comment: checking the reachability status subscriptions file... it doesn't really fit now the reachability retrieve API, which supports both data and sms at the same time. Do we need a change for that? Not for Spring25, for sure.
Thanks @akoshunyadi Fair question. I tend to think this is less relevant for the subscription than for the 'direct' request but in same time have same behavior btw both API is more consistent. Let's open an issue to gather team feedback. |
What type of PR is this?
Add one of the following kinds:
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
Additional documentation
This section can be blank.