manage-openapi-overlays

Create, apply and validate OpenAPI overlay files with JSONPath targeting for Speakeasy CLI workflows.

Updated Feb 28, 2026

Search Tags:#openapi #sdk generation #overlay #speakeasy #jsonpath #api customization

Ready to run

npx skills add https://github.com/CarlosEGuerraSilva/OpenRouterSDK.NET --skill manage-openapi-overlays-carloseguerrasilva

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: manage-openapi-overlays
Source: https://github.com/CarlosEGuerraSilva/OpenRouterSDK.NET/tree/main/.agents/skills/manage-openapi-overlays
Command: npx skills add https://github.com/CarlosEGuerraSilva/OpenRouterSDK.NET --skill manage-openapi-overlays-carloseguerrasilva

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the process of customizing OpenAPI specifications without directly editing the source files, enabling precise control over SDK generation.

Core Features & Use Cases

Overlay Creation & Application: Generate and apply custom overlay files to modify OpenAPI specs.
Targeted Customization: Use JSONPath to precisely target elements for updates or removals.
Use Case: Automatically apply naming conventions, grouping, and retry logic to an OpenAPI spec to ensure a consistent and robust SDK.

Quick Start

Use the manage-openapi-overlays skill to apply the overlay file 'sdk-overlay.yaml' to the spec 'openapi.yaml' and output to 'openapi-modified.yaml'.

Frequently Asked Questions about manage-openapi-overlays

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

FAQPage Schema

How do I customize an OpenAPI specification without modifying the original source file?▼

OpenAPI specification customization can be achieved using overlay files to apply targeted modifications via JSONPath. This approach ensures source files remain untouched while enabling precise control over SDK generation configurations.

What is an OpenAPI overlay and how does it work with JSONPath?▼

An OpenAPI overlay is a file that defines targeted updates or removals for an API specification using JSONPath. It works by matching specific elements in the document structure to apply changes like naming conventions, grouping, and security configurations.

How do I apply x-speakeasy extensions to an OpenAPI spec for SDK generation?▼

Applying x-speakeasy extensions for SDK generation involves creating an overlay file that targets the specification via JSONPath. This overlay defines customizations like retry logic and naming conventions, which are then applied to generate the modified spec.

Does Speakeasy CLI support applying overlays to OpenAPI files?▼

Yes, Speakeasy CLI supports overlay workflow automation and direct command execution. You can use it to apply an overlay file to an original specification and output the result to a newly modified OpenAPI document.

Can I use overlays to change security configurations and retry logic for SDK generation?▼

Yes, overlays can be used to change security configurations and retry logic for SDK generation. By targeting the relevant elements with JSONPath, the overlay file injects these customizations directly into the OpenAPI specification.

What is the best way to validate an OpenAPI overlay file before applying it?▼

The best way to validate an OpenAPI overlay file is to use a workflow automation tool like Speakeasy CLI. It facilitates overlay validation through direct command execution, ensuring your JSONPath targeting and x-speakeasy extensions are correctly structured.