Does this skill modify my original OpenAPI file?

It can generate an overlay file, allowing you to improve naming and metadata without directly altering your core source specification.

Do I need a Speakeasy API key to use this?

A Speakeasy API key is required for authentication when running in non-interactive environments like CI/CD or AI agent workflows.

What is the benefit of improving operation IDs?

It transforms generic, auto-generated method names like 'GetApiV1Users' into clean, idiomatic code like 'sdk.users.list()', making your SDK much easier to use.

Can I manually control the naming output?

Yes, you can use x-speakeasy-name-override and x-speakeasy-group tags to precisely define your SDK's method structure and grouping.

Speakeasy SDK Method Naming

Name: Speakeasy SDK Method Naming
Author: speakeasy-api

byspeakeasy-api

•

378

API Development

Optimizes OpenAPI operation IDs to generate clean, idiomatic SDK methods like sdk.users.list() instead of generic endpoints.

About

The improve-operation-ids skill enhances the ergonomics of Speakeasy-generated SDKs by automating the refinement of OpenAPI operation IDs. It identifies poorly named endpoints and suggests intuitive, grouped naming conventions using x-speakeasy-group and x-speakeasy-name-override extensions. By applying these suggestions via overlays or direct specification updates, developers can ensure their generated client libraries provide a polished, type-safe developer experience that follows industry-standard patterns for resource-based method calls.

Key Features

378 GitHub stars
Seamless integration with the Speakeasy CLI workflow
Generation of OpenAPI overlays for non-destructive spec improvements
Automated suggestion of idiomatic operation IDs for OpenAPI specs
Manual naming overrides for precise SDK method control
Support for resource grouping using x-speakeasy-group

Use Cases

Organizing flat API structures into logical resource groups like users, orders, and products
Refactoring legacy OpenAPI specs to produce modern, readable client libraries
Standardizing method naming conventions across diverse API endpoints

About

Key Features

378 GitHub stars
Seamless integration with the Speakeasy CLI workflow
Generation of OpenAPI overlays for non-destructive spec improvements
Automated suggestion of idiomatic operation IDs for OpenAPI specs
Manual naming overrides for precise SDK method control
Support for resource grouping using x-speakeasy-group

Use Cases

Organizing flat API structures into logical resource groups like users, orders, and products
Refactoring legacy OpenAPI specs to produce modern, readable client libraries
Standardizing method naming conventions across diverse API endpoints