diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger.yaml | 96 |
1 files changed, 87 insertions, 9 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index d9bf40b06..e522cdb2a 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -3072,6 +3072,13 @@ paths: - accounts /api/v1/accounts/{id}/followers: get: + description: |- + The next and previous queries can be parsed from the returned Link header. + Example: + + ``` + <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/followers?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/followers?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + ```` operationId: accountFollowers parameters: - description: Account ID. @@ -3079,6 +3086,25 @@ paths: name: id required: true type: string + - description: 'Return only follower accounts *OLDER* than the given max ID. The follower account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: max_id + type: string + - description: 'Return only follower accounts *NEWER* than the given since ID. The follower account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: since_id + type: string + - description: 'Return only follower accounts *IMMEDIATELY NEWER* than the given min ID. The follower account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: min_id + type: string + - default: 40 + description: Number of follower accounts to return. + in: query + maximum: 80 + minimum: 1 + name: limit + type: integer produces: - application/json responses: @@ -3106,6 +3132,13 @@ paths: - accounts /api/v1/accounts/{id}/following: get: + description: |- + The next and previous queries can be parsed from the returned Link header. + Example: + + ``` + <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/following?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/accounts/0657WMDEC3KQDTD6NZ4XJZBK4M/following?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + ```` operationId: accountFollowing parameters: - description: Account ID. @@ -3113,6 +3146,25 @@ paths: name: id required: true type: string + - description: 'Return only following accounts *OLDER* than the given max ID. The following account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: max_id + type: string + - description: 'Return only following accounts *NEWER* than the given since ID. The following account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: since_id + type: string + - description: 'Return only following accounts *IMMEDIATELY NEWER* than the given min ID. The following account with the specified ID will not be included in the response. NOTE: the ID is of the internal follow, NOT any of the returned accounts.' + in: query + name: min_id + type: string + - default: 40 + description: Number of following accounts to return. + in: query + maximum: 80 + minimum: 1 + name: limit + type: integer produces: - application/json responses: @@ -4679,19 +4731,25 @@ paths: ```` operationId: blocksGet parameters: - - default: 20 - description: Number of blocks to return. - in: query - name: limit - type: integer - - description: Return only blocks *OLDER* than the given block ID. The block with the specified ID will not be included in the response. + - description: 'Return only blocked accounts *OLDER* than the given max ID. The blocked account with the specified ID will not be included in the response. NOTE: the ID is of the internal block, NOT any of the returned accounts.' in: query name: max_id type: string - - description: Return only blocks *NEWER* than the given block ID. The block with the specified ID will not be included in the response. + - description: 'Return only blocked accounts *NEWER* than the given since ID. The blocked account with the specified ID will not be included in the response. NOTE: the ID is of the internal block, NOT any of the returned accounts.' in: query name: since_id type: string + - description: 'Return only blocked accounts *IMMEDIATELY NEWER* than the given min ID. The blocked account with the specified ID will not be included in the response. NOTE: the ID is of the internal block, NOT any of the returned accounts.' + in: query + name: min_id + type: string + - default: 40 + description: Number of blocked accounts to return. + in: query + maximum: 80 + minimum: 1 + name: limit + type: integer produces: - application/json responses: @@ -4857,12 +4915,32 @@ paths: - featured_tags /api/v1/follow_requests: get: - description: Accounts will be sorted in order of follow request date descending (newest first). + description: |- + The next and previous queries can be parsed from the returned Link header. + Example: + + ``` + <https://example.org/api/v1/follow_requests?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/follow_requests?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + ```` operationId: getFollowRequests parameters: + - description: 'Return only follow requesting accounts *OLDER* than the given max ID. The follow requester with the specified ID will not be included in the response. NOTE: the ID is of the internal follow request, NOT any of the returned accounts.' + in: query + name: max_id + type: string + - description: 'Return only follow requesting accounts *NEWER* than the given since ID. The follow requester with the specified ID will not be included in the response. NOTE: the ID is of the internal follow request, NOT any of the returned accounts.' + in: query + name: since_id + type: string + - description: 'Return only follow requesting accounts *IMMEDIATELY NEWER* than the given min ID. The follow requester with the specified ID will not be included in the response. NOTE: the ID is of the internal follow request, NOT any of the returned accounts.' + in: query + name: min_id + type: string - default: 40 - description: Number of accounts to return. + description: Number of follow requesting accounts to return. in: query + maximum: 80 + minimum: 1 name: limit type: integer produces: |