writing-openapi-specs

SKILL.md

Reference for OpenAPI best practices and conventions. This skill provides guidance on taste, conventions, and grey areas not covered by the OpenAPI specification itself.

Operation IDs: Use lowercase with underscores, following resourceaction pattern:

Component Names: Use PascalCase for schemas, parameters, and other reusable components:

Guía de referencia para las mejores prácticas de especificación de OpenAPI, convenciones de nomenclatura y expresión de patrones complejos de API REST como polimorfismo, enumeraciones, carga de archivos y eventos enviados por el servidor. Úselo al escribir o mejorar las especificaciones de OpenAPI para garantizar que sigan las convenciones establecidas y generen SDK de calidad. Fuente: speakeasy-api/agent-skills.

Ver original