Page Link

https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/requests-and-return-types

Documentation is ...

Confusing

Please Explain in Detail:

I teach Python courses that use OpenRouteService API and one of the first examples my students encounter is using the directions API. One of the questions that always comes up is how do we know the field 'summary' exists in the returned GeoJSON and what are the units of 'distance' and 'duration' fields present in them. This is not documented anywhere in the docs or API playground and is confusing for new users.

Your Proposal for Changes:

It will be helpful it the GeoJSON fields are described and documented in the API reference at https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/requests-and-return-types and/or in the Help section of the API Playground (see screenshot below for details)

Forum Topic Link

No response