dandri/beacon-server
1
0 Fork 0
mirror of https://github.com/MeshCore-Beacon/beacon-server.git synced 2026-10-23 13:22:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

update swag comments

Browse Source 
fixes issue with generics not being parsed
This commit is contained in:
Enot (ded) Skelly committed 2026-06-02 08:39:27 -07:00
1 parent 29e3378093
commit afb4fe9053
10 files changed
+1428 -284
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

internal/api/handlers/channels.go
+2 -2
View File
@@ -34,7 +34,7 @@ func ChannelsRouter(reader api.Reader) http.Handler {
// @Param iata query string false "Filter by IATA code (case-insensitive)"
// @Param cursor query int false "last_seen epoch ms of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} object
// @Success 200 {object} api.Page[api.ChannelSummary]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /channels [get]
@@ -121,7 +121,7 @@ func getChannel(reader api.Reader) http.HandlerFunc {
// @Param iata query string false "Filter by IATA code"
// @Param cursor query int false "Message ID of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} object
// @Success 200 {object} api.Page[api.ChannelMessage]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /channels/{channelID}/messages [get]
internal/api/handlers/messages.go
+1 -1
View File
@@ -30,7 +30,7 @@ func MessagesRouter(reader api.Reader) http.Handler {
// @Param iata query string false "Filter by IATA code"
// @Param cursor query int false "Message ID of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} object
// @Success 200 {object} api.Page[api.ChannelMessage]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /messages [get]
internal/api/handlers/nodes.go
+5 -5
View File
@@ -32,14 +32,15 @@ func NodesRouter(reader api.Reader) http.Handler {
// @Produce json
// @Param type query int false "Node type integer (1=companion, 2=repeater, 3=room_server, 4=sensor)"
// @Param typeName query string false "Node type name (companion, repeater, room_server, sensor)"
// @Param iata query string false "Filter by IATA code (case-insensitive); comma-separated for multiple"
// @Param iata query string false "Filter by IATA code (case-insensitive)"
// @Param name query string false "Partial case-insensitive name match"
// @Param pubkey query string false "Exact public key match (hex)"
// @Param supportsMultibytePaths query string false "Multibyte path support filter: any (default), true, false"
// @Param supportsMultibyteTraces query string false "Multibyte trace support filter: any (default), true, false"
// @Param supportsMultibytePaths query bool false "Filter by multibyte path support (true/false); omit for no filter"
// @Param supportsMultibyteTraces query bool false "Filter by multibyte trace support (true/false); omit for no filter"
// @Param cursor query int false "last_seen epoch ms of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} api.Page[api.NodeSummary]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /nodes [get]
func listNodes(reader api.Reader) http.HandlerFunc {
@@ -120,7 +121,6 @@ func listNodes(reader api.Reader) http.HandlerFunc {
// @Success 200 {object} api.Node
// @Failure 400 {object} handlers.APIError
// @Failure 404 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /nodes/{nodeId} [get]
func getNode(reader api.Reader) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
@@ -146,7 +146,7 @@ func getNode(reader api.Reader) http.HandlerFunc {
// @Param nodeId path string true "Node UUID"
// @Param cursor query int false "Observation ID of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} api.Page[api.NodeObservation]
// @Success 200 {object} api.Page[api.PacketObservationSummary]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /nodes/{nodeId}/observations [get]
internal/api/handlers/observers.go
+4 -2
View File
@@ -39,7 +39,8 @@ func ObserversRouter(reader api.Reader) http.Handler {
// @Param name query string false "Partial case-insensitive display name match"
// @Param cursor query int false "last_seen epoch ms of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} object
// @Success 200 {object} api.Page[api.ObserverSummary]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /observers [get]
func listObservers(reader api.Reader) http.HandlerFunc {
@@ -111,7 +112,7 @@ func getObserver(reader api.Reader) http.HandlerFunc {
// @Param observerId path string true "Observer UUID"
// @Param cursor query int false "Observation ID of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} object
// @Success 200 {object} api.Page[api.AdvertObservation]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /observers/{observerId}/adverts [get]
@@ -157,6 +158,7 @@ func listObserverAdverts(reader api.Reader) http.HandlerFunc {
// @Param observerId path string true "Observer UUID"
// @Param range query string false "Duration window e.g. 24h, 48h, 168h (default 24h)"
// @Param afterId query int false "Return points after this telemetry ID for WS reconnection backfill"
// @Param interval query string false "Bucketing interval, echoed back in the response; not yet applied server-side"
// @Success 200 {object} api.ObserverTelemetry
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
internal/api/handlers/packets.go
+1
View File
@@ -35,6 +35,7 @@ func PacketsRouter(reader api.Reader) http.Handler {
// @Param cursor query int false "last_heard_at epoch ms of last item for pagination"
// @Param limit query int false "Max results (default 50)"
// @Success 200 {object} api.Page[api.PacketSummary]
// @Failure 400 {object} handlers.APIError
// @Failure 500 {object} handlers.APIError
// @Router /packets [get]
func listPackets(reader api.Reader) http.HandlerFunc {
internal/api/handlers/stats.go
+1 -1
View File
@@ -121,7 +121,7 @@ func getStatsPayloadBreakdown(reader api.Reader) http.HandlerFunc {
// @Summary Top N nodes by observation count (from materialized view)
// @Tags Stats
// @Produce json
// @Param iata query string false "Filter by IATA code (case-insensitive)"
// @Param iata query string false "Filter by exact IATA code (case-sensitive)"
// @Param limit query int false "Max results (default 10)"
// @Success 200 {array} api.TopNode
// @Failure 500 {object} handlers.APIError