diff options
Diffstat (limited to 'internal/api/client/notification/notificationsget.go')
| -rw-r--r-- | internal/api/client/notification/notificationsget.go | 123 |
1 files changed, 69 insertions, 54 deletions
diff --git a/internal/api/client/notification/notificationsget.go b/internal/api/client/notification/notificationsget.go index 88c2f663b..94ea6dbd9 100644 --- a/internal/api/client/notification/notificationsget.go +++ b/internal/api/client/notification/notificationsget.go @@ -35,64 +35,79 @@ import ( // // The notifications will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer). // -// --- -// tags: -// - notifications +// The next and previous queries can be parsed from the returned Link header. +// Example: // -// produces: -// - application/json +// ``` +// <https://example.org/api/v1/notifications?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/notifications?limit=80&since_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" +// ```` // -// parameters: -// - name: limit -// type: integer -// description: Number of notifications to return. -// default: 20 -// in: query -// required: false -// - name: exclude_types -// type: array -// items: -// type: string -// description: Array of types of notifications to exclude (follow, favourite, reblog, mention, poll, follow_request) -// in: query -// required: false -// - name: max_id -// type: string -// description: |- -// Return only notifications *OLDER* than the given max status ID. -// The status with the specified ID will not be included in the response. -// in: query -// required: false -// - name: since_id -// type: string -// description: |- -// Return only notifications *NEWER* than the given since status ID. -// The status with the specified ID will not be included in the response. -// in: query -// required: false +// --- +// tags: +// - notifications // -// security: -// - OAuth2 Bearer: -// - read:notifications +// produces: +// - application/json // -// responses: -// '200': -// name: notifications -// description: Array of notifications. -// schema: -// type: array -// items: -// "$ref": "#/definitions/notification" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error +// parameters: +// - +// name: limit +// type: integer +// description: Number of notifications to return. +// default: 20 +// in: query +// required: false +// - +// name: exclude_types +// type: array +// items: +// type: string +// description: Array of types of notifications to exclude (follow, favourite, reblog, mention, poll, follow_request) +// in: query +// required: false +// - +// name: max_id +// type: string +// description: >- +// Return only notifications *OLDER* than the given max status ID. +// The status with the specified ID will not be included in the response. +// in: query +// required: false +// - +// name: since_id +// type: string +// description: |- +// Return only notifications *NEWER* than the given since status ID. +// The status with the specified ID will not be included in the response. +// in: query +// required: false +// +// security: +// - OAuth2 Bearer: +// - read:notifications +// +// responses: +// '200': +// headers: +// Link: +// type: string +// description: Links to the next and previous queries. +// name: notifications +// description: Array of notifications. +// schema: +// type: array +// items: +// "$ref": "#/definitions/notification" +// '400': +// description: bad request +// '401': +// description: unauthorized +// '404': +// description: not found +// '406': +// description: not acceptable +// '500': +// description: internal server error func (m *Module) NotificationsGETHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { |