Markdown support

As markdown is a standard and a common way to bring more readability into your documentation, we have made some improvements on markdown support and bring new features to help you create fast and beautiful API documentations.

Bump now supports common Markdown syntax, language color syntax highlighting, and information call-outs. Last but not least, Markdown can be included inside your contract file or as an external reference using dedicated Markdown files.

Check our help page to start taking advantage of markdown in your API documentation.

Receive API changelog in your mailbox 🔔

In API documentation, changelogs are important, and your API consumers need to stay up-to-date on recent changes.

It’s now possible for them to subscribe by email to your API changelog: they will receive a summary of the changelog every week in their mailbox!

Want to see it in action on Bump API documentation? See it live

Do not hesitate to invite your API consumers to subscribe to your API updates (available at http://{your-doc-url}/changes)

Never miss an API change again (now, it’s in your mailbox in case you missed it 😉)

Download source from your documentation

We’ve made it easy for API consumers to download the source of an API documentation.

Whether you want to get your hands on a JSON or YAML format, for OpenAPI or AsyncAPI, you’re now just a click away.

Bump diff from your Command Line Interface or your Continuous Integration platform

Our new bump diff command has landed in our CLI.
Make sure to upgrade your bump-cli package to at least v2.1.0 to test it.

Now, straight from your CLI, you are able to describe the changes made in your contract:

> bump diff --doc users-account api-specification.yaml
Updated: GET /account
  Response modified: 200
    Body attribute added: ticket_ids
Added: GET /tickets/{ticket_id}

The new command will output a quick summary of what has changed between your latest deployed API contract and the file you have changed locally.

If you use Github Actions to launch your automation workflows, we have some more good news for you: we now offer a stable bump-sh/github-action@v1 action. And this latest release includes automatic API contract changelog pushed as a comment for each pull request.

Check our help page to get you started with team collaboration on API design.

Nested properties get a make up 🎀

Feedbacks are important to us and we do our best to make you feel heard. We know that accessing nested properties is a pain point for many of you so we tried to make the navigation clearer and the selected element will now stand out more.

We’d love to hear from you and see if these changes suit your needs so hit us up with your comments whether you love it or hate it!

New Command Line Interface era

Goodbye to our legacy ruby gem, and hello to our new node-based CLI 👋.

We are releasing a new Command Line Interface which is iso-feature with the old CLI. There is one additional improvement though: we now support recursive external references ($ref keyword in your API specifications), with mixed filesystem or URL paths. You can now refactor your API definitions in small chunks, re-use parts of it, and separate concerns between endpoints, models or nested-objects in peace.

This new CLI package is written in Typescript which will help us to publish a stable & type safe tool. On top of that -and especially with the oclif framework- we are now able to publish universal packages for multiple OSes & architectures so everybody can enjoy Bump via command line interface.

Get it while it’s hot #

npm install -g bump-cli

or download a package directly from the latest Github release assets.

Enjoy the commands #

• bump preview to build as many API documentation preview as you want.

• bump deploy --dry-run to validate your future API documentation deployment.

  (⚠️ This is a breaking change compared to our old CLI’s and replaces the old bump validate command)

• bump deploy to deploy your latest API documentation changes.

Ease your sight with dark mode ☾

Today we introduce the dark mode to your documentations! Depending on your system settings, your page will appear in a light mode (default) or in a darker scheme.

You’ll also be able to toggle to light or dark mode regarding your own preferences.

We hope you will enjoy the new experience. 👻

Documentations in your pocket

We now offer a better mobile experience for your documentation if you happen to need it on-the-go. You will also have a navigation menu that allows to access the changelog page.

More changes are coming, stay tuned!

Global support of external references

As your API grows, your specification becomes more and more complex. At some point, splitting it up into multiple files with $ref references pointing to these external resources can help a lot.

We have just released full external references support by updating:

• our web app
• our CLI (version 0.7 is out)
• our GitHub action (version 0.2 is out)

Now, no matter the channel you use to deploy a specification, Bump will resolve all references (when possible) and import their content into your documentation.

Want to learn more? Have a look at [our documentation]/help/specification-support/references/).

Hello, OpenAPI webhooks

OpenAPI 3.1 has been released today. Some important changes are coming with this new version. Above all, the greatest improvement is the support of webhooks, at the same first level than paths.

We are glad to announce today that webhooks are now supported by Bump, as you can see in this live example.

We hope you’ll enjoy this new feature, don’t hesitate to have a look to our technical documentation if necessary.