Skills
.Work. You
Rest

governing-spec-metadata

Official

Govern OpenAPI spec metadata for clarity and completeness.

Software Engineering#documentation#api design#openapi#specification#metadata#api governance
Authormusher-dev
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures that your OpenAPI specifications have complete, accurate, and discoverable metadata, preventing issues with SDK generation, documentation portals, and API catalog registration.

Core Features & Use Cases

  • Metadata Validation: Audits and enforces completeness of the info object, including title, summary, description, and version.
  • Version Management: Clarifies the distinction between openapi (grammar version) and info.version (API release version) and enforces best practices.
  • Server Configuration: Validates the servers array for accuracy and completeness, including descriptions and variable usage.
  • Organizational Extensions: Guides the use of x-api-id and x-audience for API identification and access control.
  • Documentation Linking: Ensures externalDocs points to relevant, live documentation.
  • Use Case: When reviewing a new OpenAPI specification, use this Skill to ensure all metadata fields are correctly populated, the API version is accurate, and the description is LLM-readable, making the API easier for developers and systems to understand and integrate with.

Quick Start

Use the governing-spec-metadata skill to review the OpenAPI specification metadata for completeness and accuracy.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 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: governing-spec-metadata
Download link: https://github.com/musher-dev/bundles/archive/main.zip#governing-spec-metadata

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 223,000+ vetted skills library on demand.