Open-Harbor/osrm-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity
8,725 Commits 27 Branches 246 Tags 163 MiB
17e1c04136
Commit Graph

196 Commits

Author SHA1 Message Date
Patrick Niklaus
26a208529e [skip ci] Fix alternatives_count documentation 2017-05-15 17:02:41 +00:00
Patrick Niklaus
35d7b7ceaf Regenerate docs 2017-05-05 08:51:36 +00:00
Patrick Niklaus
2a24468267 Regenerate API docs 2017-05-03 15:23:03 +00:00
Patrick Niklaus
273fd689ce Always check local variables 2017-03-30 20:12:07 +00:00
Patrick Niklaus
0363d64722 Update releasing docs 2017-03-30 20:12:07 +00:00
Patrick Niklaus
de98ae57b7 Switch to yarn 2017-03-30 20:12:07 +00:00
Patrick Niklaus
614398ed6c Integrate MLD in node bindings 2017-03-30 20:12:07 +00:00
Michael Krasnyk
2cd4ba9a0a move split_edges to global properties 2017-03-30 11:20:13 +02:00
Michael Krasnyk
57d3f71bf9 added change log entry and documentation 2017-03-30 11:20:13 +02:00
Richard Fairhurst
ed83d3ed13 More turn parameters as per @daniel-j-h's comment 2017-03-28 11:58:42 +02:00
Richard Fairhurst
aa1dff3fc4 Update _rate as per @TheMarex's comment 2017-03-28 11:58:42 +02:00
Richard Fairhurst
c1901e9689 Add new property from #3840 2017-03-28 11:58:42 +02:00
Richard Fairhurst
c6e6d9fa94 Explain parameters as per @daniel-j-h's suggestion 2017-03-28 11:58:42 +02:00
Richard Fairhurst
88eabb98b9 Document all options available to Lua profiles 
Recent improvements to OSRM have led to a lot of changes to the Lua scripting interface, and refactoring of the default profiles makes them slightly more abstract and difficult to grok for those writing profiles from scratch.

This is therefore an attempt to fully document the attributes that can be read and set from Lua profiles. I've done it from my own understanding and from reading the source, but I may well have missed things or mistaken them!
 2017-03-28 11:58:42 +02:00
Lev Dragunov
497709da13 Review fixes 2017-03-22 10:39:36 +00:00
Lev Dragunov
2fab696bb3 New tidying and gaps parameters. 2017-03-22 10:39:36 +00:00
Lev Dragunov
e9c0987e8a Integration #3149 and #3815 2017-03-22 10:39:36 +00:00
Lev Dragunov
441eae9df2 Tidying prarameter for the map matching plugin. 2017-03-22 10:39:36 +00:00
Daniel J. Hofmann
215489286d Back to Monaco for examples and benchmarks 2017-03-21 20:10:39 +00:00
Daniel J. Hofmann
2351b5a084 Merges node-osrm into repository 
Build with

    cmake .. -DCMAKE_BUILD_TYPE=Release -DENABLE_NODE_BINDINGS=On -DENABLE_MASON=On
 2017-03-21 20:10:39 +00:00
Daniel J. Hofmann
40094ceeab Documents roundtrip param, closes #3741 2017-03-13 16:30:48 +00:00
Daniel J. Hofmann
bf6b571455 Documents null in Table response if no route can be found 2017-03-09 11:17:22 +00:00
Lev Dragunov
07221f5a48 Do not take the current route into account in alternatives_count parameter. 2017-03-01 01:29:00 +00:00
Lev Dragunov
5be6f8959a Describe alternatives_count in documentation 2017-03-01 01:29:00 +00:00
Kajari Ghosh
a45b9e07fc Update http.md 
Clarify where optional rotary properties will be added
 2017-02-15 21:55:22 +00:00
Kajari Ghosh
335362315c Correct a typo in the docs (#3706) 
Fix the typo of `summary` parameter table that was mislabeled `steps`.
 2017-02-13 13:45:24 -08:00
Quinn Chrzan
1ed1bae249 Unit testing docs (#3698) 
* Updating library-tests and associated documentation to be more informative

* Fixing heading markup for updated unit testing docs
 2017-02-13 15:58:46 +01:00
Karen Shea
38a1edfe3c Update http.md 2017-02-13 14:59:54 +01:00
Kajari Ghosh
2218658969 Trip with Fixed Start and End points (TFSE) (#3408) 
* fixed start and end trip feature to trip service
 2017-02-10 05:13:20 -05:00
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
karenzshea
ab91a05680 update cucumber suport code to return separate annotations headers 2017-02-07 09:15:16 +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
Moritz Kobitzsch
e6ff17ab2a refactor merging of segregated roads 
adjust to generalFindMaximum function
moved parallel detection to ratio/absolute based regression testing
considerably improved detection quality using normalised regression lines
only follow initial direction/narrow turns for parallel detection
 2017-01-03 12:32:51 +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
Moritz Kobitzsch
aaf42a1caf add a follow-up section on testing to help decide what to do on guidance tests 2016-11-24 10:12:14 +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
Patrick Niklaus
3235f30a98
[skip ci] clarify release branches 2016-11-14 23:21:48 +00: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
Moritz Kobitzsch
8a3aec301a add a segment on turn restrictions to the cucumber guide 2016-11-02 16:06:37 +01:00
Moritz Kobitzsch
4ba8ccfcce add a geojson debugger that allows creating features for easy inspection 2016-11-02 14:54:00 +01: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
Emil Tin
7cbb1807e7 cucumber: change syntax of node maps 2016-10-11 09:07:48 +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
2284ebaacb
[skip ci] Iterate on the release docs 2016-08-05 18:07:28 +02:00
Patrick Niklaus
6b4975b2e4
Fix the release branch 2016-08-05 18:07:28 +02:00
Johan Uhle
94c38d115a
Fixing up the release flow docs 
- Clarifying guarantees between patch/minor/major versions
- Consolidating version release flow into one flow for patch/minor/major versions
- Add constraint that all minor/major released code needs to have had a release candidate before
 2016-08-05 18:07:28 +02: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
1fc63e1e72
move hardcoded road priorities into profiles, change road classification 2016-07-25 13:07:54 +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
Daniel J. Hofmann
cf2d2b6763
Boost.Test Testing Docs 2016-06-10 19:03:44 +02:00
Moritz Kobitzsch
95cd44f34f
add directions guide 2016-06-10 19:03:44 +02:00
Moritz Kobitzsch
d330e60d40
added a guide on writing good cucumber tests for osrm 2016-06-10 19:03:44 +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
c7303be33b
[skip ci] Add specifics about how we interpret semver 2016-05-03 23:36:27 +02:00
Patrick Niklaus
578eda7d28
[skip ci] Add release docs 2016-04-29 14:00:10 +02:00
Patrick Niklaus
505f4cb4a2
[skip ci] Add profile documentation 2016-04-29 13:10:43 +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
Patrick Niklaus
8f3fe410b8
Import docs from the wiki 2016-04-29 12:16:19 +02:00