diff options
| author |  Vyr Cossont <VyrCossont@users.noreply.github.com> | 2024-05-31 03:57:42 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2024-05-31 12:57:42 +0200 |
| commit | 04bcde08a1b9994ceb384749c2fe095d6d9eee8c (patch) | |
| tree | e18afb15643e9ffa5732c3902b4257b8361578bd /docs/api | |
| parent | [feature] Implement Filter API v2 (#2936) (diff) | |
| download | gotosocial-04bcde08a1b9994ceb384749c2fe095d6d9eee8c.tar.xz | |
[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
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.yaml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index a83ea643a..78725f325 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -2872,6 +2872,9 @@ paths: - `https://example.org/some/arbitrary/url` -- search for an account OR a status with the given URL. 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 string -- search for accounts or statuses containing the given string. Can return multiple results. + + Arbitrary string queries may include the following operators: + - `from:localuser`, `from:remoteuser@instance.tld`: restrict results to statuses created by the specified account. in: query name: q required: true @@ -2902,6 +2905,10 @@ paths: in: query name: exclude_unreviewed type: boolean + - description: Restrict results to statuses created by the specified account. + in: query + name: account_id + type: string produces: - application/json responses: |