Prep RoomSign inStart free
Code RoomVerify API docs completeness
MediumPrep Room Coding #4433

Verify API docs completeness

Vibe & agenticAlgorithms & data structuresMid–Senior~18 min

You ask an AI to generate REST API reference docs from a Go HTTP service by reading the handler code. It produces a polished doc with endpoints, request/response examples, and status codes. Before publishing it to your public developer portal, how do you verify the docs are both accurate AND complete — and what gaps does an AI reading handlers tend to miss?

Implement
doc_coverage_gaps(documented: list[str], actual: list[str]) → list[str]
Examples
in[["GET /users 200"],["GET /users 200","GET /users 401"]]out["missing:GET /users 401"]
in[["GET /users 200","POST /users 201"],["GET /users 200"]]out["invented:POST /users 201"]
in[[],[]]out[]
What a strong answer looks like

Treat the AI’s output as a draft to verify, not an answer to trust. Name the specific flaw and the input that triggers it, say how you’d catch it (tests, edge cases, reading critically), and how you’d re-prompt or decompose to get it right.

0:00 of about 18 min

Vibe & agentic: describe the solution in plain language (or narrate it) and the coach grades your approach.

Which questions mattered is sealed until you submit. Telling you now would just be handing over the edge cases.