openapi-review

Audit OpenAPI specs against control-plane handler implementations for semantic drift.

21|3|Updated May 26, 2026
One-click install
npx skills add https://github.com/AlphaBitCore/nexus-gateway --skill openapi-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-review
Source: https://github.com/AlphaBitCore/nexus-gateway/tree/main/.claude/skills/openapi-review
Command: npx skills add https://github.com/AlphaBitCore/nexus-gateway --skill openapi-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit and enrich generated OpenAPI specs by verifying each claim against the corresponding control-plane handlers, ensuring semantic accuracy in descriptions, examples, and enum sets.

Core Features & Use Cases

  • Semantic audit of paths, HTTP verbs, request/response fields, and status codes against the handler logic.
  • Enrichment of operation summaries, per-field descriptions, valid enum values, and concrete examples, while preserving generator structure and code-derived extensions.
  • Use cases include pre-commit checks after regeneration and retroactive drift remediation to keep specs aligned with implementation.

Quick Start

Inspect a target OpenAPI file and trigger the semantic review to produce a richly described, code-grounded spec ready for commit.

Frequently Asked Questions about openapi-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit OpenAPI specs against handler implementation?

To audit OpenAPI specs against handlers, the Skill verifies paths, HTTP verbs, and status codes against control-plane handler logic to surface semantic drift and missing details. It ensures descriptions, examples, and enum sets accurately reflect handler validation behavior.

Why does my generated OpenAPI documentation have semantic drift from the code?

Generated OpenAPI documentation experiences semantic drift when operation summaries and field descriptions are not derived from the actual handler code. Auditing the spec against control-plane handlers derives precise descriptions, required fields, and examples directly from implementation logic.

Can I enrich OpenAPI descriptions and examples from control-plane handler code?

Yes, you can enrich OpenAPI descriptions and examples from control-plane handler code. The Skill derives precise operation summaries, per-field descriptions, valid enum values, and concrete examples directly from the handler logic while preserving generator structure and code-derived extensions.

What is the best way to keep OpenAPI specs aligned with handler validation?

The best way to keep OpenAPI specs aligned with handler validation is performing a semantic audit after regeneration. The Skill verifies request and response fields against handler logic, making it suitable for pre-commit checks and retroactive drift remediation to ensure continuous alignment.

Does the OpenAPI semantic audit preserve generator structure and code-derived extensions?

Yes, the OpenAPI semantic audit preserves generator structure and code-derived extensions. While the Skill enriches operations with precise summaries, field descriptions, valid enum sets, and examples derived from handler code, it maintains the original generator structure throughout the remediation process.