add language api docs
This commit is contained in:
75
controllers/languageController.go
Normal file
75
controllers/languageController.go
Normal file
@@ -0,0 +1,75 @@
|
||||
package controllers
|
||||
|
||||
import (
|
||||
"github.com/gin-gonic/gin"
|
||||
_ "github.com/swaggo/swag/example/celler/httputil"
|
||||
|
||||
_ "git.dynamicdiscord.de/harakat/backend/models"
|
||||
)
|
||||
|
||||
// Register godoc
|
||||
// @Summary List all languages
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Success 200 {array} models.Language
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/ [get]
|
||||
func (dc *DummyController) ListLanguages(c *gin.Context) {}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Create a language
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param lang body models.LanguageRequest true "language"
|
||||
// @Success 200 {object} models.Language
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/ [post]
|
||||
func (dc *DummyController) CreateLanguage(c *gin.Context) {}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Retreive a language
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param id path int true "A unique integer value identifying this language."
|
||||
// @Success 200 {object} models.Language
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/{id} [get]
|
||||
func (dc *DummyController) RetreiveLanguage(c *gin.Context) {}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Update an existing language
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param id path int true "A unique integer value identifying this language."
|
||||
// @Param lang body models.LanguageRequest true "updated language"
|
||||
// @Success 200 {object} models.Language
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/{id} [put]
|
||||
func (dc *DummyController) UpdateLanguage(c *gin.Context) {}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Partially update an existing language
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param id path int true "A unique integer value identifying this language."
|
||||
// @Param lang body models.LanguageRequest true "partially updated language"
|
||||
// @Success 200 {object} models.Language
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/{id} [patch]
|
||||
func (dc *DummyController) PatchLanguage(c *gin.Context) {}
|
||||
|
||||
// Register godoc
|
||||
// @Summary Delete an existing language
|
||||
// @Tags lang
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param id path int true "A unique integer value identifying this language."
|
||||
// @Success 200 {object} EmptyResponse
|
||||
// @Failure 400 {object} httputil.HTTPError
|
||||
// @Router /lang/{id} [delete]
|
||||
func (dc *DummyController) DeleteLanguage(c *gin.Context) {}
|
||||
Reference in New Issue
Block a user