Skip to content

Commit 34d191f

Browse files
vgeof-hovestifoon
andauthored
chore: Update first_section_mode[] : format bug (#4514)
Format correction in the definition of 'first_section_mode[]' Co-authored-by: Stephan Simart <stephan.simart@gmail.com>
1 parent c53ff75 commit 34d191f

1 file changed

Lines changed: 1 addition & 12 deletions

File tree

  • documentation/slate/source/includes

‎documentation/slate/source/includes/apis.md‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -994,18 +994,7 @@ See how disruptions affect a journey in the [real time](#realtime) section.
994994
| nop | data_freshness | enum | Define the freshness of data to use to compute journeys <ul><li>realtime</li><li>base_schedule</li></ul> _**when using the following parameter**_ "&data_freshness=base_schedule" <br> you can get disrupted journeys in the response. You can then display the disruption message to the traveler and make a realtime request to get a new "undisrupted" solution (considering all disruptions during journey planning). | base_schedule |
995995
| nop | forbidden_uris[] | id | If you want to avoid lines, modes, networks, etc.</br> Note: the forbidden_uris[] concern only the public transport objects. You can't for example forbid the use of the bike with them, you have to set the fallback modes for this (`first_section_mode[]` and `last_section_mode[]`) | |
996996
|nop | allowed_id[] | id | If you want to use only a small subset of the public transport objects in your solution. The constraint intersects with `forbidden_uris[]`. For example, if you ask for `allowed_id[]=line:A&forbidden_uris[]=physical_mode:Bus`, only vehicles of the line A that are not buses will be used. | everything |
997-
| nop | first_section_mode[] | array of string | Force the first section mode if the first section is not a public transport one. It takes the following values: `walking`, `car`, `bike`, `bss`, `ridesharing`, `taxi`.<br>
998-
It's an array, you can give multiple modes.<br>
999-
Using more than 1 mode<ul>
1000-
<li>may impact heavily performance</li>
1001-
<li>may hide many alternatives</li>
1002-
</ul>
1003-
Notes<ul>
1004-
<li>See [Ridesharing](#ridesharing-stuff) and [Taxi](#taxi-stuff) sections for more details on these modes.</li>
1005-
<li>`bss` stands for bike sharing system.<br>Note: choosing `bss` implicitly allows the `walking` mode since you might have to walk to the bss station.</li>
1006-
<li>The parameter is inclusive, not exclusive, so if you want to forbid a mode, you need to add all the other modes.</li>
1007-
<li>Example : if you want to use other mode but not `car`, you can request : `first_section_mode[]=walking&first_section_mode[]=bss&first_section_mode[]=bike&last_section_mode[]=walking&last_section_mode[]=bss&last_section_mode[]=bike`</li>
1008-
</ul> | walking |
997+
| nop | first_section_mode[] | array of string | Force the first section mode if the first section is not a public transport one. It takes the following values: `walking`, `car`, `bike`, `bss`, `ridesharing`, `taxi`.<br>It's an array, you can give multiple modes.<br>Using more than 1 mode<ul><li>may impact heavily performance</li><li>may hide many alternatives</li></ul>Notes<ul><li>See [Ridesharing](#ridesharing-stuff) and [Taxi](#taxi-stuff) sections for more details on these modes.</li><li>`bss` stands for bike sharing system.<br>Note: choosing `bss` implicitly allows the `walking` mode since you might have to walk to the bss station.</li><li>The parameter is inclusive, not exclusive, so if you want to forbid a mode, you need to add all the other modes.</li><li>Example : if you want to use other mode but not `car`, you can request : `first_section_mode[]=walking&first_section_mode[]=bss&first_section_mode[]=bike&last_section_mode[]=walking&last_section_mode[]=bss&last_section_mode[]=bike`</li></ul> | walking |
1009998
| nop | last_section_mode[] | array of string | Same as first_section_mode but for the last section | walking |
1010999
| nop | language | enum | Language for path guidance in walking sections.<br>Enum values:<ul><li>de-DE</li><li>en-GB</li><li>en-US</li><li>es-ES</li><li>fr-FR</li><li>hi-IN</li><li>it-IT</li><li>ja-JP</li><li>nl-NL</li><li>pt-PT</li><li>ru-RU</li></ul> | fr-FR |
10111000
| nop | depth | int | Json response [depth](#depth) | 1 |

0 commit comments

Comments
 (0)