Add a favicon to your documentation

Until now, for documentation having a customised logo, the same one was used as a favicon.

From now on, you can use a specific one, to brighten up your documentation more than ever!

Here is how Bump’s documentation looks like now:

And icing on the cake: it works for your hub too!

Happy enhancement!

Better change summaries

We have enhanced the way we summarize API changes. We now list any changes, at all levels (endpoints, requests, responses, attributes & headers) in the API changelogs and notifications we send.

Here an example of a previous summary:

Endpoint updated: Versions
Endpoint updated: Validations

Which now becomes:

Updated: POST /docs/{:id}/versions
  Body attribute added: specification
  Response added: 200
  Responses removed: 201, default
Updated: POST /docs/{:id}/validations
  Body attribute added: specification
  Response removed: default

It is now active for all new deployments. We’ll be recalculating the summaries of previous deployments to make your API changelogs clearer soon.

Documentation examples for lazy people

What’s the first thing you look at when exploring a new tool? If you’re as lazy as I am, it’s probably the examples. As we think they are one of the most important parts of your documentation, we gave them the attention they deserve.

First, we have improved the way we auto-generate examples when missing. We now generate them based on the format of the attribute, for the following formats: email, url, date, date-time and UUID.

For requests with a body, we now display the whole body example, just under the cURL command example.

And last but not least, copying an example has never been easier: we have added a copy button for cURL and request body examples:

Your whole ecosystem on a single page

Today, we are super excited to release a long-awaited feature: Hubs. You can now create your APIs catalogs, directly from Bump.

Highlighted features:

• custom domain support
• documentations can be grouped by tag
• default settings at the hub level, applied to all its documentations
• auto-creation of hub documentations from your CI
• and obviously, OpenAPI and AsyncAPI support

Hubs are available with our Business plan. Learn more on our help center.

Introducing our GitHub action

Deploying your API documentation has never been so simple if you are using GitHub. We have just released our GitHub action, which lets you super easily control when and how you want to deploy your doc.

All you have to do is configuring your workflow:

steps:
  - name: Checkout
    uses: actions/checkout@v2
  - name: Deploy API documentation
    uses: bump-sh/github-action@0.1
    with:
      id: <BUMP_DOC_ID>
      token: <BUMP_DOC_TOKEN>
      file: doc/api-documentation.yml

You can see it in action on our workflow examples 😎