diff --git a/cmd/pushbits/main.go b/cmd/pushbits/main.go index f2965e6..8c04acd 100644 --- a/cmd/pushbits/main.go +++ b/cmd/pushbits/main.go @@ -26,6 +26,19 @@ func setupCleanup(db *database.Database, dp *dispatcher.Dispatcher) { }() } +// @title PushBits Server API Documentation +// @version 1.0 +// @description Documentation for the PushBits server API. + +// TODO add inprint and contact? +// @contact.name API Support +// @contact.url http://www.swagger.io/support + +// @host your-domain.net +// @BasePath / +// @query.collection.format multi + +// @securityDefinitions.basic BasicAuth func main() { log.Println("Starting PushBits.") diff --git a/internal/api/application.go b/internal/api/application.go index f90c9bd..d7ece91 100644 --- a/internal/api/application.go +++ b/internal/api/application.go @@ -109,7 +109,16 @@ func (h *ApplicationHandler) updateApplication(ctx *gin.Context, a *model.Applic return nil } -// CreateApplication creates an application. +// CreateApplication godoc +// @Summary Create Application +// @Description Create a new application +// @Accept mpfd +// @Produce json +// @Param name query string true "Name of the application" +// @Param strict_compatability query boolean false "Use strict compatability mode" +// @Success 200 {object} model.Application +// @Failure 400 {string} "" +// @Router /application [post] func (h *ApplicationHandler) CreateApplication(ctx *gin.Context) { var createApplication model.CreateApplication