skills.rest
btabaska
btabaskaCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

OpenAPI Sync

Detect drift between OpenAPI specs and frontend TypeScript definitions.

1|1|Updated Mar 31, 2026
Search Tags:#openapi#codegen#drift#types#api-contract#frontend-types
One-click install
npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill openapi-sync-btabaska
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: OpenAPI Sync
Source: https://github.com/btabaska/simpler-grants-documentation-automation/tree/main/.cursor/skills/skill-openapi-sync
Command: npx skills add https://github.com/btabaska/simpler-grants-documentation-automation --skill openapi-sync-btabaska

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detect drift between the OpenAPI spec and frontend TypeScript clients, then guide regeneration to keep the surface in sync and reduce manual toil.

Core Features & Use Cases

  • Drift detection: compares api/openapi.generated.yml with frontend/types to identify added, removed, and changed endpoints and schemas.
  • Impact analysis: labels changes as ADDITIVE, BREAKING, or DOC and points to affected call sites and types.
  • Regeneration guidance: prints the exact commands to refresh frontend types and API contracts for a consistent codebase.

Quick Start

Run the regeneration command to align the OpenAPI spec with the frontend types.

Frequently Asked Questions about OpenAPI Sync

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

FAQPage Schema
How do I detect drift between my OpenAPI spec and frontend TypeScript types?▼

To detect OpenAPI drift, compare api/openapi.generated.yml with frontend/types to identify added, removed, or changed endpoints and schemas with precise citations. This drift detection highlights mismatches between your API contract and frontend type definitions.

How do I regenerate frontend types from an OpenAPI spec?▼

To regenerate frontend types from an OpenAPI spec, run the exact regeneration command provided by the drift analysis. This refreshes frontend types and API contracts to ensure your codebase remains consistent and aligned with the updated spec.

What is OpenAPI drift and how does it impact frontend API contracts?▼

OpenAPI drift occurs when your OpenAPI spec and frontend TypeScript types fall out of sync, causing mismatched API contracts. It impacts downstream teams by introducing breaking changes, missing endpoints, or schema differences that require manual toil to fix.

Can I get an impact analysis for breaking changes in my OpenAPI schema?▼

Yes, you can get an impact analysis for breaking changes in your OpenAPI schema. The analysis labels changes as ADDITIVE, BREAKING, or DOC, and points to affected call sites and types to assess downstream team impact.

What's the best way to keep OpenAPI specs and frontend types in sync?▼

The best way to keep OpenAPI specs and frontend types in sync is to detect schema and endpoint drift, then apply the exact regeneration command. This impact assessment reduces manual toil by keeping the API surface aligned.

Does OpenAPI drift detection work without external dependencies?▼

Yes, OpenAPI drift detection operates without external dependencies. It directly compares your api/openapi.generated.yml file and frontend type definitions to report added, removed, or changed schemas and endpoints natively.

Related Skills

Explore More Software Engineering Skills→
leto-labsleto-labs

twenty-crm

Automate Twenty CRM workflows via OpenAPI specs and metadata sync.

Official
Advanced
ESO-ToolkitESO-Toolkit
2

no-edit-generated

Prevent manual edits to GraphQL codegen files and enforce npm run codegen workflows.

Official
Basic
redpanda-dataredpanda-data
34

setup-quality-gate

Set up a quality gate with biome, tsgo, and vitest.

Official
Advanced
saschadudkin-sketchsaschadudkin-sketch

domhub-api-contracts

Coordinate OpenAPI schema, documentation, and frontend type updates for /api/v1/* routes.

Community
Advanced