camaraproject / DeviceLocation

Repository to describe, develop, document and test the DeviceLocation API family
Apache License 2.0
21 stars 33 forks source link

Rename /verifications to /verify-location in location-verification #84

Closed jlurien closed 1 year ago

jlurien commented 1 year ago

Problem description Currently, the naming of endpoints is not consistent among the APIs in progress:

Expected behavior Decide on a common approach. Originally, location-verification used /verify-location but it was changed due to alignment with Commonalities guidelines, which at that time requested paths to be names, but recently a new decision was taken to favor verbs

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.

Proposal is to revert pàth to the previous name: /verify-location

Alternative solution n/a

Additional context n/a

alpaycetin74 commented 1 year ago

Is it possible to simply name them "verify" and "retrieve" ? The basepath gives us the context it is about device location.

jlurien commented 1 year ago

Is it possible to simply name them "verify" and "retrieve" ? The basepath gives us the context it is about device location.

Yes, I guess that in the context of location, the verb would be enough. Whatever decision it has to be applied to both APIs.

jlurien commented 1 year ago

Agreed during meeting to change name to /verify