hap-api-doc-updater

Community

Keep HAP API docs in bilingual sync.

Authorgarfield-bb
Version1.0.0
Installs0

System Documentation

What problem does it solve?

HAP API documentation frequently diverges between English and Chinese versions as APIs evolve. This Skill provides a disciplined workflow to maintain, update, and synchronize OpenAPI 3.0 docs for both organization-level (en/zh-Hans) and application-level documentation.

Core Features & Use Cases

  • Synchronizes bilingual OpenAPI docs (organization and application scopes) to keep en/zh-Hans in sync.
  • Supports adding, updating, and deleting API endpoints with consistent descriptions, parameters, and schemas.
  • Enables automated propagation of changes across language versions and ensures structural parity.

Quick Start

Example: run hap-api-doc-updater to reconcile changes in en/openapi.yaml and zh-Hans/openapi.yaml, then review diffs and commit updated docs.

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: hap-api-doc-updater
Download link: https://github.com/garfield-bb/hap-skills-collection/archive/main.zip#hap-api-doc-updater

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.