Introducing Manual Release Mode

Gain greater control over your API Documentation deployments by using the Manual Release Mode for your API documentation.

Grouped changes: Multiple changes are sometimes part of a single feature or improvement. Using this mode allows for these changes to be grouped together under a single changelog entry.

Timing: Keep merging your PRs and following your API changes on a daily basis, but control when you and your team communicate these changes to you API users.

Quality Assurance: Add an extra layer of QA and collaboration before a change is officially published.

Learn more in our Release Management documentation.

Improvements and fixes #

• Change Comparison: Route simplification to enhance UX.
• Specification: Multiple server support.
• API Documentation: Fix navigation accessibility on darkmode.
• CI Deployment settings: Token are now hidden by default.
• Dashboard: Better deployment warning label.

Comparison between (any) API changes

APIs evolve constantly, each iteration creating changes, breaking ones or not. API consumers need to keep track of them or could need to upgrade from a several behind version.

We have worked on a new feature that allows to compare any versions of an API with another, accessible from its changelog. Changes are instantly highlighted, and if you need to easily share the result with your teammates, we got you covered: use the generated link or even better, try to press Y key!

Come and test this new feature directly on Bump.sh API documentation.

Improvements and fixes

• API documentation: Sidebar navigation has received UI enhancements.
• Dashboard: History became Deployments along UI enhancements and a new status filter (spoiler alert).
• Darkmode: All icons have been updated to be accessible on both light and darkmode.
• API documentation: Ordering issue (operation, responses, parameters, etc.) has now been solved and respects the given specification.

Improved Changelog

The changelog is a crucial part of your API ecosystem, providing a clear view of what’s new, changed, fixed or removed. We’ve redesigned it to make it cleaner, clearer and more efficient while maintaining the ability for anyone to stay aware of updates, one click away.

Check how it looks on the Bump.sh API doc: it is absolutely stunning.

Custom code samples

We now support the x-codeSamples extension that let you set language-specific code samples you expect your users to work with.

Examples are often the first stop for developers in any API documentation. This extension allows you to set along a programming language, its custom code samples, for a more seamless developer experience when it comes to testing an API.

Either supercharge your API documentation by setting language-specific code examples or keep things simple as the auto-generated cURL examples remain. See more about custom code sample in the docs.

Managing Branches from your API

Branch Management is now available from the Bump.sh API, making your API evolution workflows a whole lot smoother as an easy and effective way to manage your versions and optimizes how you deliver ephemeral or major ones, at hand (at least within our API).

Let’s explore how these new features simplify your API workflow #

1. Branch creation: Create a new branch effortlessly with a single API call, eliminating manual work.
2. List of Branches: Obtain an overview of all API branches, facilitating efficient management and organization.
3. Set Default Branch: Easily choose and showcase a default branch for up-to-date API documentation.
4. Delete Branch: Remove unnecessary branches to maintain a clean and organized development environment.

Bump.sh CLI v2.7.0

Multi-file Deployment #

Deploying multiple files on your Hub has never been this effortless. You can now provide a directory path to deploy all files within a directory to your Bump.sh hub.

For a more detailed walkthrough on how this works, check out the feature in action in our latest release notes.

Live Preview #

Using the Live Preview feature bump preview --live my-definition-api.yml now creates an immediate preview without waiting for the first change on the target file.

Other improvements #

• Keeping up with the latest version of the CLI is now easier thanks to a new warning in case of outdated version usage.
• Significant refactor of the deployment-related code to accommodate the new “Multiple files deploy” feature.
• CLI upgraded to TypeScript 4.5 and performed some dependency upgrades.

Lightning-fast API documentation rendering

Fast-loading page is a must these days, both for human users and search engines.

Thanks to the new rendering engine, which has already been released to 100% of our users, navigating your API documentation is now a breeze. It provides an optimal experience for all API consumers, whatever the size of the documentation (yes, any size).

Performance is significantly better: the first interactive content is as fast as the blink of an eye, which also means there’s no more blocking time when you first navigate the API documentation.

Enhanced Specifications Support

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.

Improved Access Management

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.

Polymorphism

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!