zelo72
/
documentation
mirror of https://github.com/mastodon/documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Provide more detail about the use of `resolve` in search queries (#1488) 

Provide more detail about the use of `resolve` in search queries
This commit is contained in:
Nik Clayton 2024-07-23 13:07:05 +02:00 committed by GitHub
parent 8efb133f16
commit 61481fb191
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/en/methods/search.md
View File

@ -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" >}}
{{< 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" >}}