meilisearch / mini-dashboard

mini-dashboard for Meilisearch

Home Page:https://edge-preview-meili.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Change the naming of `Private Key`

bidoubiwa opened this issue · comments

Since v0.25.0 the term private key is not used anywhere.
See gatsby section on API keys.

Another naming, or another formulation, should be used to tell user which key to use here:

Screenshot 2022-02-10 at 11 35 33

Any suggestion @gmourier

I think we can propose to add the master key or the default admin api key because this modal is asked after a user has specified a master key and can now access to the /keys endpoint to find it (as before).

In the help text at the bottom it should say something like this: "At least one API key that allows indexes.get, search and version actions".

The advantage of the API Keys feature is that the user can share the dashboard with an API key dedicated to what needs to be consulted by a user or group of users and not give access to everything by default. Should we explain that too?


At first, we can be straightforward and ask for the Default Admin API Key which simply replaces private. Maybe there should be an explanation on how to find this key, it was not explained before. By adding the actions link in the help text, it redirects to the API Key reference documentation page that explains how to get keys.