Create Openapi Overlay

What it does

This skill generates an OpenAPI overlay based on a given API definition. It allows you to extend or modify existing OpenAPI specifications, enabling customization and integration with other systems. The resulting overlay can then be used for documentation generation, code generation, or testing purposes.

When to use it

• You need to add custom extensions to an existing OpenAPI specification without directly modifying the original file.
• You want to generate a modified API definition for internal tooling or specific development workflows.
• You're integrating with a third-party API and require adjustments to its documented structure.
• You need to create a simplified version of a complex API definition for easier consumption by clients.

Key capabilities

• Generates OpenAPI overlays based on provided API definitions.
• Allows for modification and extension of existing OpenAPI specifications.
• Supports customization for various use cases, including documentation and code generation.

Example prompts

• "Create an OpenAPI overlay for this API definition, adding a new security scheme."
• "Generate an overlay that simplifies the 'users' endpoint in this OpenAPI specification."
• "Modify this OpenAPI definition to include custom request body examples."

Tips & gotchas

The skill requires a valid OpenAPI definition as input. Ensure the provided definition is well-formed and adheres to the OpenAPI standard for optimal results.