friendicaproject/friendica-docker
1
0
Fork 0
mirror of https://github.com/friendica/friendica-directory synced 2025-09-02 21:35:02 +02:00
Code Releases Wiki Activity

Add page size parameter to search

Browse source 
- Update API call documentation
This commit is contained in:
Hypolite Petovan 2020-09-27 13:41:28 -04:00
commit 959f526cb4
3 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/Protocol.md
View file

@ -11,14 +11,16 @@ Redirects to the base URL of a random server with open registration policy and a
## Search
```
GET /search[/account_type]?q=...
GET /search[/account_type]?q=...[&page=...][&limit=...]
Accept: application/json
```
Parameters:
URI Parameter:
- `account_type` (optional): An arbitrary account type string. Expected values are `all`, `people`, `news`, `organization` and `forum`. Default is `all`.
Query parameters:
- `q`: The search query.
- `account_type` (optional): An arbitrary account type string. Currently supported are `all`, `people` and `forum`. Default is `all`.
- `page` (optional): The page number, default is 1.
- `limit` (optional): The page size, default is 20, max is 100.
Returns a JSON structure containing a paginated list profiles matching the search query and the optional account type.