search

camaraproject / DeviceLocation

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

How to understand the response parameter area in the device retrieval API #255

Open chinaunicomyangfan opened 2 months ago

chinaunicomyangfan commented 2 months ago

Problem description Hi Teams, About the location retrieval API, we are currently implementing this API and have encountered a problem. Regarding the region in the response parameters (including the type and size of the region), how is it obtained? Is it defined by the operator themselves? Are there any related constraints (such as not allowing the return area to be too large) and whether the actual location of device needs to be within the return area.

jlurien commented 2 months ago

Hi @chinaunicomyangfan, the returned area is only restricted to be compliant with the schema. It is up to the implementation to decide between a circle or polygon, but size is not limited, and currently client cannot request a maximum size to be returned, as for age. It is assumed that device is within the returned area (according to the information maintained by the operator), as that is the purpose of the service.

It may be a question to discuss if we should allow customers to define a threshold for a maximum area, similiar to maxAge, so implementations which cannot comply with the requirement do not returned a bigger area. cc @bigludo7

chinaunicomyangfan commented 2 months ago

If the size of the return area is not constrained, returning a large area does not violate the definition of the API, but for users, this result is obviously meaningless

bigludo7 commented 2 months ago

This is a fair point !

As we have a maxAge having a maxSurface could make sense. Let's discuss this point for our next release with the team durng Tuesday call.