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.

Sign up for GitHub

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

Some typo on external URL #4274

Merged
merged 6 commits into from
Mar 7, 2025
Merged

Some typo on external URL #4274

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
15f21b1
Some typo on external URL
stifoon May 29, 2024
9959e31
Update objects.md
stifoon May 29, 2024
98b1537
Update realtime.md
stifoon May 29, 2024
426d847
Update stuff.md
stifoon May 29, 2024
2c343f6
Merge branch 'dev' into patch-2
azime Mar 7, 2025
bffb828
Merge branch 'dev' into patch-2
azime Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/slate/source/includes/interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Interface
The base URL for **navitia.io** is:
<https://api.navitia.io/v1/>

We aim to implement [HATEOAS](http://en.wikipedia.org/wiki/HATEOAS)
We aim to implement [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS)
concept with Navitia.

Every resource returns a response containing a links object, a paging
Expand Down
4 changes: 2 additions & 2 deletions documentation/slate/source/includes/objects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ Severity object can be used to make visual grouping.
| Field | Type | Description
|---------------|------------|---------------------------------------------
| id |string |Identifier of the address
| content_type |string |Like text/html, you know? Otherwise, take a look at <http://www.w3.org/Protocols/rfc1341/4_Content-Type.html>
| content_type |string |Like text/html, you know? Otherwise, take a look at <https://www.w3.org/Protocols/rfc1341/4_Content-Type.html>
| name |string |name of the Channel

### Period
Expand Down Expand Up @@ -666,7 +666,7 @@ You can find pathways in [journeys](#journeys) service, where there is some "via
|zip_code|string|Zip code of the admin|

Cities are mainly on the 8 level, dependant on the country
(<http://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative>)
(<https://wiki.openstreetmap.org/wiki/Tag:boundary%3Dadministrative>)


### <a name="equipment-reports"></a>Equipment reports
Expand Down
18 changes: 9 additions & 9 deletions documentation/slate/source/includes/realtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ A disruption is present in the response of the endpoints described if the reques

Several public transport objects have separate collections for `base_schedule` and `realtime`.<br>So the data_freshness parameter may affect the number of objects returned depending on the request.

For example when looking for a specific circulation with the collection vehicle_journey using the request:<br>`http://api.navitia.io/v1/coverage/<toto>/vehicle_journeys?since=20191008T100000&until=20191008T200000&data_freshness=base_schedule`.
For example when looking for a specific circulation with the collection vehicle_journey using the request:<br>`https://api.navitia.io/v1/coverage/<toto>/vehicle_journeys?since=20191008T100000&until=20191008T200000&data_freshness=base_schedule`.

A vehicle_journey circulating between since and until that is **fully deleted** (NO_SERVICE) by a disruption will
of course be **visible** if `data_freshness=base_schedule`.<br>But it **will not appear** with the parameter `data_freshness=realtime` as it does not exist in that collection.
Expand Down Expand Up @@ -85,7 +85,7 @@ See the [disruption](#disruption) objects section for its full content and descr

``` shell
# Request example for /journeys
http://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -165,7 +165,7 @@ A list of the disruptions impacting the journey is also present at the root leve

``` shell
# Request example for /departures (data_freshness=realtime by default)
http://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/stop_areas/<stop_area>/departures?from_datetime=<from_date>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/stop_areas/<stop_area>/departures?from_datetime=<from_date>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -220,7 +220,7 @@ A list of the disruptions impacting the departures is also present at the root l

``` shell
# Request example for /stop_schedules (data_freshness=realtime by default)
http://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/stop_schedules?from_datetime=<from_date>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/stop_schedules?from_datetime=<from_date>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -365,7 +365,7 @@ In the disruption, new stop points can be found in the list of "impacted_stops"

``` shell
# Request example for /journeys
http://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -464,7 +464,7 @@ In the disruption, every stops served by the new train can be found in the list

``` shell
# Request example for /journeys
http://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/journeys?from=<origin>&to=<destination>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -567,7 +567,7 @@ When requesting a journey that was previously disrupted and is now back to norma

``` shell
# Request example for /departures (data_freshness=realtime by default)
http://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/stop_areas/<stop_area>/departures?from_datetime=<from_date>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/stop_areas/<stop_area>/departures?from_datetime=<from_date>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -613,7 +613,7 @@ No disruption is present at the root level of the response and so, in the sectio

``` shell
# Request example for /stop_schedules (data_freshness=realtime by default)
http://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/stop_schedules?from_datetime=<from_date>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/stop_schedules?from_datetime=<from_date>&data_freshness=realtime
```

``` shell
Expand Down Expand Up @@ -651,7 +651,7 @@ No disruption is present at the root level of the response and so, in the sectio

``` shell
# Request example for /terminus_schedules (data_freshness=base_schedule by default)
http://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/terminus_schedules?from_datetime=<from_date>&data_freshness=realtime
https://api.navitia.io/v1/coverage/<coverage>/physical_modes/<physical_mode>/lines/<line>/stop_areas/<stop_area>/terminus_schedules?from_datetime=<from_date>&data_freshness=realtime
```

``` shell
Expand Down
4 changes: 2 additions & 2 deletions documentation/slate/source/includes/stuff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Multiple journeys
Navitia can compute several kind of journeys with a journey query.

The
[RAPTOR](http://research.microsoft.com/apps/pubs/default.aspx?id=156567)
[RAPTOR](https://www.microsoft.com/en-us/research/publication/round-based-public-transit-routing)
algorithm used in Navitia is a multi-objective algorithm. Thus it might
return multiple journeys if it cannot know that one is better than the
other. For example it cannot decide that a one hour journey with no
connection is better than a 45 minutes journey with one connection
(it is called the [pareto front](http://en.wikipedia.org/wiki/Pareto_efficiency)).
Navitia uses multiple objectives : arrival datetime, the number of transfers,
the duration of "walking" (transfers and fallback), reliability of lines, crowd, etc.
the duration of "walking" (transfers and fallback), reliability of lines, occupancy, etc.

If the user asks for more journeys than the number of journeys given by
RAPTOR (with the parameter `min_nb_journeys` or `count`), Navitia will
Expand Down
Loading