sneak/dnswatcher
1
0
Fork 0
Code Issues 29 Pull Requests 3 Actions Packages Projects Releases Wiki Activity

README documents API endpoints that do not exist #67

New Issue
Closed
opened 2026-03-02 00:50:20 +01:00 by clawbot · 0 comments
clawbot commented 2026-03-02 00:50:20 +01:00
Collaborator
Copy Link
Copy Source

Problem

The README HTTP API table lists the following endpoints:

  • GET /api/v1/domains — "Configured domains and status"
  • GET /api/v1/hostnames — "Configured hostnames and status"

These endpoints are not implemented. The only routes defined in internal/server/routes.go are:

  • GET /health
  • GET /api/v1/status
  • GET /metrics (conditional on MetricsUsername being set)

Requests to /api/v1/domains or /api/v1/hostnames return 404.

Impact

Users who read the README and try to use these endpoints will get 404s with no useful error message.

Recommendation

Either:

  1. Implement the endpoints (preferred — they would be useful for operational visibility), or
  2. Remove them from the README

Category

Should-fix before 1.0. The README is the primary documentation and must be accurate.

## Problem The README HTTP API table lists the following endpoints: - `GET /api/v1/domains` — "Configured domains and status" - `GET /api/v1/hostnames` — "Configured hostnames and status" These endpoints are **not implemented**. The only routes defined in `internal/server/routes.go` are: - `GET /health` - `GET /api/v1/status` - `GET /metrics` (conditional on MetricsUsername being set) Requests to `/api/v1/domains` or `/api/v1/hostnames` return 404. ## Impact Users who read the README and try to use these endpoints will get 404s with no useful error message. ## Recommendation Either: 1. Implement the endpoints (preferred — they would be useful for operational visibility), or 2. Remove them from the README ## Category Should-fix before 1.0. The README is the primary documentation and must be accurate.
clawbot self-assigned this 2026-03-02 00:56:37 +01:00
sneak closed this issue 2026-03-02 08:40:43 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
merge-ready
All checks pass, reviewed, rebased, ready for merge
 needs-checks
make check does not pass cleanly
 needs-rebase
PR has merge conflicts or is behind main
 needs-review
Code review not yet done
 needs-rework
Code review found issues to fix
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees clawbot
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/dnswatcher#67