bump-sh/Bump.sh API Documentation & Changelog
Keep your public, private and partner API docs in sync with your code, whether you use OpenAPI or AsyncAPI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| file | Relative path to an API definition file (OpenAPI or AsyncAPI) or a directory of definition files (when deploying to a Hub) | yes | api-contract.yml |
| doc | Documentation slug or id. Can be found in the documentation settings on https://bump.sh | — | — |
| token | Api token. Can be found in the documentation or organization settings on https://bump.sh | — | — |
| hub | Hub slug or id. Needed when deploying to a documentation attached to a Hub. Can be found in the hub settings on https://bump.sh | — | — |
| branch | Branch name used during `deploy` or `diff` commands. This can be useful to maintain multiple API reference history and make it available in your API documentation. | — | — |
| command | Bump command: deploy|dry-run|preview|diff | — | deploy |
| expires | Specify a longer expiration date for public diffs (defaults to 1 day). Use iso8601 format to provide a date, or you can use `never` to keep the result live indefinitely. | — | — |
| fail_on_breaking | Mark the action as failed when a breaking change is detected with the diff command. This is only valid when `diff` is provided in the command input. | — | false |
| overlay | A list of OpenAPI Overlays to apply to the API definition before deploying it. Overlays are applied in the order they are provided. | — | — |
| filename_pattern | Filename pattern to extract the documentation slug from filenames when deploying a DIRECTORY. Pattern uses only '*' and '{slug}' as special characters to extract the slug from a filename without extension. Only used with the 'hub' input when deploying a whole directory . | — | {slug}-api |
| mcp_server | MCP Server id or slug. Necessary to deploy a new workflow documentation to be run by your MCP Server. | — | — |
Outputs
no outputs