Commit cd2d4a01 authored by Christine Plumejeaud's avatar Christine Plumejeaud
Browse files

Add some description in README

parent 3a60e6df
...@@ -10,10 +10,10 @@ ...@@ -10,10 +10,10 @@
- [1.2.3. /pointcalls?](#123-pointcalls) - [1.2.3. /pointcalls?](#123-pointcalls)
- [1.2.4. /travels?](#124-travels) - [1.2.4. /travels?](#124-travels)
- [1.2.4.1. /details/departures?lon=lat=radius=](#1241-detailsdepartureslonlatradius) - [1.2.4.1. /details/departures?lon=lat=radius=](#1241-detailsdepartureslonlatradius)
- [1.2.4.1. /agg/departures?lon=lat=radius=](#1241-aggdepartureslonlatradius) - [1.2.4.2. /agg/departures?lon=lat=radius=](#1242-aggdepartureslonlatradius)
- [1.2.5. /agg/destinations?lon=lat=radius=](#125-aggdestinationslonlatradius) - [1.2.4.3. /agg/destinations?lon=lat=radius=](#1243-aggdestinationslonlatradius)
- [1.2.4.2. /travels?link_to_port="UHGS_id du port"&both-to=true](#1242-travelslinktoport%22uhgsid-du-port%22both-totrue) - [1.2.4.4. /travels?link_to_port="UHGS_id du port"&both-to=true](#1244-travelslinktoport%22uhgsid-du-port%22both-totrue)
- [1.2.4.3. /travels?link_to_port="UHGS_id du port"&degree=0&both-to=true](#1243-travelslinktoport%22uhgsid-du-port%22degree0both-totrue) - [1.2.4.5. /travels?link_to_port="UHGS_id du port"&degree=0&both-to=true](#1245-travelslinktoport%22uhgsid-du-port%22degree0both-totrue)
...@@ -146,7 +146,7 @@ Return the travels, at the departure of the points located in a 100 km radius ne ...@@ -146,7 +146,7 @@ Return the travels, at the departure of the points located in a 100 km radius ne
http://localhost/api/details/departures/?lat=45.2333&lon=toto&radius=100 http://localhost/api/details/departures/?lat=45.2333&lon=toto&radius=100
#### 1.2.4.1. /agg/departures?lon=lat=radius= #### 1.2.4.2. /agg/departures?lon=lat=radius=
Return the count of departures, for the points located in a radius km neighbourhood from the lat/lon given in parameter Return the count of departures, for the points located in a radius km neighbourhood from the lat/lon given in parameter
Will be extracted from postgres, schema navigoviz, table built_travels (see navigocorpus/ETL), Will be extracted from postgres, schema navigoviz, table built_travels (see navigocorpus/ETL),
...@@ -165,7 +165,7 @@ Exemple ...@@ -165,7 +165,7 @@ Exemple
### 1.2.5. /agg/destinations?lon=lat=radius= #### 1.2.4.3. /agg/destinations?lon=lat=radius=
Return the count of destination for each different admiralties, for the points located in a radius km neighbourhood from the lat/lon given in parameter Return the count of destination for each different admiralties, for the points located in a radius km neighbourhood from the lat/lon given in parameter
...@@ -180,7 +180,7 @@ Les calculs spatiaux sont déportés dans le SGBD Postgres pour bénéficier des ...@@ -180,7 +180,7 @@ Les calculs spatiaux sont déportés dans le SGBD Postgres pour bénéficier des
``` ```
#### 1.2.4.2. /travels?link_to_port="UHGS_id du port"&both-to=true #### 1.2.4.4. /travels?link_to_port="UHGS_id du port"&both-to=true
TODO not done yet TODO not done yet
...@@ -191,7 +191,7 @@ avec doublons si both-to=true ...@@ -191,7 +191,7 @@ avec doublons si both-to=true
- link_to_port : **null** | identifiant du port UHGS_id dans la base de données sur lequel on filtre les données si précisé - link_to_port : **null** | identifiant du port UHGS_id dans la base de données sur lequel on filtre les données si précisé
#### 1.2.4.3. /travels?link_to_port="UHGS_id du port"&degree=0&both-to=true #### 1.2.4.5. /travels?link_to_port="UHGS_id du port"&degree=0&both-to=true
TODO not done yet TODO not done yet
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment