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

Path update per Design Guideline #96

Closed
gmuratk opened this issue Dec 15, 2023 · 5 comments · Fixed by #111 or #131 · May be fixed by gmuratk/DeviceStatus-fix-path#1
Closed

Path update per Design Guideline #96

gmuratk opened this issue Dec 15, 2023 · 5 comments · Fixed by #111 or #131 · May be fixed by gmuratk/DeviceStatus-fix-path#1

Comments

@gmuratk
Copy link
Contributor

gmuratk commented Dec 15, 2023

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
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Contributor Author

gmuratk commented Mar 20, 2024

@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
Copy link
Collaborator

@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
Copy link
Contributor Author

gmuratk commented Mar 25, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants