From 04bcde08a1b9994ceb384749c2fe095d6d9eee8c Mon Sep 17 00:00:00 2001 From: Vyr Cossont Date: Fri, 31 May 2024 03:57:42 -0700 Subject: [feature] Add from: search operator and account_id query param (#2943) * Add from: search operator * Fix whitespace in Swagger YAML comment * Move query parsing into its own method * Document search * Clarify post search scope --- docs/user_guide/search.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 docs/user_guide/search.md (limited to 'docs/user_guide') diff --git a/docs/user_guide/search.md b/docs/user_guide/search.md new file mode 100644 index 000000000..a6bf2cbea --- /dev/null +++ b/docs/user_guide/search.md @@ -0,0 +1,20 @@ +# Search + +## Query formats + +GotoSocial accepts several kinds of search query: + +- `@username`: search for an account with the given username on any domain. Can return multiple results. +- `@username@domain`: search for a remote account with exact username and domain. Will only ever return 1 result at most. +- `https://example.org/some/arbitrary/url`: search for an account or post with the given URL. If the account or post hasn't already federated to GotoSocial, it will try to retrieve it. Will only ever return 1 result at most. +- `#hashtag_name`: search for a hashtag with the given hashtag name, or starting with the given hashtag name. Case insensitive. Can return multiple results. +- `any arbitrary text`: search for posts containing the text, hashtags containing the text, and accounts with usernames, display names, or bios containing the text, exactly as written. Both posts you've written as well as posts replying to you will be searched. Account bios will only be searched for accounts that you follow. Can return multiple results. + +## Search operators + +Arbitrary text queries may include the following search operators: + +- `from:username`: restrict results to statuses created by the specified *local* account. +- `from:username@domain`: restrict results to statuses created by the specified remote account. + +For example, you can search for `sloth from:yourusername` to find your own posts about sloths. -- cgit v1.2.3