Bump.sh API documentation

Changelog

Last update:
Compare

Documentation content has changed

Documentation content has changed

Enhance example about Create a new branch endpoint.

API structure has changed

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.

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

Modified 1
POST /versions
  • Body
  • content type Modified
    • unpublished attribute Modified
      • Attribute is now deprecated

    • temporary attribute Added

API structure has changed

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

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

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

Modified 1
POST /versions
  • Body
  • content type Modified
    • branch_name attribute Added

API structure has changed

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

Added 1
GET /hubs/{hub_id_or_slug}

API structure has changed

Modified 1
Webhook POST DocStructureChange
  • Body
  • content type Modified
    • api attribute Modified

Documentation content has changed

Documentation content has changed

Documentation content has changed

API structure has changed

Modified 1
GET /diffs/{id}
  • Response
  • 200 response Modified
    • previous_version_url, current_version_url attributes Added
Added 1
Webhook POST DocStructureChange

API structure has changed

Modified 1
GET /diffs/{id}
  • Response
  • 200 response Modified
    • title attribute Added