Change Updates

Do not miss any Bump.sh API changes, ever again

Subscribe to the Bump.sh API changelog to be up to date on recent changes.

RSS
Bump.sh API documentation

Changelog

Last update:
Compare

Documentation content has changed

Enhance example about DocumentationChange Structure change diff endpoint, using ShortId for Change urls.

API structure has changed

Minor change

We have changed the previews endpoint to make it possible to create/update a preview with a unique url field only. We will take care of downloading the definition from that URL and publish your documentation preview.

Minor refactoring

This change around the definition attribute is mostly a modelling change on our Preview model. The change doesn't affect clients.

2 structure changes including:
2 Modifications
Modified 2
POST /previews
  • Body
  • application/json content type Modified
    • definition attribute Modified

      • Attribute is no longer required

      • Permission is now writeOnly

      • definition property Modified

        • Property is no longer required

        • Permission is now writeOnly

    • url attribute Added
PUT /previews/{preview_id}
  • Body
  • application/json content type Modified
    • definition attribute Modified

      • Attribute is no longer required

      • Permission is now writeOnly

      • definition property Modified

        • Property is no longer required

        • Permission is now writeOnly

    • url attribute Added

Documentation content has changed

Documentation content has changed

Documentation content has changed

Enhance example about Create a new branch endpoint.

API structure has changed

3 structure changes including:
3 Modifications
Modified 3
GET /diffs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details attribute Modified
GET /versions/{version_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • diff_details attribute Modified
Webhook POST DocStructureChange
  • Body
  • application/json content type Modified
    • diff attribute Modified

API structure has changed

Expose current and preview object in DiffItem object, to be able to have more context about the modification.

3 structure changes including:
3 Modifications
Modified 3
GET /diffs/{id}
  • Response
  • 200 response Modified
    • details attribute Modified
GET /versions/{version_id}
  • Response
  • 200 response Modified
    • diff_details attribute Modified
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • diff attribute Modified

Documentation content has changed

Request example for our webhook body has been simplified.

API structure has changed

1 structure change including:
1 Modification
Modified 1
POST /versions
  • Body
  • content type Modified
    • unpublished attribute Modified

      • Attribute is now deprecated

    • temporary attribute Added

API structure has changed

4 structure changes including:
4 Additions
Added 4
DELETE /docs/{doc_id_or_slug}/branches/{id_or_slug}
GET /docs/{doc_id_or_slug}/branches
PATCH /docs/{doc_id_or_slug}/branches/{id_or_slug}/set_default
POST /docs/{doc_id_or_slug}/branches

API structure has changed

4 structure changes including:
4 Modifications
Modified 4
GET /hubs/{hub_id_or_slug}
  • Response
  • 400 response Added
GET /versions/{version_id}
  • Response
  • 400 response Added
POST /validations
  • Response
  • 400 response Added
POST /versions
  • Response
  • 400 response Added

Documentation content has changed

Documentation content has changed

API structure has changed

2 structure changes including:
2 Modifications
Modified 2
GET /hubs/{hub_id_or_slug}
  • Response
  • 200 response Modified
    • apis attribute Modified
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • api attribute Modified

API structure has changed

1 structure change including:
1 Modification
Modified 1
POST /versions
  • Body
  • content type Modified
    • branch_name attribute Added

API structure has changed

5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /hubs/{hub_id_or_slug}
  • Authentication
  • Authorization token authentication method Added
GET /versions/{version_id}
  • Authentication
  • Authorization token authentication method Added
POST /validations
  • Authentication
  • Authorization token authentication method Added
POST /versions
  • Authentication
  • Authorization token authentication method Added
Webhook POST DocStructureChange
  • Authentication
  • Basic token authentication method Removed

    • Removing a resource is always breaking unless it was deprecated before

      Breaking

API structure has changed

1 structure change including:
1 Addition
Added 1
GET /hubs/{hub_id_or_slug}

API structure has changed

1 structure change including:
1 Modification
Modified 1
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • api attribute Modified

Documentation content has changed

Documentation content has changed