Documentation

[jolevesq]

Add documentation to this repo

• ReadMe file
• Contributing, Licence file
• docs folder

Add needed information to clearly understand the project

• Diagram
• Info on each supported API
• Info on how to add a new API data source (schema, key, ...)
• ...

Recipe

• Build API on AWS (API gateway, Lamda coded in Python)
• Support Geonames, Nominatim, Google, NTS boundary and other custom format
• Create input and output schema for all sources
• Create metadata - lookup table for all sources
• Create a parser function who parse the input query and create the query for the proper service'
  • Function must be reusable and take param from schema and metadata to run. Adding a new service should not require new developement.
• Create a parser function who parse the output response and standardize the output.
  • Function must be reusable and take param from schema and metadata to run. Adding a new service should not require new developement.
• Build UI

[David-Henandez-nrcan]

Geolocator_2023.docx

[David-Henandez-nrcan]

Reverse coding for geocode. As shown in these links:
https://maps.googleapis.com/maps/api/geocode/json?latlng=40.7136181%20-73.9641317&key=AIzaSyASQcYTDCw4fRr_GY5WHxIAqeTsDmvAh_8
https://maps.googleapis.com/maps/api/geocode/json?latlng=40.714224,-73.961452&key=AIzaSyASQcYTDCw4fRr_GY5WHxIAqeTsDmvAh_8

• the parameter 'radius' has no effect on the query.
• the resulting items are just increasing levels of geographical features associated to the same coordinates.
  these features go from the more specific such as 'street_address'/'establishment' to the most generic such as 'country'.

Reverse code for nearby. As shown in this link:
https://maps.googleapis.com/maps/api/place/nearbysearch/json?location=-33.8670522,151.1957362&radius=500&types=food&name=harbour&key=AIzaSyASQcYTDCw4fRr_GY5WHxIAqeTsDmvAh_8

• Takes into account the value of the radius for the amount of features returned.
• the maximum number of features returned are 20.

Reverse code for geonames. as shown in this link:
https://geogratis.gc.ca/services/geoname/en/geonames.json?lat=45.5&lon=-71.5&radius=10

• The default value for the parameter 'radius' is 10 kms
• the maximum number of features returned are 100.