Do not miss any Bump.sh APIs Hub changes, ever again

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

RSS

Changelog

Last update:
Bump.sh Workspace API

Clarify endpoints about branches:

Use Branch#slug only, remove mention to uuid.

Bump.sh Workspace API
2 structure changes including:
2 Modifications
Modified 2
GET /hubs/{hub_id_or_slug}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • apis property Modified
      • specificationVersion property Added
POST DocStructureChangewebhook
  • Body
  • application/json content type Modified
    • api property Modified
      • url property Modified
        • Property is now deprecated
      • properties property Modified
      • humanUrl, tags properties Added
Bump.sh Workspace API

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

Bump.sh Workspace API

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 property Modified
      • Permission is now writeOnly
      • Property is no longer required
      • definition property Modified
        • Permission is now writeOnly
        • Property is no longer required
    • url property Added
PUT /previews/{preview_id}
  • Body
  • application/json content type Modified
    • definition property Modified
      • Permission is now writeOnly
      • Property is no longer required
      • definition property Modified
        • Permission is now writeOnly
        • Property is no longer required
    • url property Added
Bump.sh Workspace API

Enhance example about Create a new branch endpoint.

Bump.sh Workspace API
3 structure changes including:
3 Modifications
Modified 3
GET /diffs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • details property Modified
GET /versions/{version_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • diff_details property Modified
POST DocStructureChangewebhook
  • Body
  • application/json content type Modified
    • diff property Modified
Bump.sh Workspace API

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 property Modified
GET /versions/{version_id}
  • Response
  • 200 response Modified
    • diff_details property Modified
POST DocStructureChangewebhook
  • Body
  • content type Modified
    • diff property Modified
Bump.sh Workspace API

Request example for our webhook body has been simplified.

Bump.sh Workspace API
1 structure change including:
1 Modification
Modified 1
POST /versions
  • Body
  • content type Modified
    • unpublished property Modified
      • Property is now deprecated
    • temporary property Added
Bump.sh Workspace API
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
Bump.sh Workspace API
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
Bump.sh Workspace API
Bump.sh Workspace API
Bump.sh Workspace API
2 structure changes including:
2 Modifications
Modified 2
GET /hubs/{hub_id_or_slug}
  • Response
  • 200 response Modified
    • apis property Modified
POST DocStructureChangewebhook
  • Body
  • content type Modified
    • api property Modified
Bump.sh Workspace API
1 structure change including:
1 Modification
Modified 1
POST /versions
  • Body
  • content type Modified
    • branch_name property Added
Bump.sh Workspace API
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
POST DocStructureChangewebhook
  • Authentication
  • Basic token authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Bump.sh Workspace API
1 structure change including:
1 Addition
Added 1
GET /hubs/{hub_id_or_slug}
Bump.sh Workspace API
1 structure change including:
1 Modification
Modified 1
POST DocStructureChangewebhook
  • Body
  • content type Modified
    • api property Modified
Bump.sh Workspace API
Bump.sh Workspace API