Skip to content

Commit 244c387

Browse files
committed
Update config option documentation
1 parent 07dc49b commit 244c387

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@ The following is a complete list of options available for configuration in [engi
6565

6666
| option | value type | required/optional | source |
6767
| -------------------- | ------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
68-
| `engineName` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
69-
| `endpointBase` | String | optional | Use this instead of "hostIdentifier" if you are using self managed. ex: "http://127.0.0.1:3002" |
70-
| `hostIdentifier` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
71-
| `searchKey` | String | required | Found in your [App Search Dashboard](http://app.swiftype.com/as). |
68+
| `engineName` | String | required | Found in your App Search Dashboard. |
69+
| `endpointBase` | String | required* | (*) Elastic Enterprise Search deployment URL, example: "http://127.0.0.1:3002". Not required if using App Search on swiftype.com. |
70+
| `hostIdentifier` | String | required* | (*) Only required if using App Search on swiftype.com. |
71+
| `searchKey` | String | required | Found in your App Search Dashboard. |
7272
| `searchFields` | Array[String] | required | A list of fields that will be searched with your search term. |
7373
| `resultFields` | Array[String] | required | A list of fields that will be displayed within your results. |
7474
| `querySuggestFields` | Array[String] | optional | A list of fields that will be searched and displayed as query suggestions. |

0 commit comments

Comments
 (0)