implement-verified-lightdash-api-client

Implement verified Lightdash API client methods and models in Go.

16|5|Updated Jul 19, 2023
One-click install
npx skills add https://github.com/ubie-oss/terraform-provider-lightdash --skill implement-verified-lightdash-api-client
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: implement-verified-lightdash-api-client
Source: https://github.com/ubie-oss/terraform-provider-lightdash/tree/main/.claude/skills/implement-verified-lightdash-api-client
Command: npx skills add https://github.com/ubie-oss/terraform-provider-lightdash --skill implement-verified-lightdash-api-client

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This skill enables implementing a verified Lightdash API operation by researching the endpoint against the live API and producing a typed client, models, and supporting documentation.

Core Features & Use Cases

  • Research & verification: Validate the endpoint against the live Lightdash API schema before code generation.
  • Typed client & models: Generate Go client methods under internal/lightdash/api and corresponding models under internal/lightdash/models.
  • Testing scaffolding: Provide unit-test boilerplate to ensure correct JSON unmarshalling and request handling for the new operation.

Quick Start

Provide the HTTP method, API endpoint, function name, and an optional docs URL to auto-generate typed client code, models, and tests.

Frequently Asked Questions about implement-verified-lightdash-api-client

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

FAQPage Schema
How do I generate a typed Lightdash API client in Go?

Generating a Lightdash API client involves validating the endpoint against the live API schema first. This skill then produces typed Go client methods in internal/lightdash/api and corresponding models in internal/lightdash/models with unit-test scaffolding.

Why do I need to verify an API endpoint against a live schema before generating models?

Verifying an API endpoint against a live schema before generating models ensures the typed Go client accurately reflects the current Lightdash API. This prevents runtime errors by validating inputs and correctly handling the envelope response during code generation.

How do I structure Go models and unit tests for a Lightdash API operation?

Structuring Go models and unit tests for a Lightdash API operation involves placing models in internal/lightdash/models and client methods in internal/lightdash/api. The skill provides unit-test boilerplate to verify correct JSON unmarshalling and request handling.

Does this Lightdash API client generator handle envelope responses and path formatting?

Yes, the Lightdash API client generator handles envelope responses and path formatting. It validates inputs, constructs requests with proper path formatting, and manages the envelope response during the typed Go client generation process.

What inputs do I need to provide to implement a verified Lightdash API operation?

To implement a verified Lightdash API operation, you provide the HTTP method, API endpoint, function name, and an optional docs URL. These inputs trigger live schema research and typed Go code generation with testing scaffolding.