The Overlay Specification defines a document format for information that augments an existing OpenAPI description yet remains separate from the OpenAPI description's source document(s).

This specification is a community-driven, open specification within the OpenAPI Initiative, a Linux Foundation Collaborative Project.

Overlays support a range of scenarios, including:

• Translating documentation into another language
• Providing configuration information for different deployment environments
• Allowing separation of concerns for metadata such as gateway configuration or SLA information
• Supporting a traits-like capability for applying a set of configuration data, such as multiple parameters or multiple headers, for targeted objects
• Providing default responses or parameters where they were not explicitly provided
• Applying configuration data globally or based on filter conditions

If you are looking for tools to use with Overlays, try these:

• Bump.sh CLI
• Speakeasy CLI
• overlays-js
• apigee-go-gen CLI
• openapi-format CLI/UI
• oas-patch CLI
• oas-overlay-java
• Specmatic - Docs
• BinkyLabs.OpenApi.Overlays - dotnet

(Is something missing from the list? Send us a pull request to add it!)

See: License (Apache-2.0)