We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Our docs mention in several places that waypoint objects in responses to pretty much all APIs should contain a distance property.
waypoint
distance
However, only the nearest plugin actually does this - other APIs (table, route, etc) don't include a distance property for waypoints.
nearest
table
route
In many of our sample snippets in the docs, the distance property is shown for waypoint objects, even though we don't actually emit one.
We should just be consistent here and return it always. The nearest plugin here:
https://github.com/Project-OSRM/osrm-backend/blob/master/include/engine/api/nearest_api.hpp#L43-L44
shows how the property can be added - although this could be moved to the BaseAPI and just done for all cases.
Once it's consistently available, we should also update the docs.
The text was updated successfully, but these errors were encountered:
Released in 5.21.0
Sorry, something went wrong.
No branches or pull requests
Our docs mention in several places that
waypoint
objects in responses to pretty much all APIs should contain adistance
property.However, only the
nearest
plugin actually does this - other APIs (table
,route
, etc) don't include adistance
property for waypoints.In many of our sample snippets in the docs, the
distance
property is shown forwaypoint
objects, even though we don't actually emit one.We should just be consistent here and return it always. The
nearest
plugin here:https://github.com/Project-OSRM/osrm-backend/blob/master/include/engine/api/nearest_api.hpp#L43-L44
shows how the property can be added - although this could be moved to the BaseAPI and just done for all cases.
Once it's consistently available, we should also update the docs.
The text was updated successfully, but these errors were encountered: