Skip to content

Commit 34af6a7

Browse files
committed
docs: correct config.schema.indexName reference
1 parent 6037d95 commit 34af6a7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,6 @@ The API recognizes the following properties under the top-level `api` key in you
6868
|`targets.layers_by_source` <br> `targets.source_aliases` <br> `targets.layer_aliases`|no | |custom values for which `sources` and `layers` the API accepts (See more info in the [Custom sources and layers](#custom-sources-and-layers) section below). We recommend using the `targets.auto_discover:true` configuration instead of setting these manually.
6969
|`customBoosts` | no | `{}` | Allows configuring boosts for specific sources and layers, in order to influence result order. See [Configurable Boosts](#custom-boosts) below for details |
7070
|`autocomplete.exclude_address_length` | no | 0 | As a performance optimization, this optional filter excludes results from the 'address' layer for any queries where the character length of the 'subject' portion of the parsed_text is equal to or less than this many characters in length. Addresses are usually the bulk of the records in Elasticsearch, and searching across all of them for very short text inputs can be slow, with little benefit. Consider setting this to 1 or 2 if you have several million addresses in Pelias. |
71-
|`indexName`|*no*|*pelias*|name of the Elasticsearch index to be used when building queries|
7271
|`attributionURL`|no| (autodetected)|The full URL to use for the attribution link returned in all Pelias responses. Pelias will attempt to autodetect this host, but it will often be incorrect if, for example, there is a proxy between Pelias and its users. This parameter allows setting a specific URL to avoid any such issues|
7372
|`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.|
7473
|`relativeScores`|*no*|true|if set to true, confidence scores will be normalized, realistically at this point setting this to false is not tested or desirable
@@ -77,6 +76,12 @@ The API recognizes the following properties under the top-level `api` key in you
7776
|`maxSize`|*no*|40| Allows configuring the maximum number of results a query can request.
7877
|`defaultSize`|*no*|10| Allows configuring the number of results a query will request when a size wasn't specified. Must be greater than or equal to `minSize` and smaller than or equal to `maxSize`.
7978

79+
The API recognizes the following properties under the top-level `schema` key in your `pelias.json` config file:
80+
81+
|parameter|required|default|description|
82+
|---|---|---|---|
83+
|`indexName`|*no*|*pelias*|name of the Elasticsearch index to be used when building queries|
84+
8085
A good starting configuration file includes this section (fill in the service and Elasticsearch hosts as needed):
8186

8287
```

0 commit comments

Comments
 (0)