camaraproject / DeviceStatus

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

Path update per Design Guideline #96

Closed gmuratk closed 5 months ago

gmuratk commented 9 months ago

Problem description Following paths must be verbs per design guideline: /connectivity /roaming

From Design Guideline:

When the POST method is used, the resource in the path must be a verb (e.g. retrieve-location and not location) to differentiate from an actual resource creation.

Expected behavior "/connectivity" may be changed to "/retrieve-connectivity-status" and "/roaming" may be changed to "/retrieve-roaming-status"

Alternative solution

Additional context

sachinvodafone commented 9 months ago

I've observed that some APIs within Camara incorporate the term "get" as a verb in their endpoints. Therefore, it is essential to ensure consistency in the naming conventions for actions associated with all APIs whether to use "get" or "retrieve"

bigludo7 commented 8 months ago

Agreed with this request and that we should change our path as POST /roaming or POST /connectivity are confusing.

We can follow guideline (probably we're supposed to do this way) but looking to device-locatin API family I saw following path: location-retrieval and location-verification....

So not sure if we move to alignement with the rule (retrieve-roaming-status and retrieve-connectivity-status) or to be consistent (connectivity-status-retrieval and roaming-status-retrieval).

gmuratk commented 6 months ago

@akoshunyadi: I tried to resubmit (twice) but it doesn't appear in the list of PRs. Let me know please if you don't see the PRs.

akoshunyadi commented 6 months ago

@gmuratk I can see the PR, but it is a PR against your forked main and not the official main, that's why it doesn't appear at the PRs above

gmuratk commented 6 months ago

Thanks @akoshunyadi ! I think this time I reopened it in the right place successfully. see PR #131