summaryrefslogtreecommitdiff
path: root/internal/api/client/lists
diff options
context:
space:
mode:
authorLibravatar Vyr Cossont <vyr@noreply.codeberg.org>2025-11-11 19:39:09 +0100
committerLibravatar tobi <tobi.smethurst@protonmail.com>2025-11-17 14:15:04 +0100
commit0c7b069c4a09f01a3a6c59bd7b66f096f8dcec40 (patch)
treee5306d5ebad1e5a6efe5393bfafde95f5b94b237 /internal/api/client/lists
parent[performance] remove hard reliance on .Cached field to indicate whether media... (diff)
downloadgotosocial-0c7b069c4a09f01a3a6c59bd7b66f096f8dcec40.tar.xz
[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>
Diffstat (limited to 'internal/api/client/lists')
-rw-r--r--internal/api/client/lists/listaccounts.go10
-rw-r--r--internal/api/client/lists/listaccountsadd.go10
-rw-r--r--internal/api/client/lists/listaccountsremove.go10
-rw-r--r--internal/api/client/lists/listcreate.go12
-rw-r--r--internal/api/client/lists/listdelete.go10
-rw-r--r--internal/api/client/lists/listget.go10
-rw-r--r--internal/api/client/lists/listsget.go10
-rw-r--r--internal/api/client/lists/listupdate.go12
8 files changed, 84 insertions, 0 deletions
diff --git a/internal/api/client/lists/listaccounts.go b/internal/api/client/lists/listaccounts.go
index ac3f21ef5..b58486f10 100644
--- a/internal/api/client/lists/listaccounts.go
+++ b/internal/api/client/lists/listaccounts.go
@@ -106,14 +106,24 @@ import (
// items:
// "$ref": "#/definitions/account"
// '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) ListAccountsGETHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listaccountsadd.go b/internal/api/client/lists/listaccountsadd.go
index b89b9100b..7eb7c1e8e 100644
--- a/internal/api/client/lists/listaccountsadd.go
+++ b/internal/api/client/lists/listaccountsadd.go
@@ -71,14 +71,24 @@ import (
// '200':
// description: list accounts updated
// '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) ListAccountsPOSTHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listaccountsremove.go b/internal/api/client/lists/listaccountsremove.go
index fc4cb0344..a70733809 100644
--- a/internal/api/client/lists/listaccountsremove.go
+++ b/internal/api/client/lists/listaccountsremove.go
@@ -71,14 +71,24 @@ import (
// '200':
// description: list accounts updated
// '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) ListAccountsDELETEHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listcreate.go b/internal/api/client/lists/listcreate.go
index 75ad48b0c..19a6ffc42 100644
--- a/internal/api/client/lists/listcreate.go
+++ b/internal/api/client/lists/listcreate.go
@@ -84,16 +84,28 @@ import (
// schema:
// "$ref": "#/definitions/list"
// '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) ListCreatePOSTHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listdelete.go b/internal/api/client/lists/listdelete.go
index 7e5b58b58..1cd7f5c4f 100644
--- a/internal/api/client/lists/listdelete.go
+++ b/internal/api/client/lists/listdelete.go
@@ -53,14 +53,24 @@ import (
// '200':
// description: list deleted
// '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) ListDELETEHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listget.go b/internal/api/client/lists/listget.go
index e8e2759a8..3a1a5d351 100644
--- a/internal/api/client/lists/listget.go
+++ b/internal/api/client/lists/listget.go
@@ -56,14 +56,24 @@ import (
// schema:
// "$ref": "#/definitions/list"
// '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) ListGETHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listsget.go b/internal/api/client/lists/listsget.go
index 8d912241b..7790953c8 100644
--- a/internal/api/client/lists/listsget.go
+++ b/internal/api/client/lists/listsget.go
@@ -49,14 +49,24 @@ import (
// items:
// "$ref": "#/definitions/list"
// '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) ListsGETHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,
diff --git a/internal/api/client/lists/listupdate.go b/internal/api/client/lists/listupdate.go
index e4258b013..5ac26cf60 100644
--- a/internal/api/client/lists/listupdate.go
+++ b/internal/api/client/lists/listupdate.go
@@ -90,16 +90,28 @@ import (
// schema:
// "$ref": "#/definitions/list"
// '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) ListUpdatePUTHandler(c *gin.Context) {
authed, errWithCode := apiutil.TokenAuth(c,