camaraproject / DeviceStatus

Repository to describe, develop, document and test the Device Status API family
Apache License 2.0
11 stars 31 forks source link

Separate endpoint yamls proposal for direct API #152

Closed bigludo7 closed 4 days ago

bigludo7 commented 1 month ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

Separate endpoint yaml for reachability & roaming.

Which issue(s) this PR fixes:

Fixes #125 issue for Device error identifier to be added.

Special notes for reviewers:

Yaml for both roaming & reachability subscription provided once new subscription model merged in Commonalities API name & endpoint to be validated by the team

Changelog input

 release-note
- Split yaml device status in 4 separate yaml for reachability-retrieval, roaming-retrieval, reachability-subscriptions, roaming-subscriptions.
- Align device error messages following commonalities device identifier error definition.

Additional documentation

This section can be blank.

docs
github-actions[bot] commented 1 month ago

๐Ÿฆ™ MegaLinter status: โœ… SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
โœ… ACTION actionlint 2 0 0.03s
โœ… OPENAPI spectral 5 0 7.93s
โœ… REPOSITORY git_diff yes no 0.01s
โœ… REPOSITORY secretlint yes no 0.78s
โœ… YAML yamllint 5 0 0.9s

See detailed report in MegaLinter reports

_MegaLinter is graciously provided by OX Security_

maxl2287 commented 3 weeks ago

@bigludo7 @akoshunyadi Do we want to do here in this PR the split into 4 Yamls as well?

akoshunyadi commented 3 weeks ago

@maxl2287 we can do the 2 subscription APIs in a 2nd PR to the splitting issue

bigludo7 commented 3 weeks ago

@maxl2287 we can do the 2 subscription APIs in a 2nd PR to the splitting issue

Both work for me The most convenient for you Max.

maxl2287 commented 3 weeks ago

2nd PR is #161 for splitting /subscriptions

bigludo7 commented 3 weeks ago

Aligned device-roaming-status with the work done with device-reacheability-status. Need review by the team (@akoshunyadi @fernandopradocabrillo @maxl2287 @sachinvodafone) :)

bigludo7 commented 2 weeks ago

Hi team Seems that I've mixed myself for Device Reachability Status yaml (commit https://github.com/camaraproject/DeviceStatus/pull/152/commits/7e002c9b0a58c94eab6c1104e86a0365bc062ebf overrides https://github.com/camaraproject/DeviceStatus/pull/152/commits/b1b96c54cc21dbaa4f4c8bfa8806215f26d30e8c corrections).

I've fixed that (I hope so) + added Authorization and authentication ยง in the doc as suggested by @fernandopradocabrillo for both yaml.

Sorry for the confusion.

akoshunyadi commented 2 weeks ago

Where do we want to delete the old yaml? We could do it in this PR.

maxl2287 commented 2 weeks ago

I aggree with @akoshunyadi.

bigludo7 commented 2 weeks ago

@akoshunyadi @maxl2287 added delete the old file in this PR

bigludo7 commented 1 week ago

@sachinvodafone @fernandopradocabrillo may I ask you to review this one for blocking point as we target to merge this one soon. Thanks

bigludo7 commented 5 days ago

@akoshunyadi Due to git hub conflict issue I reinserted the 'old' device-status.yaml file and will remove it an a separate PR. Let's hope it will work.