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.
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.
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).
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.
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.
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.
Over the past weeks, we have considerably enhanced our support of the specifications.
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.
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.
