Back to Skills

apply-openapi-overlay

verified

Use when applying an overlay file to a spec

View on GitHub

Marketplace

speakeasy

speakeasy-api/speakeasy

Plugin

speakeasy

productivity

Repository

speakeasy-api/speakeasy
378stars

skills/apply-openapi-overlay/SKILL.md

Last Verified

January 17, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/speakeasy-api/speakeasy/blob/main/skills/apply-openapi-overlay/SKILL.md -a claude-code --skill apply-openapi-overlay

Installation paths:

Claude
.claude/skills/apply-openapi-overlay/
Powered by add-skill CLI

Instructions

# apply-openapi-overlay

## Command

```bash
speakeasy overlay apply -s <spec-path> -o <overlay-path> --out <output-path>
```

## Example

```bash
# Apply overlay and output merged spec
speakeasy overlay apply -s openapi.yaml -o my-overlay.yaml --out openapi-modified.yaml
```

## Using in Workflow

Better approach - add overlay to workflow.yaml:

```yaml
sources:
  my-api:
    inputs:
      - location: ./openapi.yaml
    overlays:
      - location: ./naming-overlay.yaml
      - location: ./grouping-overlay.yaml
```

Overlays are applied in order, so later overlays can override earlier ones.

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
561 chars