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/scheduledstatuses | |
| 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/scheduledstatuses')
4 files changed, 42 insertions, 0 deletions
diff --git a/internal/api/client/scheduledstatuses/scheduledstatusdelete.go b/internal/api/client/scheduledstatuses/scheduledstatusdelete.go index efd645e2a..835eef453 100644 --- a/internal/api/client/scheduledstatuses/scheduledstatusdelete.go +++ b/internal/api/client/scheduledstatuses/scheduledstatusdelete.go @@ -53,14 +53,24 @@ import ( // '200': // description: status canceled // '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) ScheduledStatusDELETEHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/scheduledstatuses/scheduledstatusesget.go b/internal/api/client/scheduledstatuses/scheduledstatusesget.go index 6d08ff18b..ead8f22fb 100644 --- a/internal/api/client/scheduledstatuses/scheduledstatusesget.go +++ b/internal/api/client/scheduledstatuses/scheduledstatusesget.go @@ -84,14 +84,24 @@ import ( // items: // "$ref": "#/definitions/scheduledStatus" // '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) ScheduledStatusesGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/scheduledstatuses/scheduledstatusget.go b/internal/api/client/scheduledstatuses/scheduledstatusget.go index 893c44938..16399f0a5 100644 --- a/internal/api/client/scheduledstatuses/scheduledstatusget.go +++ b/internal/api/client/scheduledstatuses/scheduledstatusget.go @@ -54,14 +54,24 @@ import ( // schema: // "$ref": "#/definitions/scheduledStatus" // '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) ScheduledStatusGETHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, diff --git a/internal/api/client/scheduledstatuses/scheduledstatusput.go b/internal/api/client/scheduledstatuses/scheduledstatusput.go index 7b458a8d2..2042bd397 100644 --- a/internal/api/client/scheduledstatuses/scheduledstatusput.go +++ b/internal/api/client/scheduledstatuses/scheduledstatusput.go @@ -66,16 +66,28 @@ import ( // schema: // "$ref": "#/definitions/scheduledStatus" // '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 // '422': +// schema: +// "$ref": "#/definitions/error" // description: unprocessable content // '500': +// schema: +// "$ref": "#/definitions/error" // description: internal server error func (m *Module) ScheduledStatusPUTHandler(c *gin.Context) { authed, errWithCode := apiutil.TokenAuth(c, |