datarhei-dragonfork-core/docs
Zac Gaetano c8bcf75227
Some checks failed
tests / build (push) Failing after 1s
tests / build (pull_request) Failing after 2s
fix(webrtc): swagger annotations for WHEP routes, regenerate docs (closes #3)
The WHEP routes were mounted by http/server.go via the app/webrtc
Handler.Register(), but Subscribe and Unsubscribe carried no swag
annotations. The Swagger UI at /api/swagger/index.html therefore
didn't list /api/v3/whep/* — programmatic API consumers and humans
browsing the docs couldn't discover the endpoints.

Adds the standard upstream-shaped @Summary / @Tags / @ID / @Router
annotations on Subscribe and Unsubscribe (matching the rtmp.go and
srt.go pattern) and regenerates docs/{docs.go,swagger.json,swagger.yaml}
via 'make swagger'. Verified: swagger.json now contains both paths,
swagger UI renders them under the v16.16.0 tag.

Closes #3.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-03 12:12:05 +00:00
..
design docs(m2): WebRTC into Core proper — design spec 2026-04-17 09:42:16 -04:00
superpowers/plans docs(m2): implementation plan 2026-04-17 09:49:20 -04:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2022-05-25 22:24:36 +02:00
docs.go fix(webrtc): swagger annotations for WHEP routes, regenerate docs (closes #3) 2026-05-03 12:12:05 +00:00
swagger.json fix(webrtc): swagger annotations for WHEP routes, regenerate docs (closes #3) 2026-05-03 12:12:05 +00:00
swagger.yaml fix(webrtc): swagger annotations for WHEP routes, regenerate docs (closes #3) 2026-05-03 12:12:05 +00:00