skills.rest
musher-dev
musher-devOFFICIAL
Explore all skills by this author →
WebsiteGitHub

governing-operation-identifiers

Governs OpenAPI operation and component identifiers enforcing naming conventions for SDK generation.

Updated Mar 6, 2026
Search Tags:#code quality#api design#openapi#governance#naming conventions#sdk generation
One-click install
npx skills add https://github.com/musher-dev/bundles --skill governing-operation-identifiers
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: governing-operation-identifiers
Source: https://github.com/musher-dev/bundles/tree/main/openapi-specification-governance/skills/governing-operation-identifiers
Command: npx skills add https://github.com/musher-dev/bundles --skill governing-operation-identifiers

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the critical issue of inconsistent and poorly named identifiers within OpenAPI specifications, which directly leads to confusing and error-prone generated SDKs.

Core Features & Use Cases

  • Enforce Naming Conventions: Ensures operationId, schema keys, and parameter names adhere to established best practices (e.g., camelCase, UpperCamelCase, snake_case).
  • Promote Uniqueness: Guarantees that operationIds are unique across the entire specification to prevent compilation errors in generated code.
  • Optimize for SDK Generation: Aligns identifier choices with common SDK generator expectations for idiomatic and readable code across various programming languages.
  • Use Case: When reviewing a new OpenAPI specification, use this Skill to audit all operationIds for verb-noun consistency and uniqueness, and to verify that schema names like ProjectResponse follow UpperCamelCase.

Quick Start

Use the governing-operation-identifiers skill to audit the operationIds in the attached openapi.yaml file for camelCase verbNoun convention and uniqueness.

Frequently Asked Questions about governing-operation-identifiers

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

FAQPage Schema
How do I enforce naming conventions for OpenAPI operationId and schema keys?▼

You can enforce OpenAPI naming conventions by auditing operationId values for camelCase verbNoun patterns and verifying schema keys use UpperCamelCase, directly optimizing generated SDK code for readability and preventing compilation errors.

Why do duplicate operationIds cause SDK generation errors?▼

Duplicate operationIds cause SDK generation errors because code generators create method names directly from these identifiers. Ensuring uniqueness across the entire specification prevents method signature collisions and compilation failures in the generated client libraries.

What are the best practices for naming OpenAPI parameters for SDK generation?▼

Best practices for naming OpenAPI parameters dictate using snake_case for query parameters and camelCase for path parameters. This alignment ensures the generated SDK produces idiomatic method signatures and variables across various programming languages.

Can I audit an existing openapi.yaml file for operationId uniqueness?▼

Yes, you can audit an existing openapi.yaml file to verify operationId uniqueness and verb-noun consistency. The Skill reviews attached specifications to detect duplicate identifiers and naming convention violations before SDK generation.

When do I need to standardize API identifiers in an OpenAPI specification?▼

You need to standardize API identifiers when inconsistent naming in OpenAPI specifications leads to confusing, error-prone generated SDKs. Governing these identifiers ensures error-free compilation and readable code output across target programming languages.

Related Skills

Explore More Software Engineering Skills→
pohlai88pohlai88

openapi-specification-v3.2

Author and validate OpenAPI Specification 3.2 documents with JSON Schema 2020-12.

Community
Advanced
ryan-nguyen-01ryan-nguyen-01
4

skill-api-openapi

Coordinate OpenAPI contract design and documentation across teams and services.

Community
Advanced
azmankudusazmankudus

blueprint-webapi

Enforce API contracts using a single OpenAPI 3.1 master specification.

Community
Advanced
Intense-VisionsIntense-Visions
18

check-mechanical-constraints

Validate linter rules, boundary schemas, and forbidden imports in code projects.

Official
Advanced