Overlays

Note: The Overlays Specification of OpenAPI is currently in beta. It is sufficiently stable for experimentation, however please be advised that it may change depending on the community feedback.

The Overlay specification makes it possible to modify the content of an API definition file by adding a layer on top of it. That layer helps adding, removing or changing some or all of the content of the original definition.

From your API description, and with an Overlay definition file, you can merge the two into a new definition file that you will then deploy to Bump.sh.

The Bump.sh CLI lets you merge the files.

The resulting file can then be deployed and released to Bump.sh as per your usual workflow, whether manually, via our CLI, API or GitHub Action.

Discover our Augmenting Generated OpenAPI Documents with Filters & Overlays guide to learn more about this new feature.

Edit on Github