diff options
Diffstat (limited to 'internal/api/client/blocks/blocksget.go')
-rw-r--r-- | internal/api/client/blocks/blocksget.go | 58 |
1 files changed, 57 insertions, 1 deletions
diff --git a/internal/api/client/blocks/blocksget.go b/internal/api/client/blocks/blocksget.go index bf5f41e40..65c11ea1a 100644 --- a/internal/api/client/blocks/blocksget.go +++ b/internal/api/client/blocks/blocksget.go @@ -26,7 +26,63 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/oauth" ) -// BlocksGETHandler handles GETting blocks. +// BlocksGETHandler swagger:operation GET /api/v1/blocks blocksGet +// +// Get an array of accounts that requesting account has blocked. +// +// The next and previous queries can be parsed from the returned Link header. +// Example: +// +// ``` +// <https://example.org/api/v1/blocks?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/blocks?limit=80&min_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" +// ```` +// +// --- +// tags: +// - blocks +// +// produces: +// - application/json +// +// parameters: +// - name: limit +// type: integer +// description: Number of blocks to return. +// default: 20 +// in: query +// - name: max_id +// type: string +// description: |- +// Return only blocks *OLDER* than the given max block ID. +// The block with the specified ID will not be included in the response. +// in: query +// - name: since_id +// type: string +// description: |- +// Return only blocks *NEWER* than the given since block ID. +// The block with the specified ID will not be included in the response. +// in: query +// +// security: +// - OAuth2 Bearer: +// - read:blocks +// +// responses: +// '200': +// headers: +// Link: +// type: string +// description: Links to the next and previous queries. +// schema: +// type: array +// items: +// "$ref": "#/definitions/account" +// '401': +// description: unauthorized +// '400': +// description: bad request +// '404': +// description: not found func (m *Module) BlocksGETHandler(c *gin.Context) { l := m.log.WithField("func", "PublicTimelineGETHandler") |