From 83ab1636e1c4ab73c1b0f9d76bbb8b83080f6098 Mon Sep 17 00:00:00 2001 From: missinglink Date: Fri, 18 May 2018 14:58:21 +0200 Subject: [PATCH] readme: documentation for api.targets config --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0991c143..c3287227 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ The API recognizes the following properties under the top-level `api` key in you |`accessLog`|*no*||name of the format to use for access logs; may be any one of the [predefined values](https://github.com/expressjs/morgan#predefined-formats) in the `morgan` package. Defaults to `"common"`; if set to `false`, or an otherwise falsy value, disables access-logging entirely.| |`services`|*no*||service definitions for [point-in-polygon](https://github.com/pelias/pip-service), [libpostal](https://github.com/whosonfirst/go-whosonfirst-libpostal), [placeholder](https://github.com/pelias/placeholder), and [interpolation](https://github.com/pelias/interpolation) services. If missing (which is not recommended), the services will not be called.| |`defaultParameters.focus.point.lon`
`defaultParameters.focus.point.lat`|no | |default coordinates for focus point +|`targets.layers_by_source`
`targets.source_aliases`
`targets.layer_aliases`|no | |custom values for which `sources` and `layers` the API accepts ([more info](https://github.com/pelias/api/pull/1131)). A good starting configuration file includes this section (fill in the service and Elasticsearch hosts as needed):