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

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1
GET /versions/{version_id}
  • Query
  • formats query parameter Added
1 structure change including:
1 Modification
Modified 1
PATCH /docs/{doc_id_or_slug}/branches/{slug}/set_default
  • Response
  • 422 response Added

Clarify endpoints about branches:

Use Branch#slug only, remove mention to uuid.

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
Webhook POST DocStructureChange
  • Body
  • application/json content type Modified
    • api property Modified
      • url property Modified

        • Property is now deprecated

      • properties property Modified
      • humanUrl, tags properties Added

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

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

Enhance example about Create a new branch endpoint.

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
Webhook POST DocStructureChange
  • Body
  • application/json content type Modified
    • diff property Modified

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
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • diff property Modified

Request example for our webhook body has been simplified.

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

      • Property is now deprecated

    • temporary property Added
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
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
2 structure changes including:
2 Modifications
Modified 2
GET /hubs/{hub_id_or_slug}
  • Response
  • 200 response Modified
    • apis property Modified
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • api property Modified
1 structure change including:
1 Modification
Modified 1
POST /versions
  • Body
  • content type Modified
    • branch_name property Added
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