diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger.yaml | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 465beb42b..dda090c52 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -3774,11 +3774,13 @@ paths: /api/v1/admin/accounts: get: description: |- + Returned accounts will be ordered alphabetically (a-z) by domain + username. + The next and previous queries can be parsed from the returned Link header. Example: ``` - <https://example.org/api/v1/admin/accounts?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/admin/accounts?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + <https://example.org/api/v1/admin/accounts?limit=80&max_id=example.org%2F%40someone>; rel="next", <https://example.org/api/v1/admin/accounts?limit=80&min_id=example.org%2F%40someone_else>; rel="prev" ```` operationId: adminAccountsGetV1 parameters: @@ -3847,19 +3849,15 @@ paths: in: query name: staff type: boolean - - description: All results returned will be older than the item with this ID. + - description: max_id in the form `[domain]/@[username]`. All results returned will be later in the alphabet than `[domain]/@[username]`. For example, if max_id = `example.org/@someone` then returned entries might contain `example.org/@someone_else`, `later.example.org/@someone`, etc. Local account IDs in this form use an empty string for the `[domain]` part, for example local account with username `someone` would be `/@someone`. in: query name: max_id type: string - - description: All results returned will be newer than the item with this ID. - in: query - name: since_id - type: string - - description: Returns results immediately newer than the item with this ID. + - description: min_id in the form `[domain]/@[username]`. All results returned will be earlier in the alphabet than `[domain]/@[username]`. For example, if min_id = `example.org/@someone` then returned entries might contain `example.org/@earlier_account`, `earlier.example.org/@someone`, etc. Local account IDs in this form use an empty string for the `[domain]` part, for example local account with username `someone` would be `/@someone`. in: query name: min_id type: string - - default: 100 + - default: 50 description: Maximum number of results to return. in: query maximum: 200 @@ -8463,11 +8461,13 @@ paths: /api/v2/admin/accounts: get: description: |- + Returned accounts will be ordered alphabetically (a-z) by domain + username. + The next and previous queries can be parsed from the returned Link header. Example: ``` - <https://example.org/api/v2/admin/accounts?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v2/admin/accounts?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + <https://example.org/api/v2/admin/accounts?limit=80&max_id=example.org%2F%40someone>; rel="next", <https://example.org/api/v2/admin/accounts?limit=80&min_id=example.org%2F%40someone_else>; rel="prev" ```` operationId: adminAccountsGetV2 parameters: @@ -8513,19 +8513,15 @@ paths: in: query name: ip type: string - - description: All results returned will be older than the item with this ID. + - description: max_id in the form `[domain]/@[username]`. All results returned will be later in the alphabet than `[domain]/@[username]`. For example, if max_id = `example.org/@someone` then returned entries might contain `example.org/@someone_else`, `later.example.org/@someone`, etc. Local account IDs in this form use an empty string for the `[domain]` part, for example local account with username `someone` would be `/@someone`. in: query name: max_id type: string - - description: All results returned will be newer than the item with this ID. - in: query - name: since_id - type: string - - description: Returns results immediately newer than the item with this ID. + - description: min_id in the form `[domain]/@[username]`. All results returned will be earlier in the alphabet than `[domain]/@[username]`. For example, if min_id = `example.org/@someone` then returned entries might contain `example.org/@earlier_account`, `earlier.example.org/@someone`, etc. Local account IDs in this form use an empty string for the `[domain]` part, for example local account with username `someone` would be `/@someone`. in: query name: min_id type: string - - default: 100 + - default: 50 description: Maximum number of results to return. in: query maximum: 200 |