From 0c7b069c4a09f01a3a6c59bd7b66f096f8dcec40 Mon Sep 17 00:00:00 2001 From: Vyr Cossont Date: Tue, 11 Nov 2025 19:39:09 +0100 Subject: [chore] Apply schema for OpenAPI errors (#4511) Adds an error struct to Swagger covering normal and OAuth errors for client API endpoints. Now clients using Swagger codegen can handle errors. Specifically, if you _don't_ have typed errors in your Swagger IDL and you're using `go-swagger` to generate your API client, the error message is discarded and you are only told the status code. With this change in place, clients like `slurp` can tell the user that they tried to upload an emoji that was too big or whatever. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4511 Reviewed-by: tobi Co-authored-by: Vyr Cossont Co-committed-by: Vyr Cossont --- internal/api/client/notifications/notificationget.go | 10 ++++++++++ internal/api/client/notifications/notificationsclear.go | 10 ++++++++++ internal/api/client/notifications/notificationsget.go | 10 ++++++++++ 3 files changed, 30 insertions(+) (limited to 'internal/api/client/notifications') diff --git a/internal/api/client/notifications/notificationget.go b/internal/api/client/notifications/notificationget.go index e9265d1bc..16551b548 100644 --- a/internal/api/client/notifications/notificationget.go +++ b/internal/api/client/notifications/notificationget.go @@ -56,14 +56,24 @@ import ( // schema: // "$ref": "#/definitions/notification" // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '404': +// schema: +// "$ref": "#/definitions/error" // description: not found // '406': +// schema: +// "$ref": "#/definitions/error" // description: not acceptable // '500': +// schema: +// "$ref": "#/definitions/error" // description: internal server error func (m *Module) NotificationGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/notifications/notificationsclear.go b/internal/api/client/notifications/notificationsclear.go index 58c2c7f70..cff253736 100644 --- a/internal/api/client/notifications/notificationsclear.go +++ b/internal/api/client/notifications/notificationsclear.go @@ -47,14 +47,24 @@ import ( // schema: // type: object // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '404': +// schema: +// "$ref": "#/definitions/error" // description: not found // '406': +// schema: +// "$ref": "#/definitions/error" // description: not acceptable // '500': +// schema: +// "$ref": "#/definitions/error" // description: internal server error func (m *Module) NotificationsClearPOSTHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/notifications/notificationsget.go b/internal/api/client/notifications/notificationsget.go index 5550ed082..14ef2726f 100644 --- a/internal/api/client/notifications/notificationsget.go +++ b/internal/api/client/notifications/notificationsget.go @@ -132,14 +132,24 @@ import ( // items: // "$ref": "#/definitions/notification" // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '404': +// schema: +// "$ref": "#/definitions/error" // description: not found // '406': +// schema: +// "$ref": "#/definitions/error" // description: not acceptable // '500': +// schema: +// "$ref": "#/definitions/error" // description: internal server error func (m *Module) NotificationsGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, -- cgit v1.2.3