feat: add low_skies interval to API documentation

hackclub · Oct 16, 2024 · 4c04603 · 4c04603
1 parent 913b671
commit 4c04603
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/routes/api/summary.go b/routes/api/summary.go
@@ -38,7 +38,7 @@ func (h *SummaryApiHandler) RegisterRoutes(router chi.Router) {
 // @ID get-summary
 // @Tags summary
 // @Produce json
-// @Param interval query string false "Interval identifier" Enums(today, yesterday, week, month, year, 7_days, last_7_days, 30_days, last_30_days, 6_months, last_6_months, 12_months, last_12_months, last_year, any, all_time)
+// @Param interval query string false "Interval identifier" Enums(today, yesterday, week, month, year, 7_days, last_7_days, 30_days, last_30_days, 6_months, last_6_months, 12_months, last_12_months, last_year, any, all_time, low_skies)
 // @Param from query string false "Start date (e.g. '2021-02-07')"
 // @Param to query string false "End date (e.g. '2021-02-08')"
 // @Param recompute query bool false "Whether to recompute the summary from raw heartbeat or use cache"

diff --git a/static/docs/docs.go b/static/docs/docs.go
@@ -959,7 +959,8 @@ const docTemplate = `{
                             "last_12_months",
                             "last_year",
                             "any",
-                            "all_time"
+                            "all_time",
+                            "low_skies"
                         ],
                         "type": "string",
                         "description": "Interval identifier",

diff --git a/static/docs/swagger.json b/static/docs/swagger.json
@@ -951,7 +951,8 @@
                             "last_12_months",
                             "last_year",
                             "any",
-                            "all_time"
+                            "all_time",
+                            "low_skies"
                         ],
                         "type": "string",
                         "description": "Interval identifier",

diff --git a/static/docs/swagger.yaml b/static/docs/swagger.yaml
@@ -1200,6 +1200,7 @@ paths:
         - last_year
         - any
         - all_time
+        - low_skies
         in: query
         name: interval
         type: string