|
| 1 | +#!/usr/bin/env python3 |
| 2 | +"""Generate docs/api-coverage.md from the pinned OpenAPI spec and CLI mapping. |
| 3 | +
|
| 4 | +Run from the repo root: |
| 5 | + uv run python scripts/gen_api_coverage.py |
| 6 | +""" |
| 7 | + |
| 8 | +from __future__ import annotations |
| 9 | + |
| 10 | +import json |
| 11 | +import sys |
| 12 | +from pathlib import Path |
| 13 | + |
| 14 | +REPO_ROOT = Path(__file__).parent.parent |
| 15 | +SPEC_PATH = REPO_ROOT / "tests" / "fixtures" / "openapi.json" |
| 16 | +OUT_PATH = REPO_ROOT / "docs" / "api-coverage.md" |
| 17 | + |
| 18 | +# Full endpoint → CLI command mapping (extends contract test map with mutations) |
| 19 | +ENDPOINT_TO_COMMAND: dict[tuple[str, str], tuple[str, ...]] = { |
| 20 | + # ACME (v1) |
| 21 | + ("GET", "/api/v1/acme/{zone}"): ("acme", "zone-exists"), |
| 22 | + ("GET", "/api/v1/acme/zones/{zone}/rrsets"): ("acme", "list-challenges"), |
| 23 | + ("PATCH", "/api/v1/acme/zones/{zone}/rrsets"): ("acme", "add-challenge / remove-challenge"), |
| 24 | + # Messages |
| 25 | + ("GET", "/api/v2/messages"): ("messages", "poll"), |
| 26 | + ("GET", "/api/v2/messages/list"): ("messages", "list"), |
| 27 | + ("DELETE", "/api/v2/messages/{id}"): ("messages", "ack"), |
| 28 | + # Reports |
| 29 | + ("GET", "/api/v2/reports/accounting"): ("report", "accounting"), |
| 30 | + ("GET", "/api/v2/reports/domainlist"): ("report", "domainlist"), |
| 31 | + ("GET", "/api/v2/reports/nxdomains"): ("report", "nxdomains"), |
| 32 | + ("GET", "/api/v2/reports/problematiczones"): ("report", "problematic-zones"), |
| 33 | + ("GET", "/api/v2/reports/queryrates"): ("report", "queryrates"), |
| 34 | + # Settings |
| 35 | + ("GET", "/api/v2/settings"): ("settings", "show"), |
| 36 | + ("PUT", "/api/v2/settings/secondaries"): ("settings", "secondaries", "set"), |
| 37 | + ("DELETE", "/api/v2/settings/secondaries"): ("settings", "secondaries", "unset"), |
| 38 | + ("PUT", "/api/v2/settings/tsig/in"): ("settings", "tsig-in", "set"), |
| 39 | + ("DELETE", "/api/v2/settings/tsig/in"): ("settings", "tsig-in", "unset"), |
| 40 | + ("PUT", "/api/v2/settings/tsig/out"): ("settings", "tsig-out", "set"), |
| 41 | + ("DELETE", "/api/v2/settings/tsig/out"): ("settings", "tsig-out", "unset"), |
| 42 | + ("PUT", "/api/v2/settings/tsigout"): ("[DEPRECATED — no CLI command]",), |
| 43 | + ("DELETE", "/api/v2/settings/tsigout"): ("[DEPRECATED — no CLI command]",), |
| 44 | + # Stats |
| 45 | + ("GET", "/api/v2/stats/countries"): ("stats", "countries"), |
| 46 | + ("GET", "/api/v2/stats/querycounts"): ("stats", "queries"), |
| 47 | + ("GET", "/api/v2/stats/topmagnitude"): ("stats", "topmagnitude"), |
| 48 | + ("GET", "/api/v2/stats/topnxdomains"): ("stats", "topnxdomains"), |
| 49 | + ("GET", "/api/v2/stats/topqnames"): ("stats", "topqnames"), |
| 50 | + ("GET", "/api/v2/stats/topzones"): ("stats", "topzones"), |
| 51 | + # TSIG |
| 52 | + ("GET", "/api/v2/tsig"): ("tsig", "list"), |
| 53 | + ("POST", "/api/v2/tsig"): ("tsig", "add"), |
| 54 | + ("GET", "/api/v2/tsig/out"): ("tsig", "list-out"), |
| 55 | + ("POST", "/api/v2/tsig/out"): ("[DEPRECATED — no CLI command]",), |
| 56 | + ("PUT", "/api/v2/tsig/out/{keyname}"): ("[DEPRECATED — no CLI command]",), |
| 57 | + ("DELETE", "/api/v2/tsig/out/{keyname}"): ("[DEPRECATED — no CLI command]",), |
| 58 | + ("GET", "/api/v2/tsig/{keyname}"): ("tsig", "show"), |
| 59 | + ("PUT", "/api/v2/tsig/{keyname}"): ("tsig", "update"), |
| 60 | + ("DELETE", "/api/v2/tsig/{keyname}"): ("tsig", "delete"), |
| 61 | + # Zones |
| 62 | + ("GET", "/api/v2/zones"): ("zone", "list"), |
| 63 | + ("POST", "/api/v2/zones"): ("zone", "create"), |
| 64 | + ("GET", "/api/v2/zones/{zone}"): ("zone", "show"), |
| 65 | + ("PUT", "/api/v2/zones/{zone}"): ("zone", "update"), |
| 66 | + ("PATCH", "/api/v2/zones/{zone}"): ("zone", "enable / disable"), |
| 67 | + ("DELETE", "/api/v2/zones/{zone}"): ("zone", "delete"), |
| 68 | + ("GET", "/api/v2/zones/{zone}/inbound"): ("zone", "xfr-in", "show"), |
| 69 | + ("POST", "/api/v2/zones/{zone}/inbound"): ("zone", "xfr-in", "set"), |
| 70 | + ("DELETE", "/api/v2/zones/{zone}/inbound"): ("zone", "xfr-in", "unset"), |
| 71 | + ("POST", "/api/v2/zones/{zone}/keyrollover"): ("dnssec", "keyrollover"), |
| 72 | + ("GET", "/api/v2/zones/{zone}/outbound"): ("zone", "xfr-out", "show"), |
| 73 | + ("POST", "/api/v2/zones/{zone}/outbound"): ("zone", "xfr-out", "set"), |
| 74 | + ("DELETE", "/api/v2/zones/{zone}/outbound"): ("zone", "xfr-out", "unset"), |
| 75 | + ("GET", "/api/v2/zones/{zone}/rrsets"): ("record", "list"), |
| 76 | + ("PATCH", "/api/v2/zones/{zone}/rrsets"): ("record", "add / update / delete / apply"), |
| 77 | + ("PUT", "/api/v2/zones/{zone}/rrsets"): ("record", "replace-all"), |
| 78 | + ("DELETE", "/api/v2/zones/{zone}/rrsets"): ("record", "clear"), |
| 79 | + ("POST", "/api/v2/zones/{zone}/retrieve"): ("zone", "retrieve"), |
| 80 | + ("POST", "/api/v2/zones/{zone}/sign"): ("dnssec", "sign"), |
| 81 | + ("GET", "/api/v2/zones/{zone}/simulate/dsremoved"): ("dnssec", "simulate", "dsremoved"), |
| 82 | + ("POST", "/api/v2/zones/{zone}/simulate/dsremoved"): ("dnssec", "simulate", "dsremoved"), |
| 83 | + ("GET", "/api/v2/zones/{zone}/simulate/dsseen"): ("dnssec", "simulate", "dsseen"), |
| 84 | + ("POST", "/api/v2/zones/{zone}/simulate/dsseen"): ("dnssec", "simulate", "dsseen"), |
| 85 | + ("GET", "/api/v2/zones/{zone}/stats/magnitude"): ("stats", "zone", "magnitude"), |
| 86 | + ("GET", "/api/v2/zones/{zone}/stats/nxdomains"): ("stats", "zone", "nxdomains"), |
| 87 | + ("GET", "/api/v2/zones/{zone}/stats/qnames"): ("stats", "zone", "qnames"), |
| 88 | + ("GET", "/api/v2/zones/{zone}/stats/queries"): ("stats", "zone", "queries"), |
| 89 | + ("GET", "/api/v2/zones/{zone}/status"): ("zone", "status"), |
| 90 | + ("POST", "/api/v2/zones/{zone}/unsign"): ("dnssec", "unsign"), |
| 91 | + ("POST", "/api/v2/zones/{zone}/dsupdate"): ("dnssec", "ack-ds"), |
| 92 | +} |
| 93 | + |
| 94 | + |
| 95 | +def main() -> int: |
| 96 | + spec = json.loads(SPEC_PATH.read_text(encoding="utf-8")) |
| 97 | + spec_version = spec.get("info", {}).get("version", "unknown") |
| 98 | + |
| 99 | + rows: list[tuple[str, str, bool, str, str]] = [] # (method, path, deprecated, command, status) |
| 100 | + unmapped: list[tuple[str, str]] = [] |
| 101 | + |
| 102 | + method_order = {"get": 0, "post": 1, "put": 2, "patch": 3, "delete": 4} |
| 103 | + |
| 104 | + for path, path_item in sorted(spec["paths"].items()): |
| 105 | + for method in sorted(path_item.keys(), key=lambda m: method_order.get(m, 99)): |
| 106 | + if method not in method_order: |
| 107 | + continue |
| 108 | + op = path_item[method] |
| 109 | + deprecated = op.get("deprecated", False) |
| 110 | + key = (method.upper(), path) |
| 111 | + cmd = ENDPOINT_TO_COMMAND.get(key) |
| 112 | + if cmd is None: |
| 113 | + unmapped.append(key) |
| 114 | + rows.append((method.upper(), path, deprecated, "", "❌")) |
| 115 | + elif cmd[0].startswith("[DEPRECATED"): |
| 116 | + rows.append((method.upper(), path, deprecated, cmd[0], "⚠️")) |
| 117 | + else: |
| 118 | + cmd_str = "rc0 " + " ".join(cmd) |
| 119 | + rows.append((method.upper(), path, deprecated, cmd_str, "✅")) |
| 120 | + |
| 121 | + lines: list[str] = [ |
| 122 | + "# API Coverage", |
| 123 | + "", |
| 124 | + f"Generated from pinned OpenAPI spec v{spec_version}.", |
| 125 | + "", |
| 126 | + "| Status | Method | Endpoint | CLI Command | Notes |", |
| 127 | + "|--------|--------|----------|-------------|-------|", |
| 128 | + ] |
| 129 | + for method, path, deprecated, cmd, status in rows: |
| 130 | + dep_note = "[DEPRECATED]" if deprecated else "" |
| 131 | + lines.append(f"| {status} | `{method}` | `{path}` | `{cmd}` | {dep_note} |") |
| 132 | + |
| 133 | + if unmapped: |
| 134 | + lines += ["", "## Unmapped endpoints", ""] |
| 135 | + for method, path in unmapped: |
| 136 | + lines.append(f"- `{method} {path}`") |
| 137 | + |
| 138 | + lines.append("") |
| 139 | + OUT_PATH.write_text("\n".join(lines), encoding="utf-8") |
| 140 | + mapped = sum(1 for r in rows if r[4] == "✅") |
| 141 | + total = len(rows) |
| 142 | + print(f"Generated {OUT_PATH} — {mapped}/{total} endpoints mapped.") |
| 143 | + if unmapped: |
| 144 | + print(f"WARNING: {len(unmapped)} unmapped endpoints:", file=sys.stderr) |
| 145 | + for m, p in unmapped: |
| 146 | + print(f" {m} {p}", file=sys.stderr) |
| 147 | + return 1 |
| 148 | + return 0 |
| 149 | + |
| 150 | + |
| 151 | +if __name__ == "__main__": |
| 152 | + sys.exit(main()) |
0 commit comments