api-documentation-auditlisted

Audits a repository's OpenAPI documentation against spec/project/api-documentation/ and produces a severity-classified audit artifact. Dispatches the read-only api-documentation-scanner agent to discover every OpenAPI document (checked in at a conventional location or exportable via a documented command), then classifies findings on the Critical/Warning/Suggestion/Info ladder — presence and 3.x version floor, info completeness, per-operation contract (operationId, tags, summary, parameters, request bodies), response and schema hygiene, security documentation, and the lint/drift wiring. An HTTP-API repo with no discoverable document is the report's most severe finding; the audit continues, never aborts. Invoke to audit API documentation, check an OpenAPI document for completeness, or run an API-docs gate; also German. Don't use for error-response conformance (api-error-check) or general code review (source-code-review). Supports resume.
nolte/claude-shared · ★ 0 · Data & Documents · score 74

Install: claude install-skill nolte/claude-shared

# API Documentation Audit Audit a repository's OpenAPI documentation against the portfolio contract and produce a single severity-classified audit artifact. The audit is **advisory**: it reports and recommends; it never edits the OpenAPI document, the code, or the CI wiring — remediation is documentation work the operator owns. Implements `spec/project/api-documentation/` — the spec defines the document-presence and format rules, the info-completeness floor, the per-operation contract, response and schema hygiene, the security-documentation rules, the lint-gate and drift SHOULDs, and the audit behaviour (no-document handling, per-document reporting). This skill binds those rules to the on-disk procedure and owns policy, severity, and the report. Severity vocabulary comes from `spec/claude/review-plan/` §Severity scale. ## German trigger phrases This skill also triggers on equivalent German-language requests, including: - "API-Dokumentation auditieren" / "OpenAPI-Doku prüfen" - "OpenAPI-Spec auf Vollständigkeit prüfen" - "Ist die API vollständig dokumentiert?" ## User-language policy Detect the user's language from their message and respond in it. The audit artifact uses English section headings (so downstream tooling can parse it reliably); prose around the report is localised. ## Inputs - **Repo root**: default is the current working directory. - **Document scope** (optional): an explicit OpenAPI document path or list to narrow the audit. Default: the scanner discov