Clarification for initialEvent use in documentation by bigludo7 · Pull Request #237 · camaraproject/DeviceStatus

bigludo7 · 2024-12-22T16:09:55Z

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

Clarification for initialEvent & roaming event type

github-actions · 2024-12-22T16:11:13Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Errors	Elapsed time
✅ ACTION	actionlint	2	0	0.02s
✅ OPENAPI	spectral	6	0	10.13s
✅ REPOSITORY	git_diff	yes	no	0.01s
✅ REPOSITORY	secretlint	yes	no	0.8s
✅ YAML	yamllint	6	0	1.28s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by

gmuratk · 2024-12-23T14:18:47Z

code/API_definitions/device-reachability-status-subscriptions.yaml

+
+    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 |


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

gmuratk · 2024-12-23T14:18:51Z

code/API_definitions/device-roaming-status-subscriptions.yaml

+
+    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 |


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

gmuratk · 2024-12-23T14:18:56Z

code/API_definitions/device-roaming-status-subscriptions.yaml

+
+    **Clarification on ``roaming-change-country`` event-type:**
+
+    ``roaming-change-country`` event is send only when the device stays in roaming situation and change country.


event is 'sent'

Fix typos in table header

Fix typos

sachinvodafone · 2025-01-14T12:22:07Z

code/API_definitions/device-reachability-status-subscriptions.yaml

+    | reachability-sms  | disconnected | No |
+    | reachability-disconnected  | OK for Data or SMS usage | No |
+    | reachability-disconnected  | disconnected | Yes |
+


I am afraid that table is not coming nicely on the swagger editor

I took some time to interpret the table. Can we add some more information like (not necessary if others are fine with existing information):

@sachinvodafone

As suggested by @sachinvodafone

akoshunyadi · 2025-01-23T14:47:29Z

@bigludo7 only the new connected-network-type-subscriptions file is missing here, then we could merge it... 🙂

bigludo7 · 2025-01-23T15:12:35Z

@akoshunyadi This is because I do not have in my branch and I'm not able te retreive it :(
Do you think we can merge this one and then I trigger a specific PR for connected-network-type-subscriptions ?

akoshunyadi · 2025-01-23T15:28:57Z

@bigludo7 sure we can do it.... but..is there a specific error when you want to update the branch?

bigludo7 · 2025-01-23T16:07:50Z

@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 :(

bigludo7 · 2025-01-23T16:21:45Z

@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 triggers a PR to the project :(

akoshunyadi · 2025-01-23T16:22:44Z

that's weird, anyway then I review this one and the 3rd api will be done in a new PR

akoshunyadi

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.

bigludo7 · 2025-01-23T18:16:58Z

Thanks @akoshunyadi
Will merge it tomorrow and craft a new one for the last api.

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.

bigludo7 added 2 commits December 22, 2024 17:03

Clarification for initialEvent & roaming event type

f4a330b

Clarification for initialEvent & roaming event type

Clarification for initialEvent & reacheability event type

56002e7

bigludo7 self-assigned this Dec 22, 2024

bigludo7 requested review from akoshunyadi, eric-murray and sachinvodafone as code owners December 22, 2024 16:09

bigludo7 added the Spring25 label Dec 22, 2024

bigludo7 added 2 commits December 22, 2024 17:14

Fix MegaLinter issues

83b8717

Fix MegaLinter issues

ec2ded6

bigludo7 mentioned this pull request Dec 22, 2024

Enhance API documentation #222

Closed

gmuratk reviewed Dec 23, 2024

View reviewed changes

bigludo7 added 2 commits December 23, 2024 16:20

Fix typos in table header

db63c35

Fix typos in table header

Fix typos

a281b70

Fix typos

sachinvodafone reviewed Jan 14, 2025

View reviewed changes

bigludo7 added 3 commits January 15, 2025 13:42

Update table in the documentation

f981ae0

As suggested by @sachinvodafone

Add device-network-type-subscription.yaml

beb0fcb

Delete code/API_definitions/device-network-type-subscription.yaml

9941900

akoshunyadi approved these changes Jan 23, 2025

View reviewed changes

bigludo7 merged commit 0bc9796 into main Jan 23, 2025
1 check passed

bigludo7 deleted the intialEventDoc branch January 23, 2025 20:45


		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 \|


		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 \|


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

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

Conversation

bigludo7 commented Dec 22, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

Additional documentation

Uh oh!

github-actions bot commented Dec 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦙 MegaLinter status: ✅ SUCCESS

Uh oh!

gmuratk Dec 23, 2024

Choose a reason for hiding this comment

Uh oh!

gmuratk Dec 23, 2024

Choose a reason for hiding this comment

Uh oh!

gmuratk Dec 23, 2024

Choose a reason for hiding this comment

Uh oh!

sachinvodafone Jan 14, 2025

Choose a reason for hiding this comment

Uh oh!

sachinvodafone Jan 14, 2025

Choose a reason for hiding this comment

Uh oh!

akoshunyadi commented Jan 23, 2025

Uh oh!

bigludo7 commented Jan 23, 2025

Uh oh!

akoshunyadi commented Jan 23, 2025

Uh oh!

bigludo7 commented Jan 23, 2025

Uh oh!

bigludo7 commented Jan 23, 2025

Uh oh!

akoshunyadi commented Jan 23, 2025

Uh oh!

akoshunyadi left a comment

Choose a reason for hiding this comment

Uh oh!

bigludo7 commented Jan 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Dec 22, 2024 •

edited

Loading