Skip to content

v2.8.0 (2024-03-19) Add new `overlay` command

Compare
Choose a tag to compare
@github-actions github-actions released this 19 Mar 11:01
· 26 commits to main since this release
a00160a

🆕 (BETA) Add a new overlay command to apply OpenAPI overlays to an existing API document

This release adds a new command to the cli: bump overlay to apply OpenAPI overlays to an input API document. Usage is as simple as it gets. As the functionality is still pretty new (the Overlay specification has yet some questions to answer) consider this new command as a beta feature. Overlay behaviors might change in the future.

bump overlay api-document.yaml overlay-file.yaml > api-overlayed-document.yaml

The command will output a new generated API document with the overlay applied.

Note: you can also apply the overlay during the bump deploy command with the new --overlay flag:

bump deploy api-document.yaml --doc my-doc --token my-token --overlay overlay-file.yaml