diff options
Diffstat (limited to 'internal/api/client/favourites/favouritesget.go')
| -rw-r--r-- | internal/api/client/favourites/favouritesget.go | 65 |
1 files changed, 64 insertions, 1 deletions
diff --git a/internal/api/client/favourites/favouritesget.go b/internal/api/client/favourites/favouritesget.go index 31fd47c90..8ba20215d 100644 --- a/internal/api/client/favourites/favouritesget.go +++ b/internal/api/client/favourites/favouritesget.go @@ -11,7 +11,70 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// FavouritesGETHandler handles GETting favourites. +// FavouritesGETHandler swagger:operation GET /api/v1/favourites favouritesGet +// +// Get an array of statuses that the requesting account has favourited. +// +// The next and previous queries can be parsed from the returned Link header. +// Example: +// +// ``` +// <https://example.org/api/v1/favourites?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/favourites?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" +// ```` +// +// --- +// tags: +// - favourites +// +// produces: +// - application/json +// +// parameters: +// - +// name: limit +// type: integer +// description: Number of statuses to return. +// default: 20 +// in: query +// - +// name: max_id +// type: string +// description: >- +// Return only favourited statuses *OLDER* than the given favourite ID. +// The status with the corresponding fave ID will not be included in the response. +// in: query +// - +// name: min_id +// type: string +// description: >- +// Return only favourited statuses *NEWER* than the given favourite ID. +// The status with the corresponding fave ID will not be included in the response. +// in: query +// +// security: +// - OAuth2 Bearer: +// - read:favourites +// +// responses: +// '200': +// headers: +// Link: +// type: string +// description: Links to the next and previous queries. +// schema: +// type: array +// items: +// "$ref": "#/definitions/status" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) FavouritesGETHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { |