openapi-sync-workflow
OfficialCoordinate per-file OpenAPI syncs to docs.
AuthorDomoApps
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Automates and coordinates the per-file OpenAPI YAML synchronization from internal sources into the docs surface, ensuring navigation stays in sync with updated specs and avoiding broken references.
Core Features & Use Cases
- Automated YAML detection and per-file PRs: Detects YAML changes, creates or updates a dedicated PR per changed file, and keeps the docs.json nav in sync.
- Nav synchronization: Invokes the external documentation generator action to update docs navigation for each changed spec.
- Stale entry cleanup: Prunes nav entries for removed or renamed specs to avoid broken previews.
- Use Case: A team updates internal APIs; the action pushes changes to openapi/product and updates docs.json with minimal manual intervention, enabling fast review and preview generation.
Quick Start
Run the openapi-sync-workflow process to align the docs navigation with updated internal OpenAPI YAML specs.
Dependency Matrix
Required Modules
None requiredComponents
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: openapi-sync-workflow Download link: https://github.com/DomoApps/domo-documentation-hub/archive/main.zip#openapi-sync-workflow Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.