Here is an update that was released some time ago but out of the radar: we now display all available types (even nullable) on any properties in your OpenAPI or AsyncAPI definition.
You’ll now see these correctly displayed properties in your documentation. Multiple types may look like a slight improvement but will add clarification to your team and community.
And we have an example to show how great it is (thanks to Meilisearch’s documentation).
You already have deployed your API documentation but feel something’s missing? You couldn’t be more right.
Introducing one of the biggest updates to Bump yet: UI Color customization. You read that right. You can now change the primary color of your documentation to make it shine more than ever. Or make it match your logo/company brand!
We even added a short preview to help you find the best tone and ensure that you’ll keep in mind how it will look in dark mode too.
Try it out from your Dashboard > Customize UI and share with us your best results!
Today, we’re introducing Webhooks integration, as a new way to add Bump to your existing workflow.
Set them up from your dashboard and receive notifications when events on your API structure are detected on your documentation.
Find more in our Help Center!
Following our recently released Organization feature, the new Documentation Access Management will help control who has access to which documentation or hubs.
Three access levels are available: public, private (for your organization only) and protected (limited, password protection).
Find more in our Help Center!
Building the best APIs can be a considerable amount of work and you may need your teammates to help. But you definitely do not want one single shared account for that.
Freshly out of beta, the awaited Organizations feature helps you with that. We did not reinvent the wheel but wanted to make it as simple but powerful as possible.
You can easily customize access with 3 different roles: admin, maintainer, and viewers. Admins can invite and manage access, maintainers can manage hubs and docs, guests are limited to read-only.
Available from the Startup plan, we hope it will help teams work efficiently and smoothly on their APIs. You can find out more about Organizations in our Help Center!
This update was also the opportunity to ship some enhancements for the dashboard.
We can’t wait to hear about what you think of it so feel free to reach out!
The API changelog page has been redesigned to give you a clearer view of what has changed inside your API, it is the groundwork of having fine-grained changelog details 🕵️
Hope you will enjoy it!
See it in action on our own API documentation
• Bonus point:
If you use our github-action, the diff comments have also been updated. Check our latest release for details: https://github.com/bump-sh/github-action/releases/tag/v1.1.0
✨ Quickly identify what has changed in your API ✨
Jump from change to change! No need to scroll anymore to see the latest changes in your documentation diff.
Give your API users a personalized experience and a better understanding of your API while reading your documentation by including multiple examples to your API definition.
Bump now supports displaying multiple examples which are supported by both OpenAPI and AsyncAPI specifications.
A new --live flag was added to the bump preview command.
This gives you the ability to stay focused on your API definition file (OpenAPI or AsyncAPI file) while seeing your Bump preview documentation page being updated as you change the file.
No need for a specific text editor, or any extension, just use the bump CLI to preview your documentation live.
Learn more about live preview on our help page.
If some changes are more important than others, it is especially true for your API.
From now on, we automatically detect if a new version of your API includes some breaking changes. It will be visible in the changelog page, in the changelog email or the brand new RSS feed… but also during your API design phase while opening a pull request thanks to our Github Action.
With Bump, you will never miss a breaking change again.