From 9592cc95c9314bc1ce767b4f879ebe91e2d51f63 Mon Sep 17 00:00:00 2001 From: Jannis Mattheis Date: Sat, 16 Sep 2023 20:38:20 +0200 Subject: [PATCH] fix: update go-swagger --- Makefile | 2 +- api/application.go | 384 +++++++++++++++++++++---------------------- api/client.go | 232 +++++++++++++------------- api/health.go | 22 +-- api/message.go | 365 ++++++++++++++++++++-------------------- api/plugin.go | 380 +++++++++++++++++++++--------------------- api/stream/stream.go | 50 +++--- api/user.go | 374 ++++++++++++++++++++--------------------- docs/package.go | 98 +++++------ docs/spec.json | 10 +- model/paging.go | 2 +- 11 files changed, 959 insertions(+), 960 deletions(-) diff --git a/Makefile b/Makefile index 9b78d5c..0fa0f04 100644 --- a/Makefile +++ b/Makefile @@ -39,7 +39,7 @@ check-js: (cd ui && yarn testformat) download-tools: - go install github.com/go-swagger/go-swagger/cmd/swagger@v0.26.1 + go install github.com/go-swagger/go-swagger/cmd/swagger@v0.30.5 update-swagger: swagger generate spec --scan-models -o docs/spec.json diff --git a/api/application.go b/api/application.go index c63d1d3..805ae2b 100644 --- a/api/application.go +++ b/api/application.go @@ -31,7 +31,7 @@ type ApplicationAPI struct { // Application Params Model // -// Params allowed to create or update Applications +// Params allowed to create or update Applications. // // swagger:model ApplicationParams type ApplicationParams struct { @@ -55,34 +55,34 @@ type ApplicationParams struct { // // Create an application. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the application to add -// required: true -// schema: -// $ref: "#/definitions/ApplicationParams" -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Application" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the application to add +// required: true +// schema: +// $ref: "#/definitions/ApplicationParams" +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Application" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) CreateApplication(ctx *gin.Context) { applicationParams := ApplicationParams{} if err := ctx.Bind(&applicationParams); err == nil { @@ -107,25 +107,25 @@ func (a *ApplicationAPI) CreateApplication(ctx *gin.Context) { // // Return all applications. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: array -// items: -// $ref: "#/definitions/Application" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: array +// items: +// $ref: "#/definitions/Application" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) GetApplications(ctx *gin.Context) { userID := auth.GetUserID(ctx) apps, err := a.DB.GetApplicationsByUser(userID) @@ -143,36 +143,36 @@ func (a *ApplicationAPI) GetApplications(ctx *gin.Context) { // // Delete an application. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) DeleteApplication(ctx *gin.Context) { withID(ctx, "id", func(id uint) { app, err := a.DB.GetApplicationByID(id) @@ -201,44 +201,44 @@ func (a *ApplicationAPI) DeleteApplication(ctx *gin.Context) { // // Update an application. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the application to update -// required: true -// schema: -// $ref: "#/definitions/ApplicationParams" -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Application" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the application to update +// required: true +// schema: +// $ref: "#/definitions/ApplicationParams" +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Application" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) UpdateApplication(ctx *gin.Context) { withID(ctx, "id", func(id uint) { app, err := a.DB.GetApplicationByID(id) @@ -268,48 +268,48 @@ func (a *ApplicationAPI) UpdateApplication(ctx *gin.Context) { // // Upload an image for an application. // -// --- -// consumes: -// - multipart/form-data -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: file -// in: formData -// description: the application image -// required: true -// type: file -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Application" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: +// - multipart/form-data +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: file +// in: formData +// description: the application image +// required: true +// type: file +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Application" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Server Error +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) UploadApplicationImage(ctx *gin.Context) { withID(ctx, "id", func(id uint) { app, err := a.DB.GetApplicationByID(id) @@ -369,40 +369,40 @@ func (a *ApplicationAPI) UploadApplicationImage(ctx *gin.Context) { // // Deletes an image of an application. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Server Error +// schema: +// $ref: "#/definitions/Error" func (a *ApplicationAPI) RemoveApplicationImage(ctx *gin.Context) { withID(ctx, "id", func(id uint) { app, err := a.DB.GetApplicationByID(id) diff --git a/api/client.go b/api/client.go index 986c14f..865d74d 100644 --- a/api/client.go +++ b/api/client.go @@ -27,7 +27,7 @@ type ClientAPI struct { // Client Params Model // -// Params allowed to create or update Clients +// Params allowed to create or update Clients. // // swagger:model ClientParams type ClientParams struct { @@ -43,44 +43,44 @@ type ClientParams struct { // // Update a client. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the client to update -// required: true -// schema: -// $ref: "#/definitions/ClientParams" -// - name: id -// in: path -// description: the client id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Client" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the client to update +// required: true +// schema: +// $ref: "#/definitions/ClientParams" +// - name: id +// in: path +// description: the client id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Client" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *ClientAPI) UpdateClient(ctx *gin.Context) { withID(ctx, "id", func(id uint) { client, err := a.DB.GetClientByID(id) @@ -108,34 +108,34 @@ func (a *ClientAPI) UpdateClient(ctx *gin.Context) { // // Create a client. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the client to add -// required: true -// schema: -// $ref: "#/definitions/ClientParams" -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Client" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the client to add +// required: true +// schema: +// $ref: "#/definitions/ClientParams" +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Client" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *ClientAPI) CreateClient(ctx *gin.Context) { clientParams := ClientParams{} if err := ctx.Bind(&clientParams); err == nil { @@ -157,25 +157,25 @@ func (a *ClientAPI) CreateClient(ctx *gin.Context) { // // Return all clients. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: array -// items: -// $ref: "#/definitions/Client" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: array +// items: +// $ref: "#/definitions/Client" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *ClientAPI) GetClients(ctx *gin.Context) { userID := auth.GetUserID(ctx) clients, err := a.DB.GetClientsByUser(userID) @@ -190,36 +190,36 @@ func (a *ClientAPI) GetClients(ctx *gin.Context) { // // Delete a client. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the client id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the client id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *ClientAPI) DeleteClient(ctx *gin.Context) { withID(ctx, "id", func(id uint) { client, err := a.DB.GetClientByID(id) diff --git a/api/health.go b/api/health.go index ff4a3b4..dd26ca1 100644 --- a/api/health.go +++ b/api/health.go @@ -20,17 +20,17 @@ type HealthAPI struct { // // Get health information. // -// --- -// produces: [application/json] -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Health" -// 500: -// description: Ok -// schema: -// $ref: "#/definitions/Health" +// --- +// produces: [application/json] +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Health" +// 500: +// description: Ok +// schema: +// $ref: "#/definitions/Health" func (a *HealthAPI) Health(ctx *gin.Context) { if err := a.DB.Ping(); err != nil { ctx.JSON(500, model.Health{ diff --git a/api/message.go b/api/message.go index 3a4b242..3225c3d 100644 --- a/api/message.go +++ b/api/message.go @@ -50,42 +50,42 @@ type pagingParams struct { // // Return all messages. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: limit -// in: query -// description: the maximal amount of messages to return -// required: false -// maximum: 200 -// minimum: 1 -// default: 100 -// type: integer -// - name: since -// in: query -// description: return all messages with an ID less than this value -// minimum: 0 -// required: false -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/PagedMessages" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: limit +// in: query +// description: the maximal amount of messages to return +// required: false +// maximum: 200 +// minimum: 1 +// default: 100 +// type: integer +// - name: since +// in: query +// description: return all messages with an ID less than this value +// minimum: 0 +// required: false +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/PagedMessages" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) GetMessages(ctx *gin.Context) { userID := auth.GetUserID(ctx) withPaging(ctx, func(params *pagingParams) { @@ -131,52 +131,52 @@ func withPaging(ctx *gin.Context, f func(pagingParams *pagingParams)) { // // Return all messages from a specific application. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// - name: limit -// in: query -// description: the maximal amount of messages to return -// required: false -// maximum: 200 -// minimum: 1 -// default: 100 -// type: integer -// - name: since -// in: query -// description: return all messages with an ID less than this value -// minimum: 0 -// required: false -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/PagedMessages" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// - name: limit +// in: query +// description: the maximal amount of messages to return +// required: false +// maximum: 200 +// minimum: 1 +// default: 100 +// type: integer +// - name: since +// in: query +// description: return all messages with an ID less than this value +// minimum: 0 +// required: false +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/PagedMessages" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) GetMessagesWithApplication(ctx *gin.Context) { withID(ctx, "id", func(id uint) { withPaging(ctx, func(params *pagingParams) { @@ -203,20 +203,20 @@ func (a *MessageAPI) GetMessagesWithApplication(ctx *gin.Context) { // // Delete all messages. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) DeleteMessages(ctx *gin.Context) { userID := auth.GetUserID(ctx) successOrAbort(ctx, 500, a.DB.DeleteMessagesByUser(userID)) @@ -227,35 +227,35 @@ func (a *MessageAPI) DeleteMessages(ctx *gin.Context) { // // Delete all messages from a specific application. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the application id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the application id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) DeleteMessageWithApplication(ctx *gin.Context) { withID(ctx, "id", func(id uint) { application, err := a.DB.GetApplicationByID(id) @@ -275,35 +275,35 @@ func (a *MessageAPI) DeleteMessageWithApplication(ctx *gin.Context) { // // Deletes a message with an id. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the message id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the message id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) DeleteMessage(ctx *gin.Context) { withID(ctx, "id", func(id uint) { msg, err := a.DB.GetMessageByID(id) @@ -332,34 +332,35 @@ func (a *MessageAPI) DeleteMessage(ctx *gin.Context) { // Create a message. // // __NOTE__: This API ONLY accepts an application token as authentication. -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [appTokenAuthorizationHeader: [], appTokenHeader: [], appTokenQuery: []] -// parameters: -// - name: body -// in: body -// description: the message to add -// required: true -// schema: -// $ref: "#/definitions/Message" -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Message" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [appTokenAuthorizationHeader: [], appTokenHeader: [], appTokenQuery: []] +// parameters: +// - name: body +// in: body +// description: the message to add +// required: true +// schema: +// $ref: "#/definitions/Message" +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Message" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *MessageAPI) CreateMessage(ctx *gin.Context) { message := model.MessageExternal{} if err := ctx.Bind(&message); err == nil { diff --git a/api/plugin.go b/api/plugin.go index 52fbd73..5958706 100644 --- a/api/plugin.go +++ b/api/plugin.go @@ -33,33 +33,33 @@ type PluginAPI struct { // // Return all plugins. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: array -// items: -// $ref: "#/definitions/PluginConf" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: array +// items: +// $ref: "#/definitions/PluginConf" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) GetPlugins(ctx *gin.Context) { userID := auth.GetUserID(ctx) plugins, err := c.DB.GetPluginConfByUser(userID) @@ -91,36 +91,36 @@ func (c *PluginAPI) GetPlugins(ctx *gin.Context) { // // Enable a plugin. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the plugin id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the plugin id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) EnablePlugin(ctx *gin.Context) { withID(ctx, "id", func(id uint) { conf, err := c.DB.GetPluginConfByID(id) @@ -149,36 +149,36 @@ func (c *PluginAPI) EnablePlugin(ctx *gin.Context) { // // Disable a plugin. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the plugin id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the plugin id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) DisablePlugin(ctx *gin.Context) { withID(ctx, "id", func(id uint) { conf, err := c.DB.GetPluginConfByID(id) @@ -207,38 +207,38 @@ func (c *PluginAPI) DisablePlugin(ctx *gin.Context) { // // Get display info for a Displayer plugin. // -// --- -// consumes: [application/json] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the plugin id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: string -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the plugin id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: string +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) GetDisplay(ctx *gin.Context) { withID(ctx, "id", func(id uint) { conf, err := c.DB.GetPluginConfByID(id) @@ -263,43 +263,43 @@ func (c *PluginAPI) GetDisplay(ctx *gin.Context) { // // Get YAML configuration for Configurer plugin. // -// --- -// consumes: [application/json] -// produces: [application/x-yaml] -// parameters: -// - name: id -// in: path -// description: the plugin id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: object -// description: plugin configuration -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/x-yaml] +// parameters: +// - name: id +// in: path +// description: the plugin id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: object +// description: plugin configuration +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) GetConfig(ctx *gin.Context) { withID(ctx, "id", func(id uint) { conf, err := c.DB.GetPluginConfByID(id) @@ -330,40 +330,40 @@ func (c *PluginAPI) GetConfig(ctx *gin.Context) { // // Update YAML configuration for Configurer plugin. // -// --- -// consumes: [application/x-yaml] -// produces: [application/json] -// parameters: -// - name: id -// in: path -// description: the plugin id -// required: true -// type: integer -// format: int64 -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Internal Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/x-yaml] +// produces: [application/json] +// parameters: +// - name: id +// in: path +// description: the plugin id +// required: true +// type: integer +// format: int64 +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Internal Server Error +// schema: +// $ref: "#/definitions/Error" func (c *PluginAPI) UpdateConfig(ctx *gin.Context) { withID(ctx, "id", func(id uint) { conf, err := c.DB.GetPluginConfByID(id) diff --git a/api/stream/stream.go b/api/stream/stream.go index bc5007e..5e8692f 100644 --- a/api/stream/stream.go +++ b/api/stream/stream.go @@ -115,31 +115,31 @@ func (a *API) register(client *client) { // // Websocket, return newly created messages. // -// --- -// schema: ws, wss -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/Message" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 500: -// description: Server Error -// schema: -// $ref: "#/definitions/Error" +// --- +// schema: ws, wss +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/Message" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 500: +// description: Server Error +// schema: +// $ref: "#/definitions/Error" func (a *API) Handle(ctx *gin.Context) { conn, err := a.upgrader.Upgrade(ctx.Writer, ctx.Request, nil) if err != nil { diff --git a/api/user.go b/api/user.go index 9bc41cd..2d786c3 100644 --- a/api/user.go +++ b/api/user.go @@ -69,24 +69,24 @@ type UserAPI struct { // // Return all users. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// type: array -// items: -// $ref: "#/definitions/User" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// type: array +// items: +// $ref: "#/definitions/User" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) GetUsers(ctx *gin.Context) { users, err := a.DB.GetUsers() if success := successOrAbort(ctx, 500, err); !success { @@ -105,22 +105,22 @@ func (a *UserAPI) GetUsers(ctx *gin.Context) { // // Return the current user. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/User" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/User" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) GetCurrentUser(ctx *gin.Context) { user, err := a.DB.GetUserByID(auth.GetUserID(ctx)) if success := successOrAbort(ctx, 500, err); !success { @@ -137,34 +137,34 @@ func (a *UserAPI) GetCurrentUser(ctx *gin.Context) { // With enabled registration: non admin users can be created without authentication. // With disabled registrations: users can only be created by admin users. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the user to add -// required: true -// schema: -// $ref: "#/definitions/CreateUserExternal" -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/User" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the user to add +// required: true +// schema: +// $ref: "#/definitions/CreateUserExternal" +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/User" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) CreateUser(ctx *gin.Context) { user := model.CreateUserExternal{} if err := ctx.Bind(&user); err == nil { @@ -223,38 +223,38 @@ func (a *UserAPI) CreateUser(ctx *gin.Context) { // // Get a user. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the user id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/User" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the user id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/User" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) GetUserByID(ctx *gin.Context) { withID(ctx, "id", func(id uint) { user, err := a.DB.GetUserByID(id) @@ -274,35 +274,35 @@ func (a *UserAPI) GetUserByID(ctx *gin.Context) { // // Deletes a user. // -// --- -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the user id -// required: true -// type: integer -// format: int64 -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the user id +// required: true +// type: integer +// format: int64 +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) DeleteUserByID(ctx *gin.Context) { withID(ctx, "id", func(id uint) { user, err := a.DB.GetUserByID(id) @@ -334,32 +334,32 @@ func (a *UserAPI) DeleteUserByID(ctx *gin.Context) { // // Update the password of the current user. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: body -// in: body -// description: the user -// required: true -// schema: -// $ref: "#/definitions/UserPass" -// responses: -// 200: -// description: Ok -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: body +// in: body +// description: the user +// required: true +// schema: +// $ref: "#/definitions/UserPass" +// responses: +// 200: +// description: Ok +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) ChangePassword(ctx *gin.Context) { pw := model.UserExternalPass{} if err := ctx.Bind(&pw); err == nil { @@ -377,44 +377,44 @@ func (a *UserAPI) ChangePassword(ctx *gin.Context) { // // Update a user. // -// --- -// consumes: [application/json] -// produces: [application/json] -// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] -// parameters: -// - name: id -// in: path -// description: the user id -// required: true -// type: integer -// format: int64 -// - name: body -// in: body -// description: the updated user -// required: true -// schema: -// $ref: "#/definitions/UpdateUserExternal" -// responses: -// 200: -// description: Ok -// schema: -// $ref: "#/definitions/User" -// 400: -// description: Bad Request -// schema: -// $ref: "#/definitions/Error" -// 401: -// description: Unauthorized -// schema: -// $ref: "#/definitions/Error" -// 403: -// description: Forbidden -// schema: -// $ref: "#/definitions/Error" -// 404: -// description: Not Found -// schema: -// $ref: "#/definitions/Error" +// --- +// consumes: [application/json] +// produces: [application/json] +// security: [clientTokenAuthorizationHeader: [], clientTokenHeader: [], clientTokenQuery: [], basicAuth: []] +// parameters: +// - name: id +// in: path +// description: the user id +// required: true +// type: integer +// format: int64 +// - name: body +// in: body +// description: the updated user +// required: true +// schema: +// $ref: "#/definitions/UpdateUserExternal" +// responses: +// 200: +// description: Ok +// schema: +// $ref: "#/definitions/User" +// 400: +// description: Bad Request +// schema: +// $ref: "#/definitions/Error" +// 401: +// description: Unauthorized +// schema: +// $ref: "#/definitions/Error" +// 403: +// description: Forbidden +// schema: +// $ref: "#/definitions/Error" +// 404: +// description: Not Found +// schema: +// $ref: "#/definitions/Error" func (a *UserAPI) UpdateUserByID(ctx *gin.Context) { withID(ctx, "id", func(id uint) { var user *model.UpdateUserExternal diff --git a/docs/package.go b/docs/package.go index a9748e6..9597adf 100644 --- a/docs/package.go +++ b/docs/package.go @@ -2,61 +2,61 @@ // // This is the documentation of the Gotify REST-API. // -// # Authentication -// In Gotify there are two token types: -// __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) -// __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) +// # Authentication +// In Gotify there are two token types: +// __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) +// __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) // -// The token can be transmitted in a header named `X-Gotify-Key`, in a query parameter named `token` or -// through a header named `Authorization` with the value prefixed with `Bearer` (Ex. `Bearer randomtoken`). -// There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. +// The token can be transmitted in a header named `X-Gotify-Key`, in a query parameter named `token` or +// through a header named `Authorization` with the value prefixed with `Bearer` (Ex. `Bearer randomtoken`). +// There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. // -// \--- +// \--- // -// Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) +// Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) // -// Schemes: http, https -// Host: localhost -// Version: 2.0.2 -// License: MIT https://github.com/gotify/server/blob/master/LICENSE +// Schemes: http, https +// Host: localhost +// Version: 2.0.2 +// License: MIT https://github.com/gotify/server/blob/master/LICENSE // -// Consumes: -// - application/json +// Consumes: +// - application/json // -// Produces: -// - application/json +// Produces: +// - application/json // -// SecurityDefinitions: -// appTokenQuery: -// type: apiKey -// name: token -// in: query -// clientTokenQuery: -// type: apiKey -// name: token -// in: query -// appTokenHeader: -// type: apiKey -// name: X-Gotify-Key -// in: header -// clientTokenHeader: -// type: apiKey -// name: X-Gotify-Key -// in: header -// appTokenAuthorizationHeader: -// type: apiKey -// name: Authorization -// in: header -// description: >- -// Enter an application token with the `Bearer` prefix, e.g. `Bearer Axxxxxxxxxx`. -// clientTokenAuthorizationHeader: -// type: apiKey -// name: Authorization -// in: header -// description: >- -// Enter a client token with the `Bearer` prefix, e.g. `Bearer Cxxxxxxxxxx`. -// basicAuth: -// type: basic +// SecurityDefinitions: +// appTokenQuery: +// type: apiKey +// name: token +// in: query +// clientTokenQuery: +// type: apiKey +// name: token +// in: query +// appTokenHeader: +// type: apiKey +// name: X-Gotify-Key +// in: header +// clientTokenHeader: +// type: apiKey +// name: X-Gotify-Key +// in: header +// appTokenAuthorizationHeader: +// type: apiKey +// name: Authorization +// in: header +// description: >- +// Enter an application token with the `Bearer` prefix, e.g. `Bearer Axxxxxxxxxx`. +// clientTokenAuthorizationHeader: +// type: apiKey +// name: Authorization +// in: header +// description: >- +// Enter a client token with the `Bearer` prefix, e.g. `Bearer Cxxxxxxxxxx`. +// basicAuth: +// type: basic // -// swagger:meta +// swagger:meta package docs diff --git a/docs/spec.json b/docs/spec.json index 1dd82aa..450450e 100644 --- a/docs/spec.json +++ b/docs/spec.json @@ -2123,7 +2123,7 @@ "x-go-package": "github.com/gotify/server/v2/model" }, "ApplicationParams": { - "description": "Params allowed to create or update Applications", + "description": "Params allowed to create or update Applications.", "type": "object", "title": "Application Params Model", "required": [ @@ -2195,7 +2195,7 @@ "x-go-package": "github.com/gotify/server/v2/model" }, "ClientParams": { - "description": "Params allowed to create or update Clients", + "description": "Params allowed to create or update Clients.", "type": "object", "title": "Client Params Model", "required": [ @@ -2328,9 +2328,7 @@ "extras": { "description": "The extra data sent along the message.\n\nThe extra fields are stored in a key-value scheme. Only accepted in CreateMessage requests with application/json content-type.\n\nThe keys should be in the following format: \u0026lt;top-namespace\u0026gt;::[\u0026lt;sub-namespace\u0026gt;::]\u0026lt;action\u0026gt;\n\nThese namespaces are reserved and might be used in the official clients: gotify android ios web server client. Do not use them for other purposes.", "type": "object", - "additionalProperties": { - "type": "object" - }, + "additionalProperties": {}, "x-go-name": "Extras", "example": { "home::appliances::lighting::on": { @@ -2373,7 +2371,7 @@ "x-go-package": "github.com/gotify/server/v2/model" }, "PagedMessages": { - "description": "Wrapper for the paging and the messages", + "description": "Wrapper for the paging and the messages.", "type": "object", "title": "PagedMessages Model", "required": [ diff --git a/model/paging.go b/model/paging.go index a58f5ad..c198c13 100644 --- a/model/paging.go +++ b/model/paging.go @@ -37,7 +37,7 @@ type Paging struct { // PagedMessages Model // -// Wrapper for the paging and the messages +// Wrapper for the paging and the messages. // // swagger:model PagedMessages type PagedMessages struct {