They have many names: schema alternatives, discriminator, inheritance... but you probably know them as oneOf, anyOf and allOf.
Bump now fully supports polymorphism for AsyncAPI and OpenAPI. You can already upload your latest API specification file to check it out. Or see it in action with our demo documentation of the feature!
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.
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!
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!
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.
In the age of information overload, getting access to information that matters can be quite challenging and that's exactly the purpose of RSS.
From now, get notified of the API changes through RSS in addition to the existing email.
Give it a try with the Bump RSS feed in your favorite RSS reader.
To give your users the best API onboarding, it often helps to be able to share specific pieces of information.
Thanks to this new feature, you can now share and highlight anything in your API documentation with just a click. The selected element will be highlighted following your color theme.
Give it a try: https://developers.bump.sh/#post-previews-body
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 😉)