After working so hard on your API and its documentation, the moment has come to share it with the world. We recently released a new social network feature, that helps you create beautiful visuals pointing to your API.
You can now upload your own image or leave the work to us to generate a nice one. Sharing your documentation link on social networks will now display your own visual, making it more appealing.
Find out more in our Help Center!
Introducing Branching, a great way to host several versions of an API Specification on the same documentation.
If your API has several versions you would like to maintain or if you are working between two environments, branching will make a difference and limit the number of documentation in your hub.
Create as many branches as you need, upload files accordingly and find the versions of your API anytime in your documentation, through a small selection menu.
Define which branch should be chosen by default, add or delete branches, keep everything up-to-date and share with your ecosystem the best API experience possible.
Here comes a long-expected new feature: the Search Bar. We know how time-consuming it can be to scroll through long API documentation to find what you are looking for: the Search Bar solves this in a blink of an eye.
Our Search engine can look in your documentations and even your hubs on your APIs structures: endpoints, objects, properties, webhooks, etc… And to make it more comfortable, we sort them by types (and it looks great, seriously).
We are already working on two limitations: you cannot search in your spec history and we are lacking advanced filters.
Discoverability is an important topic on our end. We want to help teams and communities deep dive into their API ecosystem, making them easier to find and use. We will have a lot more to announce soon and we are preparing a small blog post on this feature’s making-of.
We hope you’ll enjoy the Search Bar: feel free to reach out if you have any feedback or suggestion!
P.S. Search will be activated on your documentation/hub after the next deploy but please contact us if you need it before this as we can manually activate it.
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.
See it in action: https://docs.canopyservicing.com/changes/fbcf9592-a369-4f17-9adb-410d48e3ff98