package.json
file, either via NPMnpm exec
as suchbump
in your command line environment. You can get some help anytime by using --help
on any command. Example: bump deploy --help
.preview
command: it will create a temporary documentation with a unique URL, which will be available for a short period of time.--live
flag you can stay focused on API design (OpenAPI or AsyncAPI file) while seeing a continuously updated preview each time you save your API definition file.openapi-definition.json
file in your favorite text editor--token
flag or via the BUMP_TOKEN
environment variable. This token can be found from your documentation settings > CI deployment
pagebump diff
command explained above, you can also make sure your API specification file is valid and parsed correctly by Bump with the bump deploy --dry-run
command. It can be used to ensure that future file deployment will work smoothly.--token
flag or via the BUMP_TOKEN
environment variable. This token can be found from your documentation settings > CI deployment
pagedeploy
command is for. When deploying the new version, Bump will analyse your API structure and will generate a changelog item if the API structure has changed.--token
flag or via the BUMP_TOKEN
environment variable. This token can be found from your documentation settings > CI deployment
page