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

182 Commits

Author SHA1 Message Date
Huyen Chau Nguyen
e998c1193d
Update docs for process_turn in the profile docs (#4786) 
* update correct attributes available in process turn

* make travel mode in ExtractedTurn const

* fix mismatch of struct and class
 2018-01-10 11:31:24 +01:00
Karen Shea
8883d8cc56
Update http.md 2018-01-08 12:21:41 +01:00
Minh Nguyễn
1d7f179374
Clarified pronunciation property 2017-12-06 13:13:17 -08:00
brian lewis
d9a03f8365 Refer to Lua scripting language by its correct name 2017-11-27 12:10:49 +01:00
brian lewis
ce5f284ec6 Fix typos in profiles documentation 2017-11-27 12:10:49 +01:00
Daniel Patterson
5b58445535 Expose driving_side as a property on RouteStep 2017-11-09 10:08:11 -05:00
Daniel J. H
948025440f Clarifies docs for roundabout exits (#4640) 2017-10-26 14:44:06 -07:00
Denis Koronchik
e1149bd4b7 Review fixes 2017-10-19 15:18:25 +01:00
Denis Koronchik
b6db39e69c Update documentation 2017-10-16 12:15:12 +01:00
Denis Koronchik
75bdf114be Review fixes 2017-09-14 20:00:05 +02:00
Denis Koronchik
8da6281dcd Update LUA profiles documentation 2017-09-14 20:00:05 +02:00
Moritz Kobitzsch
c2dc7e9cd0 use enter + exit for roundabout instructions (#4358) 
* Expose roundabout/rotary exit instructions as a new instruction type.
 2017-09-05 12:30:34 -07:00
Daniel Patterson
0fc1aa2711 Adds turn instructions to the turns layer in debug tiles. (#4460) 
Add turn types and modifiers to turn points in debug tiles.  Also refactor some of the tile code to reduce some repetition.
 2017-09-01 15:08:22 -07:00
Denis Koronchik
af10692d2d Fix misprint in documentation 2017-08-23 17:05:24 +02:00
Patrick Niklaus
bee1ba8854 Fix profile docs 2017-08-21 13:00:12 +02:00
Patrick Niklaus
261636febb Add HTTP docs 2017-08-21 13:00:12 +02:00
Patrick Niklaus
21f15f0a29 Add docs for lua profiles 2017-08-21 13:00:12 +02:00
Daniel J. Hofmann
3ff1a4263d Adds releasing docs about bumping to latest, see #4386 2017-08-11 15:53:14 +02:00
Moritz Kobitzsch
e5143247c2 move babel to dev dependencies, update releasing docs to reflect scripts in package.json 2017-08-03 14:31:41 +02:00
Daniel J. Hofmann
3a676183b2 Updates our node osrm docs and re-runs docs generation, resolves #4043 2017-08-03 14:31:41 +02:00
Daniel Patterson
dac6bb27aa Don't include turn costs when calculation weight/duration/speed annotations. 2017-07-25 15:14:45 -06:00
Daniel J. Hofmann
c2e8d6160f Documents system-wide limit constructor parameters in node bindings, resolves #4317 2017-07-24 13:02:56 +02:00
Patrick Niklaus
440dccb81b Move classes to intersection object and don't emit notifications 2017-07-18 16:48:22 +00:00
Emil Tin
e413b25cd9 profiles api v2 2017-07-18 10:09:22 +00:00
Moritz Kobitzsch
c0c9ec1c7b changelog, consistent deprecated documentation 2017-07-18 11:23:46 +02:00
Moritz Kobitzsch
7b755d6f8b deprecate use-lane -- the information can be found in the intersections array 2017-07-18 11:23:46 +02:00
Daniel J. Hofmann
54ceb05420 Implements Alternatives for MLD 2017-07-07 16:12:46 +00:00
Patrick Niklaus
44739f2dc3 Allow users to specify a class for each way 
This adds the ability to mark ways with a user-defined
class in the profile. This class information will be included
in the response as property of the RouteStep object.
 2017-07-06 09:17:49 +00:00
Daniel J. Hofmann
7d900e3b5a Implements Exit Numbers + Names (junction:ref way tag for now) 2017-07-04 20:58:19 +00:00
Daniel J. Hofmann
5c20c7b295 Explains what a roundtrip is in the api docs 2017-06-22 14:01:45 +02:00
Daniel Patterson
e3276324b9 Include 'rate' property (reciprocal of weight) on debug tile edges. (#4162) 
Include 'rate' property (reciprocal of weight) on debug tile edges and add turn weight data to debug tiles.
 2017-06-15 17:50:57 +02:00
Stepan Kuzmin
5ee3c4de9f Expose Map Matching gaps and tidy parameters in Node.js bindings #4021 2017-06-12 11:32:06 +00:00
Lev Dragunov
6b0bcb5171 Docs and tests 2017-06-07 15:24:00 +03:00
FILLAU Jean-Maxime
43ddc63d67 Adds documentations on 'approaches' parameter. 
Adds changelog
Adds doc/http.md doc
Adds doc/nodejs/api.md doc

Signed-off-by: FILLAU Jean-Maxime <jean-maxime.fillau@mapotempo.com>
 2017-05-31 15:02:55 +00:00
Mateusz Loskot
4294295242 Mark way_function properties as mandatory 
Format values and function names as code (refines #4040)
 2017-05-16 15:17:57 +00:00
Mateusz Loskot
7d58f0ec53 Document default values of global properties set in profile 2017-05-16 10:39:51 +00:00
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