API/behavior changes

Describe routes and behavior changes

New experimental feature network

• A new experimental feature called network is added.
• When network is enabled, the following actions are possible:
  1. Passing federationOptions.remote to a query in a POST /multi-search request
  2. Passing federationOptions.queryPosition to a query in a POST /multi-search request
  3. Passing the Meili-Proxy-Search: true in a request to POST /multi-search
  4. Calling GET /network and PATCH /network

⚠️ Security note: remote federated search and redacted attributes

Meilisearch will not display the value of attributes that are not part of displayedAttributes. When sorting on such attributes, Meilisearch will display <hidden> instead of the actual values in the _rankingScoreDetails .

If enabling the network feature, this property is not maintained at all times. To be able to federate the results coming from the remote instance, the remote response contains the attribute values even if the attribute is not part of displayedAttributes.

If you rely on the value of attributes not present in displayedAttributes to remain hidden at all times, please do not enable the network feature for the time being.

New routes GET /network and PATCH /network

The remote object

A remote represents a Meilisearch instance accessible through its URL and search API key.

{
  "url": "<http://ms-1235.example.meilisearch.io>",
  "searchApiKey": "Ecd1SDDi4pqdJD6qYLxD3y7VZAEb4d9j6LJgt4d6xas"
}

• url: Mandatory. URL at which the remote Meilisearch instance is accessible from the Meilisearch instance on which the configuration is sent. The URL does not need to be public: if both Meilisearch instances are on a private network, the URL can be the private URL.
• searchApiKey: Optional; defaults to null. An API key with search permission. If null, the configured instance will not pass an Authorization header when sending search requests to the remote instance.

The network object

{
  "remotes": {
      "ms-00": {
        "url": "<http://ms-1235.example.meilisearch.io>",
        "searchApiKey": "Ecd1SDDi4pqdJD6qYLxD3y7VZAEb4d9j6LJgt4d6xas"
      },
      "ms-01": {
	      "url": "<http://ms-4242.example.meilisearch.io>",
	      "searchApiKey": "hrVu-OMcjPGElK7692K7bwriBoGyHXTMvB5NmZkMKqQ"
	    }
  },
	"self": "ms-00",
}

• remotes : Optional, default to the empty object. An object whose keys are the name of a remote, and values the corresponding remote object.