Over the past weeks, we have considerably enhanced our support of the specifications.

minLength, maxLength and pattern​

Wherever you need to document restrictions on string fields, OpenAPI and AsyncAPI specifications rely on JSON Schema to support this. minLength and maxLength are meant to constrain the length of a string. pattern restrict the string to a specific Regular Expression (regex).

Email addresses, IBANs and ZIP/Postal codes could be great examples of these features.

readOnly and writeOnly properties​

JSON Schema allows defining a property as readOnly or writeOnly. Many examples can easily be imagined when used with AsyncAPI or OpenAPI : readOnly timestamp, writeOnly password, etc...

Our Help Center shares more details on how Bump.sh works with this feature and a few examples.

Access management has been reshaped, thanks to extended tests and user feedback.

Inviting external customers and partners to access internal APIs is now possible directly from the dashboard.

From the dedicated section in your hub/documentation settings, you can quickly modify who has access to what. Open it to teammates of your organization, or invite external partners by email directly.

Password-protected level will stay available for a limited amount of time. More info can be found in our help center.

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.

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!