Documentation
¶
Overview ¶
docvalidate.go implements the -validate-docs mode: it cross-checks the `doc/api/<area>.md` citations that justify the 1:1 adjudication tables against the live GitLab API reference docs (via internal/apidocs). The official API doc is the 1:1 ground truth, so a citation pointing at a doc that no longer exists (renamed/removed upstream) silently invalidates an adjudication — this gate surfaces it.
Command audit_1to1 is the consolidated 1:1 SDK↔API parity audit. It combines the three gap streams — struct field mapping (R-INPUT/R-OUTPUT), action coverage (R-ACTION), and discovery metadata (R-META) — behind a single -scope flag, and merges them in-process when all three run together.
Single-scope mode emits that auditor's native JSON shape (matching the legacy audit_struct_completeness / audit_action_coverage / audit_metadata_completeness binaries byte-for-byte). All-scopes mode produces the merged per-package backlog that gen_1to1_backlog previously generated from three separate files, via the same merge pipeline (byte-identical by construction).
Usage:
go run ./cmd/audit_1to1/ # merged backlog to stdout go run ./cmd/audit_1to1/ -gaps-only -output plan/1to1-backlog.json go run ./cmd/audit_1to1/ -scope=structs # struct report only go run ./cmd/audit_1to1/ -scope=actions -gaps-only go run ./cmd/audit_1to1/ -scope=metadata
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
actions
Package actions reports client-go SDK endpoints that no MCP action invokes (R-ACTION).
|
Package actions reports client-go SDK endpoints that no MCP action invokes (R-ACTION). |
|
merge
Package merge combines the three 1:1-audit gap reports — struct completeness (R-INPUT/R-OUTPUT), action coverage (R-ACTION), and metadata completeness (R-META) — into a single per-package backlog.
|
Package merge combines the three 1:1-audit gap reports — struct completeness (R-INPUT/R-OUTPUT), action coverage (R-ACTION), and metadata completeness (R-META) — into a single per-package backlog. |
|
metadata
Package metadata reports discovery-metadata gaps (R-META) across the canonical ActionSpec catalog.
|
Package metadata reports discovery-metadata gaps (R-META) across the canonical ActionSpec catalog. |
|
shared
Package shared holds constants and helpers used across multiple audit_1to1 sub-packages so they cannot drift.
|
Package shared holds constants and helpers used across multiple audit_1to1 sub-packages so they cannot drift. |
|
structs
Package structs verifies the 1:1 field mapping between the MCP tool input/output structs and the client-go SDK Options/result structs they wrap.
|
Package structs verifies the 1:1 field mapping between the MCP tool input/output structs and the client-go SDK Options/result structs they wrap. |