From 0c7b069c4a09f01a3a6c59bd7b66f096f8dcec40 Mon Sep 17 00:00:00 2001
From: Vyr Cossont <vyr@noreply.codeberg.org>
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 <kipvandenbos@noreply.codeberg.org>
Co-authored-by: Vyr Cossont <vyr@noreply.codeberg.org>
Co-committed-by: Vyr Cossont <vyr@noreply.codeberg.org>
---
 internal/api/client/push/pushsubscriptiondelete.go |  6 ++++++
 internal/api/client/push/pushsubscriptionget.go    |  8 ++++++++
 internal/api/client/push/pushsubscriptionpost.go   | 12 ++++++++++++
 internal/api/client/push/pushsubscriptionput.go    | 12 ++++++++++++
 4 files changed, 38 insertions(+)

(limited to 'internal/api/client/push')

diff --git a/internal/api/client/push/pushsubscriptiondelete.go b/internal/api/client/push/pushsubscriptiondelete.go
index 8cafa3e39..3f959842d 100644
--- a/internal/api/client/push/pushsubscriptiondelete.go
+++ b/internal/api/client/push/pushsubscriptiondelete.go
@@ -41,10 +41,16 @@ import (
 //		'200':
 //			description: Push subscription deleted, or did not exist.
 //		'400':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: bad request
 //		'401':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: unauthorized
 //		'500':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: internal server error
 func (m *Module) PushSubscriptionDELETEHandler(c *gin.Context) {
 	authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/push/pushsubscriptionget.go b/internal/api/client/push/pushsubscriptionget.go
index 2a3e69e3d..1150144de 100644
--- a/internal/api/client/push/pushsubscriptionget.go
+++ b/internal/api/client/push/pushsubscriptionget.go
@@ -45,12 +45,20 @@ import (
 //			schema:
 //				"$ref": "#/definitions/webPushSubscription"
 //		'400':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: bad request
 //		'401':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: unauthorized
 //		'404':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: This access token doesn't have an associated subscription.
 //		'500':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: internal server error
 func (m *Module) PushSubscriptionGETHandler(c *gin.Context) {
 	authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/push/pushsubscriptionpost.go b/internal/api/client/push/pushsubscriptionpost.go
index 1929ae714..83ef3ee41 100644
--- a/internal/api/client/push/pushsubscriptionpost.go
+++ b/internal/api/client/push/pushsubscriptionpost.go
@@ -168,16 +168,28 @@ import (
 //			schema:
 //				"$ref": "#/definitions/webPushSubscription"
 //		'400':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: bad request
 //		'401':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: unauthorized
 //		'403':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: forbidden
 //		'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) PushSubscriptionPOSTHandler(c *gin.Context) {
 	authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/push/pushsubscriptionput.go b/internal/api/client/push/pushsubscriptionput.go
index 1a2b51cb7..7100199d5 100644
--- a/internal/api/client/push/pushsubscriptionput.go
+++ b/internal/api/client/push/pushsubscriptionput.go
@@ -144,16 +144,28 @@ import (
 //			schema:
 //				"$ref": "#/definitions/webPushSubscription"
 //		'400':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: bad request
 //		'401':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: unauthorized
 //		'403':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: forbidden
 //		'404':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: This access token doesn't have an associated subscription.
 //		'406':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: not acceptable
 //		'500':
+//			schema:
+//				"$ref": "#/definitions/error"
 //			description: internal server error
 func (m *Module) PushSubscriptionPUTHandler(c *gin.Context) {
 	authed, errWithCode := apiutil.TokenAuth(c,
-- 
cgit v1.2.3