skills.rest
DomoApps
DomoAppsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

openapi-sync-workflow

Sync OpenAPI YAML spec changes into docs with per-file PRs.

7|2|Updated Jan 8, 2026
Search Tags:#automation#openapi#yaml#github-actions#ci-cd#pr-management#docs-nav
One-click install
npx skills add https://github.com/DomoApps/domo-documentation-hub --skill openapi-sync-workflow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-sync-workflow
Source: https://github.com/DomoApps/domo-documentation-hub/tree/main/.claude/skills/openapi-sync-workflow
Command: npx skills add https://github.com/DomoApps/domo-documentation-hub --skill openapi-sync-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about openapi-sync-workflow

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

FAQPage Schema
How do I automate OpenAPI YAML sync to docs navigation in CI/CD?▼

Automating OpenAPI YAML sync detects changed spec files using SHA-256 hashing, creates a dedicated PR per file, and updates docs.json navigation entries to keep documentation aligned with internal sources.

Why does my docs.json navigation break when I rename an OpenAPI spec?▼

Docs.json navigation breaks because renamed or removed OpenAPI specs leave stale nav entries. The sync workflow prunes these outdated references to prevent broken preview deployments.

What's the best way to create per-file pull requests for changed OpenAPI specs?▼

Creating per-file pull requests for changed OpenAPI specs is best handled by orchestrating a CI/CD workflow that detects YAML changes individually and opens an isolated PR for each modified file.

Does the openapi-sync-workflow require a GitHub App for cross-repo access?▼

Yes, the openapi-sync-workflow requires a GitHub App for cross-repo access to push per-file OpenAPI spec changes from internal sources into the docs product repository.

How does SHA-256 hashing detect YAML changes for OpenAPI documentation syncs?▼

SHA-256 hashing detects YAML changes by comparing file checksums between internal sources and the docs target, identifying exactly which OpenAPI specs require per-file synchronization and PR creation.

Related Skills

Explore More Software Engineering Skills→
fxckcodefxckcode

git-setup-skill

Automate Git/GitHub repository setup with baseline governance files and CI workflows.

Community
Advanced
akash-mondalakash-mondal

update-nav

Update docs.json navigation entries with validated relative file paths.

Community
Intermediate
jamesjlundinjamesjlundin
32

ci-fixer

Diagnose CI/CD pipeline failures from workflow logs and propose fixes.

Community
Advanced
mpsuessermpsuesser

mintlify

Convert MDX content into structured documentation sites with docs.json navigation.

Community
Basic