manage-openapi-overlays

OpenAPI specification customization can be achieved using overlay files to apply targeted modifications via JSONPath. This approach ensures source files remain untouched while enabling precise control over SDK generation configurations.

An OpenAPI overlay is a file that defines targeted updates or removals for an API specification using JSONPath. It works by matching specific elements in the document structure to apply changes like naming conventions, grouping, and security configurations.

Applying x-speakeasy extensions for SDK generation involves creating an overlay file that targets the specification via JSONPath. This overlay defines customizations like retry logic and naming conventions, which are then applied to generate the modified spec.

Yes, Speakeasy CLI supports overlay workflow automation and direct command execution. You can use it to apply an overlay file to an original specification and output the result to a newly modified OpenAPI document.

Yes, overlays can be used to change security configurations and retry logic for SDK generation. By targeting the relevant elements with JSONPath, the overlay file injects these customizations directly into the OpenAPI specification.

The best way to validate an OpenAPI overlay file is to use a workflow automation tool like Speakeasy CLI. It facilitates overlay validation through direct command execution, ensuring your JSONPath targeting and x-speakeasy extensions are correctly structured.