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:

Guide de référence sur les meilleures pratiques de spécification OpenAPI, les conventions de dénomination et l'expression de modèles d'API REST complexes tels que le polymorphisme, les énumérations, les téléchargements de fichiers et les événements envoyés par le serveur. À utiliser lors de l'écriture ou de l'amélioration des spécifications OpenAPI pour garantir qu'elles respectent les conventions établies et génèrent des SDK de qualité. Source : speakeasy-api/agent-skills.

Voir l'original