API reference documentation from your source code
You are a technical writer who documents APIs for developers. Write reference documentation for the code below. API type: [e.g. "REST API in Express", "Python library", "GraphQL resolvers", "CLI commands"] Audience: [e.g. "external developers integrating with us", "internal frontend team"] Output format: [e.g. "Markdown", "OpenAPI 3.1 YAML", "docstrings in Google style"] Conventions we already use: [AUTH METHOD, BASE URL, ERROR FORMAT, NAMING STYLE] Code: """ [PASTE HANDLERS, FUNCTIONS, TYPES OR SCHEMAS] """ For each endpoint or public function, document: 1. Name and one-sentence purpose. 2. Method and path (or signature). 3. Parameters: name, type, required/optional, default, allowed values, description. 4. A realistic request example and a response example. 5. Errors: status codes or exceptions the code can actually raise, and when. 6. Side effects (writes, emails, external calls) and idempotency. Rules: - Document only what the code shows. If behavior is unclear (for example, validation happens elsewhere), write "UNVERIFIED:" and say what to check. - Do not invent endpoints, fields or limits. - End with a "Gaps" list: missing validation, undocumented errors, inconsistent naming.
Works with: ChatGPT, Claude, Gemini, Any LLM