diff options
| author | 2025-06-02 11:46:17 +0200 | |
|---|---|---|
| committer | 2025-06-02 11:46:17 +0200 | |
| commit | 5097e6d2782600dc29f930dc14bc7fb0746a4fb8 (patch) | |
| tree | 5ea5489cc1910f624ee361e92b883233e5394ef1 /docs/api/swagger.yaml | |
| parent | [bugfix] fix GetAccountFollowRequestingIDs query (#4222) (diff) | |
| download | gotosocial-5097e6d2782600dc29f930dc14bc7fb0746a4fb8.tar.xz | |
[feature] /api/v1/follow_requests/outgoing (#4224)
Signed-off-by: nicole mikołajczyk <git@mkljczk.pl>
# Description
This pull request adds a new endpoint which returns a list of pending follow requests requested by the user. The test is adapted from the GET /api/v1/follow_requests test.
## Checklist
- [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md).
- [ ] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
- [x] I/we have not leveraged AI to create the proposed changes.
- [x] I/we have performed a self-review of added code.
- [x] I/we have written code that is legible and maintainable by others.
- [x] I/we have commented the added code, particularly in hard-to-understand areas.
- [x] I/we have made any necessary changes to documentation.
- [x] I/we have added tests that cover new code.
- [x] I/we have run tests and they pass locally with the changes.
- [x] I/we have run `go fmt ./...` and `golangci-lint run`.
Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4224
Co-authored-by: nicole mikołajczyk <git@mkljczk.pl>
Co-committed-by: nicole mikołajczyk <git@mkljczk.pl>
Diffstat (limited to 'docs/api/swagger.yaml')
| -rw-r--r-- | docs/api/swagger.yaml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 3ed915e05..52d024304 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -8745,6 +8745,65 @@ paths: summary: Reject/deny follow request from the given account ID. tags: - follow_requests + /api/v1/follow_requests/outgoing: + get: + description: |- + The next and previous queries can be parsed from the returned Link header. + Example: + + ``` + <https://example.org/api/v1/follow_requests/outgoing?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/follow_requests/outgoing?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" + ```` + operationId: getOutgoingFollowRequests + parameters: + - description: 'Return only follow requested accounts *OLDER* than the given max ID. The follow requestee 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 requested accounts *NEWER* than the given since ID. The follow requestee 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 requested accounts *IMMEDIATELY NEWER* than the given min ID. The follow requestee 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 follow requested accounts to return. + in: query + maximum: 80 + minimum: 1 + name: limit + type: integer + produces: + - application/json + responses: + "200": + description: "" + headers: + Link: + description: Links to the next and previous queries. + type: string + schema: + items: + $ref: '#/definitions/account' + type: array + "400": + description: bad request + "401": + description: unauthorized + "404": + description: not found + "406": + description: not acceptable + "500": + description: internal server error + security: + - OAuth2 Bearer: + - read:follows + summary: Get an array of accounts that you have requested to follow. + tags: + - follow_requests /api/v1/followed_tags: get: operationId: getFollowedTags |
