Jonathon Rossi
005124fe1c
Fix JSON syntax error in HTTP API docs ( #3679 )
2017-02-09 20:24:21 +01:00
Daniel J. Hofmann
880b982eeb
Removes exit field for intersection counting; only used for roundabouts
...
- f3ebba7a79/src/engine/api/json_factory.cpp (L197-L198)f3ebba7a79/src/engine/guidance/post_processing.cpp (L153)
2017-02-07 11:42:57 +00:00
Daniel J. Hofmann
53011755a2
Removes distance field from Waypoint docs
...
Waypoint objects have
- name
- location
- hint
fields. The only API adding `distance` to waypoints is the Nearest
plugin. And it documents this behavior independently.
The docs are wrong here from what I can tell. See:
- https://github.com/Project-OSRM/osrm-backend/blob/5.5/src/engine/api/json_factory.cpp#L290-L297
- https://github.com/Project-OSRM/osrm-backend/blob/5.5/include/engine/api/nearest_api.hpp#L37-L44
2017-02-07 11:42:57 +00:00
Kajari Ghosh
5b24758742
Make docs more consistent.
...
Change the word `field` to `property` for accuracy.
2017-01-27 16:41:34 -08:00
Michael Krasnyk
ad594cb2e4
Update review findings
2017-01-27 11:19:37 +01:00
Daniel J. Hofmann
b1f6797aab
Adds generate_hints=true for dropping hints in response, resolves #1789 .
...
Adds an `generate_hints=false` option which lets us skip generating and
emitting hints for Waypoints. This can be used to decrease the response
size when the user does not need hints anyway.
We should think about making `false` the default here in v6.
2016-12-19 12:09:36 +01:00
Daniel Patterson
1b51163b1d
Clarify API and ensure bearings returned to users are in the range 0-359
2016-12-15 10:59:17 +01:00
Daniel J. Hofmann
cbfb055f81
Changes Single Coordinate Geoms from Point to LineString, closes #3425 .
2016-12-09 11:53:06 +01:00
Daniel Patterson
560d8ffec0
Restructure API docs so that they can be formatted with Docbox. ( #3355 )
...
Generate Docbox browseable HTML with `npm run build-api-docs`
2016-11-30 19:38:53 -08:00
Moritz Kobitzsch
12d58ace10
add support for junction=circular, allowing named circular junctions to be treated as rotaries
2016-11-29 13:44:32 +01:00
Alex Barth
c1087eaecc
Update http.md
2016-11-17 23:59:18 +01:00
Kerrick Staley
15359befdc
Update docs
2016-11-17 17:56:23 +01:00
Daniel Patterson
46b00e1378
Update docs for tile plugin.
2016-11-15 18:56:03 -08:00
Kajari Ghosh
f33180f092
request polyline with precision of 5 or 6 positions ( #3220 )
2016-11-07 15:11:21 -05:00
kerrick-lyft
79917d2c8e
Fix typo: Ẁaypoint -> Waypoint
2016-11-03 21:25:10 +00:00
Daniel J. Hofmann
a933b5d949
Prevents the Matching getting confused when users are time-travelling.
2016-10-25 10:42:24 -07:00
Daniel J. Hofmann
1905a0f473
Documents InvalidValue response code, resolves #3150
2016-10-24 09:54:09 -07:00
Johan Uhle
9af00b1925
Docs: Rotaries can have exits as well
2016-10-18 02:20:18 +02:00
Patrick Niklaus
14b024e4dc
[skip ci] Document InvalidQuery. Fixes #3026
2016-10-10 17:37:34 +02:00
Moritz Kobitzsch
df6186f0f1
fix documentation
2016-09-29 12:05:19 +02:00
Daniel J. Hofmann
89264eb89b
Better documents profile request parameter, resolves #2952
2016-09-28 09:03:06 +02:00
Daniel J. Hofmann
05c1fe7f46
We do duration based routing (also see #77 ); closes #2885
2016-09-09 16:27:00 +02:00
karenzshea
dcc1b5ab2b
return name and reference separately
2016-09-08 14:28:23 +02:00
Moritz Kobitzsch
938dff011f
handle all our new strings correctly, introduce rotary_pronunciation
2016-09-07 16:09:13 +02:00
Daniel Patterson
7899444135
Add example request to the route API esection
2016-09-06 10:31:08 -07:00
Patrick Niklaus
14797c421e
Reformated the docs for annotations
2016-07-27 15:51:11 -07:00
Daniel Patterson
280b000f07
Include datasources for each segment in route annotation.
2016-07-27 15:51:11 -07:00
Johan Uhle
f76e3d4522
Docs: Clarify turn lanes on missing data
...
After https://github.com/Project-OSRM/osrm-backend/issues/2675#issuecomment-235230198
2016-07-26 13:18:01 +02:00
Moritz Kobitzsch
41ba20ca9a
switch api format to new structure
2016-07-21 17:42:10 +02:00
Moritz Kobitzsch
49221995e8
add documentation on use lane type
2016-06-28 17:53:31 +02:00
Patrick Niklaus
8fdbe965cc
[skip ci] Fix documentation
2016-06-28 11:08:37 +02:00
Moritz Kobitzsch
5905708111
expose lanes as enums, adjusted for comments
2016-06-27 11:12:02 +02:00
Moritz Kobitzsch
5d91b759d1
Implement Turn Lane Api
2016-06-27 10:07:48 +02:00
Emil Tin
bbcc728a07
Update http.md
...
clarify "new name" instruction
2016-06-10 09:42:13 +02:00
Patrick Niklaus
e198709643
Add documentation about nodes property
2016-06-02 14:28:33 +02:00
Daniel J. Hofmann
6edc565c01
Add destinations API feature
2016-06-02 12:00:23 +02:00
Patrick Niklaus
0a53775fb3
Expose pronunciation in RouteStep
...
Uses name:pronunciation by default for cars.
2016-06-01 23:17:57 +02:00
Patrick Niklaus
262354f733
Rename annotate to annotations
2016-05-26 23:35:11 +02:00
Mathias Gug
1635f7351d
Support environment variable to disable http requests logging.
2016-05-20 12:47:47 -07:00
Patrick Niklaus
95af72c70c
Make intersection backwards compatible
...
For `depart` and `arrive` `step.intersections[0].{bearings|entry}` will have
only one entry.
2016-05-19 16:44:31 +02:00
Moritz Kobitzsch
a322e27e05
update changelog/docs
2016-05-19 16:44:31 +02:00
Mathias Gug
ba386d4b2c
Document environment variable.
2016-05-18 23:59:52 +02:00
Daniel Patterson
0903b8227f
Example of the annotation response value.
2016-05-12 01:11:09 +02:00
Daniel Patterson
fa525ad610
Return an array with meta-data for each coordinate.
...
Currently supports duration and distance for each coordinate.
This is particularly useful in map-matching, comparing how
a trip progresses compared to a real GPS trace that is
map-matched.
2016-05-12 01:11:09 +02:00
Patrick Niklaus
6aed145dae
[skip ci] Rephrased the API docs in terms of adding new types
2016-05-09 18:39:30 +02:00
Moritz Kobitzsch
6018fcf490
Introduce on_ramp and off_ramp, deprecate ramp
2016-05-04 12:09:54 +02:00
Patrick Niklaus
d3a5cadb6c
[skip ci] Fix linkt to C++ library
2016-04-29 12:26:04 +02:00
Patrick Niklaus
65351faf83
[skip ci] Move correct docs.
2016-04-29 12:24:21 +02:00
Patrick Niklaus
3aa1c5f13c
Link docs from README
2016-04-29 12:20:51 +02:00
