You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| hostIdentifier | No | Your **Host Identifier**, should start with `host-`. Required unless explicitly setting `endpointBase`|
111
-
| searchKey |Yes| Your **Public Search Key**. It should start with `search-`.|
112
-
| engineName | Yes ||
113
-
| endpointBase | No | Overrides the base of the App Search API endpoint completely. Useful when proxying the App Search API, developing against a local server, or a Self-Managed or Cloud Deployment. Ex. "http://localhost:3002"|
114
-
| cacheResponses | No | Whether or not API responses should be cached. Default: `true`. |
115
-
| additionalHeaders | No | An Object with keys and values that will be converted to header names and values on all API requests |
| hostIdentifier | No | Your **Host Identifier**, should start with `host-`. Required unless explicitly setting `endpointBase`|
111
+
| searchKey |No| Your **Public Search Key**. It should start with `search-`.<br/><br/>NOTE: This is not _technically_ required, but in 99% of cases it should be provided. There is a small edge case for not providing this, mainly useful for internal App Search usage, where this can be ommited in order to leverage App Search's session based authentication.|
112
+
| engineName | Yes ||
113
+
| endpointBase | No | Overrides the base of the App Search API endpoint completely. Useful when proxying the App Search API, developing against a local server, or a Self-Managed or Cloud Deployment. Ex. "http://localhost:3002"|
114
+
| cacheResponses | No | Whether or not API responses should be cached. Default: `true`. |
115
+
| additionalHeaders | No | An Object with keys and values that will be converted to header names and values on all API requests |
0 commit comments