Page 2 of 9 for Product Updates (Page 2)

October 16, 2025

Dark mode customization

New

Since we started providing dark mode, we applied filters to make your light mode color and logo blend in dark mode. The thing is, it isn’t always enough to ensure branding consistency. You can now define a custom logo and color dedicated to dark mode.

The option is available in your hub/documentation settings, under “Customize UI”.

It’s not mandatory: we’ll keep applying filters if you don’t want/need to customize it, but it gives you flexibility.

Any request or feedback? As usual, you can reach out at hello@bump.sh!
September 29, 2025
Documentation enhancements and fixes

Improvement

While achieving milestones on larger projects, we’ve also made many quality-of-life enhancements and bug fixes. Here’s the changelog:

Enhancements:
- Custom meta tags can now be added to the head of your documentation,
- Dead anchors now redirect to their parent operation instead of the top of the documentation,
- In Embed mode, the search placeholders now specify their context (« Search API documentation » vs « Search hub »), so users can differentiate the global search from the documentaion portal search,
- A confirmation modal has been added to the API Explorer before sending destructive requests to avoid unwanted losses,
- The scrolling experience has been globally reworked to ensure its stability,
- Hub categories can now filter the documentation selector in the top navigation bar. This way, readers only see relevant docs from the same category, improving navigation for them and giving admins clearer control over doc organization,
- The browser window.title is now automatically updated when scrolling between operations to display the current navigation context,
- Highlights now work for subtitles inside x-topics, and global/operation descriptions,
- x-feedbackLink now works with Swagger 2.0 definition files,
- Groups in the navigation bar are now collapsible, to facilitate the navigation between groups containing many operations,
- The “add custom domain” module has been reworked to provide better explanations and error messages,
- Branches can now be sorted alphabetically in ascending and descending order,
- Skeletons for previews have been enhanced,
- x-state badges can now have custom colors,
- Accordions can now be added in Markdown using <details> and <summary> tags,
- A logo dedicated to dark mode can now be added to ensure brand consistency,
- The API Explorer beta is completed. 🎉 Thanks a lot to all of our testers. Your feedback has been invaluable and helped us build an even better feature for all.
Fixes:
- Fixed wrong breaking changes when the case of an HTTP header was modified but not its value,
- Fixed a trailing issue that caused the branch switch to return 404s in some contexts,
- Fixed multiple text alignments in documentation,
- Fixed an issue that prevented some descriptions from being displayed in the documentation when defined next to allOfs,
- Fixed an issue with alternatives preventing some generated examples from being displayed in some contexts,
- Fixed a bug with Mermaid rendering that prevented the use of ELK diagrams,
- Fixed an issue that displayed the “Show more” button in properties even when everything was already displayed in some contexts.
Feel free to reach out if you have any questions or features you think are missing from the product. Knock at hello@bump.sh.
September 17, 2025
Custom meta tags

New

Custom meta tags allow you to add your own meta tags to the head of your documentation, for example, to enhance your own global search experience with filtering through facets based on these meta tags.

The x-metaTags array is composed of objects made of two elements:
- name: the value that will be given to the name attribute,
- content: the value that will be given to the content attribute.
Adding the x-metaTags to the root of your definition:
x-metaTags: - name: First meta tag content: First tag content - name: Second meta tag content: Second meta tag content
Will apply the tags in the HTML of your documentation page:
<head> <meta name="First meta tag" content="First meta tag content" /> <meta name="Second meta tag" content="Second meta tag content" /> </head>
You can apply it at different levels of your API definition: root, topic, operation, … See the full list in our help center

Any feedback or requests? Don’t hesitate to reach out at hello@bump.sh!
September 08, 2025
API Explorer - OAuth2 implicit flow support

New

Supporting the “implicit” OAuth2 security scheme allows for an automated login experience for your API consumers in the API Explorer. To activate it, a vendor extension called x-client-id can be added to the definition file. Its value should be the ID of a dedicated OAuth client application created on your Authorization server to identify your API consumers.

The x-client-id property is added to your OAuth2 implicit flow object:
components: securitySchemes: "OAuth2 implicit flow": type: oauth2 flows: implicit: authorizationUrl: "https://auth.example.org/oauth" scopes: {} x-client-id: "123456abcdef"
Example of the OAuth2 implicit flow experience for an API consumer already logged into the API’s cloud platform.

Learn more about it in our help center

As always, don’t hesitate to reach out at hello@bump.sh if you have any feedback!
August 14, 2025
API Explorer - Server variables

New

Server variables enable API Explorer users to customize the request server with predefined enums or custom strings. It’s useful to specify a server region or a client specific instance, for example.

Variables are defined in a server object:
servers: - url: https://{region}.bump.sh/{docId} description: The production API server variables: docId: description: Can be found in your documentation settings. region: enum: - "east-eu" - "west-eu" default: "east-eu"
In this example, two variables were added:
- docId is a string, and a description has been defined to help the API user find its value,
- region is an enumerated list, with east-eu being the default value.
The API Explorer renders each variable accordingly.

Learn more about it in our help center

Any feedback on this feature? We’re happy to hear them! Say hi at hello@bump.sh.
July 25, 2025
Introducing Embed mode

New

Thanks to Embed mode, documentation can now be fully integrated in your global navigation, to provide your users with one unified experience. By integrating your Bump.sh documentation inside your own frontend stack, you get complete control over your branding and navigation.

To activate Embed mode, three steps are needed:
- Set up a reverse proxy in front of Bump.sh that can rewrite and forward traffic correctly,
- Add the required headers X-BUMP-SH-PROXY and X-BUMP-SH-EMBED,
- Inject your topbar, footer in the dedicated HTML tags.
Discover our integration guide in our help center

Embed mode used by MongoDB

Don’t hesitate to reach out if you have any feedback regarding this freshly released feature.
July 15, 2025
Documentation fixes and improvements

Improvement

Even if our product grows with new features, taking the time to maintain, enhance, and polish existing features is crucial to ensure a solid documentation experience. That’s why we always give ourselves time to tackle small enhancements and fixes alongside the development of new features. Here’s a list of what’s been worked on.

Improvements:
- You can now add more than one additional link to the navigation bar by using our new custom extension called x-externalLinks instead of the externalDocs property,
- When the link to an operation or group no longer exists, it now returns a 404 page instead of redirecting to the top of the documentation, providing a clearer feedback,
- When switching from one branch to another, the active operation is maintained if it also exists in the target branch,
- The global stability of the platform has been improved by optimizing requests and setting up deeper cache strategies. It’s an ongoing endeavour that we’ll continue for the next few months,
- We’ve updated our status page and how we communicate through it, to share precise information about the production status in real-time. It can be followed on status.bump.sh,
- Meta descriptions are now context-specific (topic, endpoint, channel, operation, webhook…),
- Enums support in query parameters has been deepened to handle complex combinations,
- The sharing module appearing on hover no longer prevents from easily copying operation and property names,
- Badges generated using the x-state property no longer have a string length limit,
- Mermaid diagrams and charts added in Markdown now support custom text colors,
- The switch between oneOfs now displays the discriminator mapping name instead of the component name: the mapping name value generally gives more information about the real use of an API consumer.
Fixes:
- Revamped the navigation bar architecture to ensure its stability in every context (with or without logo, inside a hub or as a standalone documentation, in the documentation, API Explorer, changelog, …),
- Reworked the copy button of the code sample module to keep it visible when the path is longer than the module, and make sure it always copies the active content when multiple code samples are defined,
- Reworked oneOfs support to ensure the right titles and content are always displayed and clickable,
- Fixed an issue where selecting a different content-type returned an empty body,
- Fixed missing required badges in advanced oneOf contexts,
- Fixed a glitch hiding the title of the hub in dark mode,
- Added a line break to externalDocs strings to ensure they wrap with the documentation width,
- Fixed multiple API Explorer UI consistency issues when applying custom styles,
- Fixed missing headers in AsyncAPI in specific contexts.
As always, don’t hesitate to reach out if you have any feedback, questions, or features you think are missing from the product. Knock at hello@bump.sh
May 20, 2025

API Explorer - Better response experience

Improvement

Following feedback, we have improved the experience of the API Explorer response module.

Increased readability #

The response module can now be expanded, making it easier to read long responses.

Images support #

If an API returns an image, the API Explorer will now display it directly in the response module (for content-type: image/jpeg and image/png).

Want to try the API Explorer? You can request access here.

The API Explorer is still in beta. We warmly welcome your feedback.
April 10, 2025
Love cycle - April 25

Improvement

Every now and then between larger product cycles, the whole team gets together to polish the product by working on small enhancements and user requests, in a time called “Love cycle”.

Here’s a list of what’s been worked on.

Improvements:
- You can now easily list all your organization’s hubs using the new GET /hubs endpoint in our API,
- Our GitHub Action has been updated and now supports overlays,
- Bump.sh CLI:
  
  A message is now displayed at every document update, so you know the CLI is running and updating the preview properly,
  
  When using bump overlay, we now display a message if an overlay doesn’t match anything,
  
  When using bump deploy, an explicit message is displayed if the target directory doesn’t exist.
- Security badges are now displayed for webhooks,
- CLI and GitHub Action code samples in your hub/documentation settings now contain real slugs and tokens to speed up Bump.sh integration into your workflow.
Fixes:
- Autogenerated date-time and time string examples now follow the ISO RFC 3339 format recommended by OpenAPI, and are displayed as 2017-07-21T17:32:28Z,
- The markdown support in documentation has been audited and multiple visual enhancements and fixes have been applied, improving visual hierarchy and readability,
- Security Schemes from OpenAPI V2 definition files are now displayed in the documentation,
- The top navigation has been reworked to offer a consistent experience across all views (Documentation, Changelog, API Explorer),
- Security badges have been reworked to ensure that they always correctly redirect to the authentication page and are displayed consistently,
- Descriptions of array[object] are now displayed in the documentation.
As usual, don’t hesitate to reach out if you have any questions, feedback, or features you would like to see added to the product. Knock at hello@bump.sh

March 07, 2025

Introducing state badges for operations and properties

Operations and properties go through multiple states during their lifetime, from unstable to beta or release candidate. This information can be crucial for your users. And more importantly, it can be completely specific to your API lifecycle. That’s why we are introducing a new property named x-state.

This custom property is a string that can be added inside an operation or a schema to identify it with a custom badge:

    paths:
    /diffs:
        post:
        description: Create a diff between any two given API definitions
        x-state: Technical preview # x-state flag at the operation level
        requestBody:
            description: The diff creation request object
            content:
            application/json:
                schema:
                type: object
                properties:
                    url:
                    type: string
                    format: uri
                    x-state: Still unstable # x-state flag at the schema level
                    description: |
                        **Required** if `definition` is not present.
                        Current definition URL. It should be accessible through HTTP by Bump.sh servers.

In this example, we added an x-state property to the operation itself, and one of its properties. Badges usage example

Learn more about it in our help center

As always, don’t hesitate to reach out if you have any feedback regarding this new feature.

Page 2 of 9

Increased readability #

Images support #