diagnose-generation-failure

Categorize OpenAPI SDK generation failures and propose remediation steps.

1.8k|375|Updated Jan 15, 2025
One-click install
npx skills add https://github.com/trycompai/comp --skill diagnose-generation-failure-trycompai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: diagnose-generation-failure
Source: https://github.com/trycompai/comp/tree/main/.agents/skills/diagnose-generation-failure
Command: npx skills add https://github.com/trycompai/comp --skill diagnose-generation-failure-trycompai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

When SDK generation fails, diagnose the root cause and determine a fix strategy.

Core Features & Use Cases

  • Structured error analysis: categorize issues (overlay vs spec fix vs user decision) and identify root causes.
  • Actionable remediation: generate specific steps, including linting, reference validation, and recommended fixes for the OpenAPI spec.
  • Workflow guidance: provide a decision framework and troubleshooting path to recover SDK generation efficiently.

Quick Start

Describe the root cause of a failing SDK generation and propose a concrete fix strategy based on the provided OpenAPI spec and error output.

Frequently Asked Questions about diagnose-generation-failure

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

FAQPage Schema
Why does OpenAPI SDK generation fail and how do I diagnose the error?

OpenAPI SDK generation fails due to spec validation issues, invalid references, or linting errors. You can diagnose these generation failures by analyzing error outputs, categorizing root causes, and validating OpenAPI specification references to identify exact failure points.

How do I fix OpenAPI generation errors using overlays?

Fix OpenAPI generation errors by applying overlays to patch invalid references or linting issues without altering the original spec. This structured approach categorizes whether an overlay, spec fix, or user decision is required to resolve the generation failure.

What is the best way to troubleshoot OpenAPI spec validation issues?

The best way to troubleshoot OpenAPI spec validation issues is to follow a structured decision framework: analyze lint results, validate internal references, categorize the error type, and generate actionable remediation steps to repair the specification.

How do I resolve invalid reference errors during SDK generation?

Resolve invalid reference errors during SDK generation by validating OpenAPI spec references, analyzing the lint output to locate broken paths, and proposing concrete spec fixes or overlays to correct the structural definitions.

When should I use an overlay versus a direct spec fix for OpenAPI generation failures?

Use an overlay when you cannot modify the original OpenAPI spec directly, and use a spec fix when you own the definition. Diagnosing the generation failure helps categorize the issue to decide between an overlay, spec fix, or user decision.