robin/dttmr-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: added docstring for /version endpoint

Browse Source
This commit is contained in:
robin
2026-09-01 16:57:49 +02:00
parent 19ad59ac30
commit 62a5324e6d
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/api/handler/version.go
+11 -2
View File
@@ -6,15 +6,24 @@ import (
"github.com/robindittmar/dttmr-api/internal/api/response" "github.com/robindittmar/dttmr-api/internal/api/response"
) )
type Version struct { type VersionResponse struct {
Version string `json:"version"` Version string `json:"version"`
Commit string `json:"commit"` Commit string `json:"commit"`
BuildTime string `json:"buildTime"` BuildTime string `json:"buildTime"`
} }
// VersionHandler handles the version route
//
// @Summary Service version
// @Description Reports the version of the API
// @Tags Version
// @Accept json
// @Produce json
// @Success 200 {object} VersionResponse
// @Router /version [get]
func VersionHandler(version string, commit string, buildTime string) func(http.ResponseWriter, *http.Request) { func VersionHandler(version string, commit string, buildTime string) func(http.ResponseWriter, *http.Request) {
return func(w http.ResponseWriter, r *http.Request) { return func(w http.ResponseWriter, r *http.Request) {
response.JSON(r.Context(), w, http.StatusOK, Version{ response.JSON(r.Context(), w, http.StatusOK, VersionResponse{
Version: version, Version: version,
Commit: commit, Commit: commit,
BuildTime: buildTime, BuildTime: buildTime,