johanels/photoprism
1
0
Fork 0
mirror of https://github.com/photoprism/photoprism.git synced 2025-12-12 08:44:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

API: Update swagger endpoint documentation #5133

Browse Source 
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer
2025-08-28 11:20:00 +02:00
parent 0823dceab1
commit 7bebf3bd60
2 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
internal/api/status.go
View File

@@ -6,11 +6,11 @@ import (
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
) )
// GetStatus reports if the server is operational. // GetStatus responds with status code 200 if the server is operational.
// //
// @Summary reports if the server is operational // @Summary responds with status code 200 if the server is operational
// @Id GetStatus // @Id GetStatus
// @Tags Server // @Tags Debug
// @Produce json // @Produce json
// @Success 200 {object} gin.H // @Success 200 {object} gin.H
// @Router /api/v1/status [get] // @Router /api/v1/status [get]

16
internal/api/swagger.json
View File

@@ -4629,9 +4629,9 @@
"application/json" "application/json"
], ],
"tags": [ "tags": [
"Server" "Debug"
], ],
"summary": "reports if the server is operational", "summary": "responds with status code 200 if the server is operational",
"operationId": "GetStatus", "operationId": "GetStatus",
"responses": { "responses": {
"200": { "200": {
@@ -8897,6 +8897,12 @@
1000000, 1000000,
1000000000, 1000000000,
60000000000, 60000000000,
3600000000000,
1,
1000,
1000000,
1000000000,
60000000000,
3600000000000 3600000000000
], ],
"x-enum-varnames": [ "x-enum-varnames": [
@@ -8923,6 +8929,12 @@
"Millisecond", "Millisecond",
"Second", "Second",
"Minute", "Minute",
"Hour",
"Nanosecond",
"Microsecond",
"Millisecond",
"Second",
"Minute",
"Hour" "Hour"
] ]
}, },