From 61481fb191b8b075b1bd23f85100777cf7c30606 Mon Sep 17 00:00:00 2001 From: Nik Clayton Date: Tue, 23 Jul 2024 13:07:05 +0200 Subject: [PATCH] Provide more detail about the use of `resolve` in search queries (#1488) Provide more detail about the use of `resolve` in search queries --- content/en/methods/search.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/methods/search.md b/content/en/methods/search.md index 81ecac72..caaa833a 100644 --- a/content/en/methods/search.md +++ b/content/en/methods/search.md @@ -48,7 +48,7 @@ type : String. Specify whether to search for only `accounts`, `hashtags`, `statuses` resolve -: Boolean. Attempt WebFinger lookup? Defaults to false. +: Boolean. Only relevant if `type` includes `accounts`. If `true` and (a) the search query is for a remote account (e.g., `someaccount@someother.server`) and (b) the local server does not know about the account, [WebFinger](/spec/webfinger) is used to try and resolve the account at `someother.server`. This provides the best recall at higher latency. If `false` only accounts the server knows about are returned. following : Boolean. Only include accounts that the user is following? Defaults to false. @@ -231,4 +231,4 @@ Invalid or missing Authorization header. {{< page-relref ref="methods/accounts#lookup" caption="GET /api/v1/accounts/lookup" >}} -{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v2/search_controller.rb" caption="app/controllers/api/v2/search_controller.rb" >}} \ No newline at end of file +{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v2/search_controller.rb" caption="app/controllers/api/v2/search_controller.rb" >}}