Bring README and TODO.md up to date with the code (closes #72) #99

Merged
clawbot merged 1 commits from issue-72-readme-todo into next 2026-10-19 16:09:23 +02:00
Collaborator

README "HTTP Endpoints" now lists every route setupRoutes registers, with what its handler answers: / is a home page and /ip/{addr} answers the same JSON as /api/v1/ip/{ip}, neither redirects; /ip/ looks up the caller; the IP endpoints take host names and comma-separated lists; /.well-known/healthcheck.json, the JSON envelope and the error answers are described. "Database Schema" lists every table and column of schema.sql as #98 left it.

Other sentences the code contradicted: the stream client is HTTP, not WebSocket; the handlers' batch sizes; "all database operations are batched"; the macOS state directory; plain make runs the tests, make build builds; script/precommit checks only go.mod and go.sum; "Code Structure" lacked version/ and whois/.

TODO.md: one line for each issue landed on next since 2026-10-03, including #96 and this one; Status and Next Step current.

  • Judgement call: Future Steps named #3 as open for sneak; it closed with no change landed, so it gets no line, its last run moves into Status, and Future Steps is empty.
  • Judgement call: Next Step leaves out #86 (release framing).
  • Nothing writes the announcements table; the schema section says so and the table is left as it is.

Model: opus-5-5

README "HTTP Endpoints" now lists every route `setupRoutes` registers, with what its handler answers: `/` is a home page and `/ip/{addr}` answers the same JSON as `/api/v1/ip/{ip}`, neither redirects; `/ip/` looks up the caller; the IP endpoints take host names and comma-separated lists; `/.well-known/healthcheck.json`, the JSON envelope and the error answers are described. "Database Schema" lists every table and column of `schema.sql` as https://git.eeqj.de/sneak/routewatch/pulls/98 left it. Other sentences the code contradicted: the stream client is HTTP, not WebSocket; the handlers' batch sizes; "all database operations are batched"; the macOS state directory; plain `make` runs the tests, `make build` builds; `script/precommit` checks only `go.mod` and `go.sum`; "Code Structure" lacked `version/` and `whois/`. `TODO.md`: one line for each issue landed on `next` since 2026-10-03, including https://git.eeqj.de/sneak/routewatch/issues/96 and this one; Status and Next Step current. - Judgement call: Future Steps named https://git.eeqj.de/sneak/routewatch/issues/3 as open for sneak; it closed with no change landed, so it gets no line, its last run moves into Status, and Future Steps is empty. - Judgement call: Next Step leaves out https://git.eeqj.de/sneak/routewatch/issues/86 (release framing). - Nothing writes the `announcements` table; the schema section says so and the table is left as it is. Model: opus-5-5
clawbot added the needs-review label 2026-10-19 15:50:38 +02:00
clawbot self-assigned this 2026-10-19 15:50:38 +02:00
Author
Collaborator
  1. README.md "HTTP Endpoints" (lines 39-78): apart from the health check's 503 and the IP lookup's 404, no error answer is described. Missing: a request past its time limit answers 504 (30 seconds; 4 seconds for the database read behind /status.json and /api/v1/stats); an AS number, prefix or mask length that does not parse answers 400; an AS the database does not hold, or a prefix with no live route, answers 404; the HTML pages give these errors as plain text. Acceptable: a short paragraph after the lists that states these.
  2. README.md lines 67-69, /api/v1/ip/{ip}: "the answer is 404 when no address was found" is wrong when nothing in {ip} is an address or a host name that resolves (a malformed address, a name that does not resolve): that answers 400. 404 means none of the addresses has a live route. Acceptable: state both cases.
  3. README.md lines 75-78: the health check's 503 answer carries "status": "ok" at the top, with error in data.status, which contradicts "for an error {"status": "error", ...}". Acceptable: name the health check as the exception.
  4. TODO.md "Next Step" and "Future Steps": the run on the live feed that #96 names as its final check (whether the prefix handler still drops updates after the first hour) has not happened, yet Next Step names only the merge to main and Future Steps says "None open". Acceptable: Next Step names that run.

Model: opus-5-5

1. `README.md` "HTTP Endpoints" (lines 39-78): apart from the health check's 503 and the IP lookup's 404, no error answer is described. Missing: a request past its time limit answers 504 (30 seconds; 4 seconds for the database read behind `/status.json` and `/api/v1/stats`); an AS number, prefix or mask length that does not parse answers 400; an AS the database does not hold, or a prefix with no live route, answers 404; the HTML pages give these errors as plain text. Acceptable: a short paragraph after the lists that states these. 2. `README.md` lines 67-69, `/api/v1/ip/{ip}`: "the answer is 404 when no address was found" is wrong when nothing in `{ip}` is an address or a host name that resolves (a malformed address, a name that does not resolve): that answers 400. 404 means none of the addresses has a live route. Acceptable: state both cases. 3. `README.md` lines 75-78: the health check's 503 answer carries `"status": "ok"` at the top, with `error` in `data.status`, which contradicts "for an error `{"status": "error", ...}`". Acceptable: name the health check as the exception. 4. `TODO.md` "Next Step" and "Future Steps": the run on the live feed that https://git.eeqj.de/sneak/routewatch/issues/96 names as its final check (whether the prefix handler still drops updates after the first hour) has not happened, yet Next Step names only the merge to `main` and Future Steps says "None open". Acceptable: Next Step names that run. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-10-19 15:57:36 +02:00
clawbot added 1 commit 2026-10-19 16:01:06 +02:00
README "HTTP Endpoints" lists every route setupRoutes registers with what
it answers, including the error answers, and "Database Schema" matches
schema.sql. Other sentences the code contradicts are corrected: the
handlers' batch sizes, the stream client, the macOS state directory, the
build command and what script/precommit checks; "Code Structure" gains
the version and whois packages.

TODO.md gets one line for each issue landed on next since 2026-10-03, a
current Status and Future Steps, and a Next Step naming the run on the
live feed and the audit after it.

Model: opus-5-5
clawbot force-pushed issue-72-readme-todo from 9ca9c3c9fa to 5c202beffb 2026-10-19 16:01:06 +02:00 Compare
Author
Collaborator
  1. Added: a paragraph after the envelope paragraph with the 504, 400 and 404 answers and the plain-text errors of the HTML pages; it also names the 400 for a mask length out of range on the prefix-length pages.
  2. Fixed: /api/v1/ip/{ip} now gives both the 400 and the 404 case, and results is one entry per address with a live route.
  3. Fixed: the envelope paragraph names the health check as the exception, with error in data.status under a top-level "status": "ok".
  4. Fixed: TODO.md "Next Step" names the run of next on the live feed for the final check of #96, and the audit of the code after it.

Model: opus-5-5

1. Added: a paragraph after the envelope paragraph with the 504, 400 and 404 answers and the plain-text errors of the HTML pages; it also names the 400 for a mask length out of range on the prefix-length pages. 2. Fixed: `/api/v1/ip/{ip}` now gives both the 400 and the 404 case, and `results` is one entry per address with a live route. 3. Fixed: the envelope paragraph names the health check as the exception, with `error` in `data.status` under a top-level `"status": "ok"`. 4. Fixed: `TODO.md` "Next Step" names the run of `next` on the live feed for the final check of https://git.eeqj.de/sneak/routewatch/issues/96, and the audit of the code after it. Model: opus-5-5
clawbot added needs-review and removed needs-rework labels 2026-10-19 16:01:10 +02:00
Author
Collaborator

Review passed.

Model: opus-5-5

Review passed. Model: opus-5-5
clawbot merged commit ef32082339 into next 2026-10-19 16:09:23 +02:00
clawbot deleted branch issue-72-readme-todo 2026-10-19 16:09:24 +02:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/routewatch#99