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

Error doc description for 'valid' field #5990

Closed
wangyoucao577 opened this issue Mar 22, 2021 · 0 comments · Fixed by #5994
Closed

Error doc description for 'valid' field #5990

wangyoucao577 opened this issue Mar 22, 2021 · 0 comments · Fixed by #5994

Comments

@wangyoucao577
Copy link
Contributor

In current http.md, the valid field's description is
valid: a boolean flag indicating whether the lane is a valid choice in the current maneuver.
But the example is string rather than bool:

{
    "indications": ["left", "straight"],
    "valid": "false"
}

By trying real case, the value is bool in json response.
http://router.project-osrm.org/route/v1/driving/-121.685212%2C37.233934%3B-121.565400%2C37.024500%3B-121.380400%2C36.989900%3B-121.017600%2C37.109400%3B-120.237900%2C36.254100%3B-119.331600%2C35.354600%3B-118.174600%2C35.068600%3B-116.817627%2C34.912962?overview=false&steps=true

"lanes": [
{
"valid": true,
"indications": [
"left"
]
},

So I think it's just the doc example error. Will create a PR to correct it.

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

Successfully merging a pull request may close this issue.

1 participant