skills.rest
yu-iskw
yu-iskwCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

sync-openapi-types

Regenerate Lightdash API TypeScript types from swagger.json and verify the monorepo.

1|Updated Feb 10, 2026
Search Tags:#typescript#testing#openapi#code generation#monorepo#api types
One-click install
npx skills add https://github.com/yu-iskw/lightdash-tools --skill sync-openapi-types
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sync-openapi-types
Source: https://github.com/yu-iskw/lightdash-tools/tree/main/.claude/skills/sync-openapi-types
Command: npx skills add https://github.com/yu-iskw/lightdash-tools --skill sync-openapi-types

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that the TypeScript types used in the Lightdash tools accurately reflect the latest changes in the Lightdash API, preventing build failures and runtime errors caused by API mismatches.

Core Features & Use Cases

  • Automatic Type Regeneration: Fetches the latest OpenAPI specification and regenerates TypeScript types.
  • Monorepo Build Verification: Runs a full monorepo build to catch breaking API changes.
  • Test Suite Execution: Executes the test suite to ensure no regressions were introduced.
  • Use Case: When a new version of Lightdash is released, use this Skill to update the generated API types and confirm that all Lightdash tools still compile and pass their tests.

Quick Start

Run the sync-openapi-types skill to update the generated API types and verify the monorepo.

Frequently Asked Questions about sync-openapi-types

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

FAQPage Schema
How do I regenerate TypeScript types from an OpenAPI swagger.json file?▼

To regenerate TypeScript types from an OpenAPI swagger.json file, use this Skill to fetch the latest API specification, update the generated type definitions, and verify monorepo integrity through building and testing. It requires pnpm for script execution and type generation.

Why do I get type errors after an API version change in my monorepo?▼

Type errors after an API version change occur when generated type files become stale. This Skill addresses endpoint discrepancies by regenerating TypeScript types from the upstream swagger.json definition and running a full monorepo build to catch breaking API changes.

Can I use pnpm to keep API types in sync with upstream OpenAPI changes?▼

Yes, you can use pnpm to keep API types in sync with upstream OpenAPI changes. This Skill requires pnpm for script execution to fetch the latest specification, regenerate TypeScript types, and execute the test suite to ensure no regressions were introduced.

What's the best way to verify monorepo integrity after updating generated API types?▼

The best way to verify monorepo integrity after updating generated API types is to run a full monorepo build and execute the test suite. This Skill ensures TypeScript types accurately reflect the latest API changes, preventing build failures and runtime errors caused by API mismatches.

When do I need to sync OpenAPI types in a TypeScript project?▼

You need to sync OpenAPI types in a TypeScript project when a new version of an API is released, type errors indicate endpoint discrepancies, or generated type files become stale. This Skill updates the generated API types and confirms that all tools still compile and pass their tests.

Does sync-openapi-types work with Lightdash API specifications?▼

Yes, sync-openapi-types works with Lightdash API specifications. It regenerates TypeScript types specifically for the Lightdash API from its upstream swagger.json definition and verifies the monorepo's integrity to prevent build failures caused by API mismatches.

Related Skills

Explore More Software Engineering Skills→
baiciebaicie
2

pnpm

Manage Node.js dependencies and monorepo workspaces using pnpm.

Community
Advanced
mikkermikker
102

refactor-pass

Remove dead code and simplify logic while preserving build and test behavior.

Community
Intermediate
gil00pitagil00pita

openapi

Generate OpenAPI 3.1 specifications and TypeScript types from API definitions.

Community
Advanced
hjemmesidekongenhjemmesidekongen
1

openapi-typescript

Generate TypeScript types and clients from OpenAPI 3.x and Swagger 2.0 specifications.

Community
Advanced