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

generate-openapi-types

Generate TypeScript types from the Lightdash OpenAPI specification.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill ensures that your TypeScript types accurately reflect the Lightdash API's structure, preventing integration issues and keeping your codebase in sync with the latest API changes.

Core Features & Use Cases

  • Type Generation: Automatically generates or refreshes TypeScript types from the Lightdash OpenAPI specification.
  • Codebase Synchronization: Keeps packages/common and dependent packages up-to-date with API definitions.
  • Use Case: When a new endpoint is added to the Lightdash API, use this Skill to regenerate the types so that the client library can immediately start using it.

Quick Start

Use the generate-openapi-types skill to update the TypeScript types from the Lightdash OpenAPI spec.

Frequently Asked Questions about generate-openapi-types

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

FAQPage Schema
How do I generate TypeScript types from an OpenAPI spec?▼

To generate TypeScript types from an OpenAPI spec, you run a specific npm script that utilizes openapi-typescript. This refreshes the generated type definitions file to accurately reflect the latest API structure.

When should I sync TypeScript types with an OpenAPI specification?▼

You should sync TypeScript types with an OpenAPI specification when upstream API changes occur, when implementing new client methods, or after adding new endpoints. This maintains synchronization and prevents integration issues.

Does openapi-typescript work with the Lightdash API?▼

Yes, openapi-typescript is used to generate or refresh TypeScript types from the Lightdash OpenAPI specification. It ensures packages like packages/common and dependent packages stay synchronized with the API definitions.

What is the best way to update TypeScript API client types after spec changes?▼

The best way to update TypeScript API client types after spec changes is to run an npm script that utilizes openapi-typescript. This regenerates the type definitions, allowing your client library to immediately use the updated API shapes.

Why do I need to regenerate TypeScript types for my API client?▼

You need to regenerate TypeScript types for your API client to prevent integration issues caused by outdated definitions. Regenerating ensures your codebase accurately reflects the Lightdash API structure and maintains synchronization with latest changes.

Related Skills

Explore More Software Engineering Skills→
theodrosyimertheodrosyimer

api-docs

Generate a browsable API documentation website from an OpenAPI specification.

Community
Advanced
CatOfJupit3rCatOfJupit3r
1

orpc-contract-creation

Define oRPC contracts with Zod schemas in packages/shared for server-client sync.

Community
Advanced
gil00pitagil00pita

openapi

Generate OpenAPI 3.1 specifications and TypeScript types from API definitions.

Community
Advanced
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced