meilisearch / meilisearch/mini-dashboard

Make it possible to share link with only the Search API Key

Open
#491 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
286
Forks
62
PR merge metrics
No merged PRs in 30d

Description

Sharing a link to a mini-dashboard webpage with other users would be great without leaking the primary API Key. The main reason why we need the primary API Key is because the dashboard requests the list of available indexes.

However, by sharing the index name in the URL with a query parameter alongside the Search API Key (or even a tenant token), the dashboard no longer needs to list the indexes by only showing the index name and avoiding displaying the number of documents.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the mini-dashboard flow that lists available indexes and reads the dashboard URL. Trace how the index name and API key are obtained, then define the shared-link path around those inputs. Done means a link using only a Search API Key or tenant token opens the specified index without listing indexes, showing the document count, or requiring the primary API Key.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend, security
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.