Skills
.Work. You
Rest

openapi-spec-reviewer

Official

Audit and improve OpenAPI specs for docs.

Software Engineering#linting#openapi#developer experience#api documentation#specification review#oas3
Authorin-co-sandbox
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps ensure your OpenAPI specifications are clear, accurate, and function as high-quality documentation, making APIs easier to understand and use.

Core Features & Use Cases

  • OpenAPI Specification Auditing: Reviews OpenAPI (OAS 3.0/3.1) specifications for documentation quality.
  • Endpoint Documentation Improvement: Enhances operation summaries, descriptions, and examples.
  • Doc Quality Validation: Validates documentation quality for specific endpoints referenced in MDX files.
  • Severity-Ranked Reports: Produces concrete, actionable OpenAPI change recommendations.
  • Use Case: You have an openapi.json file and want to ensure all operation summaries and descriptions are clear, and that response schemas include examples. This Skill will analyze the spec and provide a report with specific suggestions.

Quick Start

Use the openapi-spec-reviewer skill to audit the OpenAPI specification file located at api-reference/gst/compliance/openapi.json for the POST /gst/compliance/e-way-bill/tax-payer/authenticate endpoint.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: openapi-spec-reviewer
Download link: https://github.com/in-co-sandbox/in-co-sandbox-docs/archive/main.zip#openapi-spec-reviewer

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.