diff options
Diffstat (limited to 'internal/api/client/followrequest/get.go')
| -rw-r--r-- | internal/api/client/followrequest/get.go | 53 |
1 files changed, 50 insertions, 3 deletions
diff --git a/internal/api/client/followrequest/get.go b/internal/api/client/followrequest/get.go index a07e3ad83..de8c83d9a 100644 --- a/internal/api/client/followrequest/get.go +++ b/internal/api/client/followrequest/get.go @@ -26,13 +26,60 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// FollowRequestGETHandler allows clients to get a list of their incoming follow requests. +// FollowRequestGETHandler swagger:operation GET /api/v1/follow_requests getFollowRequests +// +// Get an array of accounts that have requested to follow you. +// +// 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" +// ```` +// +// --- +// tags: +// - follow_requests +// +// produces: +// - application/json +// +// parameters: +// - name: limit +// type: integer +// description: Number of accounts to return. +// default: 40 +// in: query +// +// security: +// - OAuth2 Bearer: +// - read:follows +// +// responses: +// '200': +// headers: +// Link: +// type: string +// description: Links to the next and previous queries. +// schema: +// type: array +// items: +// "$ref": "#/definitions/account" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '403': +// description: forbidden +// '404': +// description: not found func (m *Module) FollowRequestGETHandler(c *gin.Context) { - l := logrus.WithField("func", "statusCreatePOSTHandler") + l := logrus.WithField("func", "FollowRequestGETHandler") + authed, err := oauth.Authed(c, true, true, true, true) if err != nil { l.Debugf("couldn't auth: %s", err) - c.JSON(http.StatusForbidden, gin.H{"error": err.Error()}) + c.JSON(http.StatusUnauthorized, gin.H{"error": err.Error()}) return } |