Merge #424

424: Remove api key from mandatory config r=bidoubiwa a=bidoubiwa



Co-authored-by: Charlotte Vermandel <[email protected]>
Co-authored-by: cvermand <[email protected]>

Author: bors[bot]

README.md

@@ -91,7 +91,7 @@ If you already have your own scraper but you still want to use MeiliSearch and `
 </html>
 ```
 
-The `hostUrl` and the `apiKey` fields are the credentials of your MeiliSearch instance.<br>
+The `hostUrl` and the `apiKey` (_optional_) fields are the credentials of your MeiliSearch instance.<br>
 `indexUid` is the index identifier in your MeiliSearch instance in which your website content is stored.<br>
 `inputSelector` is the `id` attribute of the HTML search input tag.
 

src/lib/DocsSearchBar.js

@@ -180,7 +180,7 @@ class DocsSearchBar {
    * @returns {void}
    */
   static checkArguments(args) {
-    if (!args.apiKey || !args.indexUid || !args.hostUrl) {
+    if (!args.inputSelector || !args.indexUid || !args.hostUrl) {
       throw new Error(usage)
     }
 
@@ -302,7 +302,6 @@ class DocsSearchBar {
       groupedHits[level] = flattenedHits
     })
     groupedHits = utils.flattenAndFlagFirst(groupedHits, 'isCategoryHeader')
-
     // Translate hits into smaller objects to be send to the template
     return groupedHits.map((hit) => {
       const url = DocsSearchBar.formatURL(hit)

src/lib/__tests__/DocsSearchBar-test.js

@@ -245,14 +245,15 @@ describe('DocsSearchBar', () => {
       const options = {
         apiKey: 'apiKey',
         indexUid: 'indexUID',
+        inputSelector: '#',
       }
 
       // When
       expect(() => {
         checkArguments(options)
       }).toThrow(/^Usage:/)
     })
-    it('should throw an error if no apiKey defined', () => {
+    it('should throw an error if no inputSelector defined', () => {
       // Given
       const options = {
         hostUrl: 'test.com',
@@ -268,7 +269,7 @@ describe('DocsSearchBar', () => {
       // Given
       const options = {
         hostUrl: 'test.com',
-        apiKey: 'apiKey',
+        inputSelector: '#',
       }
 
       // When
@@ -282,6 +283,7 @@ describe('DocsSearchBar', () => {
         hostUrl: 'test.com',
         apiKey: 'apiKey',
         indexUid: 'indexUID',
+        inputSelector: '#',
       }
       sinon.stub(DocsSearchBar, 'getInputFromSelector').returns(false)