hap-api-doc-updater

Synchronize English and Chinese OpenAPI 3.0 documentation across organization and application levels.

27|5|Updated Jan 13, 2026
One-click install
npx skills add https://github.com/garfield-bb/hap-skills-collection --skill hap-api-doc-updater
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: hap-api-doc-updater
Source: https://github.com/garfield-bb/hap-skills-collection/tree/main/.claude/skills/hap-api-doc-updater
Command: npx skills add https://github.com/garfield-bb/hap-skills-collection --skill hap-api-doc-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about hap-api-doc-updater

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

FAQPage Schema
How do I keep OpenAPI documentation in sync across English and Chinese versions?

To keep OpenAPI documentation in sync across English and Chinese versions, you apply a disciplined workflow that propagates endpoint additions, updates, and deletions to maintain bilingual parity.

What is the best way to update organization-level and application-level API endpoints bilingually?

The best way to update organization-level and application-level API endpoints bilingually is to enforce OpenAPI 3.0 structure and consistent file layouts while propagating changes across language versions.

Can I use this workflow to add and delete API endpoints while ensuring structural parity?

Yes, you can use this workflow to add and delete API endpoints while ensuring structural parity by enforcing OpenAPI 3.0 structure and updating paths, descriptions, and schemas consistently.

Does synchronizing bilingual OpenAPI docs require updating paths and schemas manually?

Synchronizing bilingual OpenAPI docs does not require updating paths and schemas manually across languages; the workflow automates propagation to ensure consistent descriptions, parameters, and schemas.

When do I need to reconcile changes between en/openapi.yaml and zh-Hans/openapi.yaml?

You need to reconcile changes between en/openapi.yaml and zh-Hans/openapi.yaml whenever APIs evolve and endpoint definitions diverge, requiring you to review diffs and commit updated docs to restore bilingual parity.