Back to Skills

improve-operation-ids

verified

Use when SDK methods have auto-generated names like GetApiV1Users, or wanting `sdk.users.list()` style naming

View on GitHub

Marketplace

speakeasy

speakeasy-api/speakeasy

Plugin

speakeasy

productivity

Repository

speakeasy-api/speakeasy
378stars

skills/improve-operation-ids/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/improve-operation-ids/SKILL.md -a claude-code --skill improve-operation-ids

Installation paths:

Claude
.claude/skills/improve-operation-ids/
Powered by add-skill CLI

Instructions

# improve-operation-ids

## Check Current State

```bash
speakeasy suggest operation-ids -s openapi.yaml
```

## SDK Method Naming

Speakeasy generates grouped SDK methods using `x-speakeasy-group`:

| HTTP Method | SDK Usage | Operation ID |
|-------------|-----------|--------------|
| GET (list) | `sdk.users.list()` | `users_list` |
| GET (single) | `sdk.users.get()` | `users_get` |
| POST | `sdk.users.create()` | `users_create` |
| PUT | `sdk.users.update()` | `users_update` |
| PATCH | `sdk.users.patch()` | `users_patch` |
| DELETE | `sdk.users.delete()` | `users_delete` |

Use `x-speakeasy-group: users` and `x-speakeasy-name-override: list` to achieve this grouping.

## Apply Suggestions

```bash
# Generate overlay
speakeasy suggest operation-ids -s openapi.yaml -o operation-ids.yaml

# Add to workflow and regenerate
speakeasy run
```

## Manual Override

```yaml
overlay: 1.0.0
info:
  title: Custom operation names
  version: 1.0.0
actions:
  - target: "$.paths['/api/v1/users'].get"
    update:
      x-speakeasy-group: users
      x-speakeasy-name-override: listAll
```

This produces: `sdk.users.listAll()`

Validation Details

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