search

algolia / firestore-algolia-search

Apache License 2.0
112 stars 35 forks source link

Algolia API Key Description #85

Closed jelizarovas closed 2 years ago

jelizarovas commented 2 years ago

In the API key description, for first time users who just want to set up as quickly as possible, when I was asked for API key, I have two options in algolia api keys - Search-Only API key or Admin API key. In the description it says Do not use the admin API key, so naturally revert to the other available API key which is Search Only. Since it says "We recommend creating new key", - I assume it's best practice, but to play around my "Search-Only" key should work just fine. Wrong. I set up the index, and cannot get records no matter what i do. Until i go to "Search API Logs" and see all of my POST requests in the 400 code. So now i see that if i do not create a new api key it will never work.

Suggestion change the wording to the likes of:

Algolia API Key Description We require API key with “addObject”, “deleteObject”, “listIndexes”, “deleteIndex”, “editSettings”, and “settings” permissions. Do not use the Admin API key or Search Only API Key.

image

image

image

Haroenv commented 2 years ago

Not fully sure whether that explicitly needs to be said, as just before it mentions to have addObject etc. as permissions.

The description is declared here

https://github.com/algolia/firestore-algolia-search/blob/e9e75ca21bad782e1f4d601dfb4a559aeccf5182/extension.yaml#L112

smomin commented 2 years ago

I don't think we need to explicit say this considering we are putting all the rights needed on the permission. However, if we get more issues like this, we can add it.