diff options
| author |  Vyr Cossont <vyr@noreply.codeberg.org> | 2025-11-11 19:39:09 +0100 |
|---|---|---|
| committer |  tobi <tobi.smethurst@protonmail.com> | 2025-11-17 14:15:04 +0100 |
| commit | 0c7b069c4a09f01a3a6c59bd7b66f096f8dcec40 (patch) | |
| tree | e5306d5ebad1e5a6efe5393bfafde95f5b94b237 /internal/api/client/timelines | |
| parent | [performance] remove hard reliance on .Cached field to indicate whether media... (diff) | |
| download | gotosocial-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/timelines')
| -rw-r--r-- | internal/api/client/timelines/home.go | 4 | ||||
| -rw-r--r-- | internal/api/client/timelines/list.go | 4 | ||||
| -rw-r--r-- | internal/api/client/timelines/public.go | 4 | ||||
| -rw-r--r-- | internal/api/client/timelines/tag.go | 4 |
4 files changed, 16 insertions, 0 deletions
diff --git a/internal/api/client/timelines/home.go b/internal/api/client/timelines/home.go index 9a7276bdd..bfc1c7479 100644 --- a/internal/api/client/timelines/home.go +++ b/internal/api/client/timelines/home.go @@ -103,8 +103,12 @@ import ( // type: string // description: Links to the next and previous queries. // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request func (m *Module) HomeTimelineGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/timelines/list.go b/internal/api/client/timelines/list.go index e76107f1d..e2f77ce1d 100644 --- a/internal/api/client/timelines/list.go +++ b/internal/api/client/timelines/list.go @@ -102,8 +102,12 @@ import ( // type: string // description: Links to the next and previous queries. // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request func (m *Module) ListTimelineGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/timelines/public.go b/internal/api/client/timelines/public.go index 5fa32ac03..4d8dead7c 100644 --- a/internal/api/client/timelines/public.go +++ b/internal/api/client/timelines/public.go @@ -104,8 +104,12 @@ import ( // type: string // description: Links to the next and previous queries. // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request func (m *Module) PublicTimelineGETHandler(c *gin.Context) { var ( diff --git a/internal/api/client/timelines/tag.go b/internal/api/client/timelines/tag.go index daf88f528..8e77dd2fb 100644 --- a/internal/api/client/timelines/tag.go +++ b/internal/api/client/timelines/tag.go @@ -103,8 +103,12 @@ import ( // type: string // description: Links to the next and previous queries. // '401': +// schema: +// "$ref": "#/definitions/error" // description: unauthorized // '400': +// schema: +// "$ref": "#/definitions/error" // description: bad request func (m *Module) TagTimelineGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, |