Bump.sh API documentation

Structure change

POST /DocStructureChange

Payload sent when your documentation receives a deployment with a structure change.

Headers

X_BUMP_SIGNATURE_256 string Required

The hash signature of the payload. Bump.sh uses a HMAC hex digest (SHA256) to compute the signature of the body payload with the webhook secret. More info in help.

application/json

Body

Information about last documentation structure change of your API history

api object Required
Hide api attributes Show api attributes
- id string
  
  UUID of this API
- name string
  
  Name of this API
- description string
  
  Description of this API from the latest definition
- slug string
  
  Slug of this API
- url string
  
  public documentation URL
- version string
  
  Version of this API taken from the latest definition
- properties array[object]
  
  Extra properties attached to this API
  Hide properties attributes Show properties attributes object
  
  type string
  
  Type of the extra property
  
  Values are x-access-level or x-definition-type.
  
  data string
  
  Content of the extra property
- created date
  
  Creation date of this API
- modified date
  
  Last udpate date of this API
diff object Required
Hide diff attributes Show diff attributes
- id string
  
  Unique id of your diff
- title string
  
  The title of the last parsed definition
- public_url string
  
  The public URL of your diff
- breaking boolean
  
  Identifies if the diff includes breaking changes
- details array[object]
  
  Details of each change as a list of diff items. Present only if json format has been requested
  Hide details attributes Show details attributes object
  
  id string
  
  The identifier of the diff change
  
  name string
  
  The human name of diff change
  
  status string
  
  Values are added, modified, or removed.
  
  type string
  
  The object type of the diff change
  
  breaking boolean
  
  Identifies if the item is a breaking change
  
  previous object
  
  Object attributes values, before change. Possible attributes depend on the object type ('endpoint', 'body', 'response'…)
  
  current object
  
  Object attributes values, after change. Possible attributes depend on the object type ('property', 'operation', 'message'…)
  
  breaking_details object
  
  Represents breaking change reasons, used to give more context about this question: why is this change breaking?
  
  Hide breaking_details attributes Show breaking_details attributes
  
  message_key string
  
  This property is used to generate the human message about breaking change reason
  
  breaking_attributes array[string]
  
  When diff status is modified, this property is an array including every modified attribute responsible of the breaking change.
  
  children array
  
  A list of children item changes
- previous_version_url string
  
  URL of previous version specification, in JSON format
- current_version_url string
  
  URL of current version specification, in JSON format

POST DocStructureChange

Request example

# Headers
X_BUMP_SIGNATURE_256: a0b1c1d2e3f5a8b13c21d34e55f89a144b233c377d610e987f1597a2584b4181

# Payload
{
  "api": {
    "id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
    "name": "Bump.sh",
    "description": "This is the official Bump.sh API documentation. Obviously created with Bump.sh",
    "slug": "bump",
    "url": "https://developers.bump.sh/",
    "version": "1.0",
    "properties": [
      {
        "type": "x-access-level",
        "data": "string"
      }
    ],
    "created": "2022-01-07",
    "modified": "2022-04-07"
  },
  "diff": {
    "id": "2361df99-1234-4c80-a0cc-45c9fe565812",
    "title": "Bump.sh Api",
    "public_url": "https://bump.sh/doc/my-own-documentation/change/2361df99",
    "breaking": false,
    "details": [
      {
        "id": "post-versions",
        "name": "POST /versions",
        "status": "modified",
        "type": "endpoint",
        "breaking": true,
        "previous": {
          "path": "/versions",
          "deprecated": false,
          "verb": "POST"
        },
        "current": {
          "path": "/version",
          "deprecated": false,
          "verb": "PUT"
        },
        "breaking_details": {
          "message_key": "removed_not_deprecated",
          "breaking_attributes": [
            "verb",
            "path"
          ]
        },
        "children": []
      }
    ],
    "previous_version_url": "https://developers.bump.sh/changes/750f15d8/previous.json",
    "current_version_url": "https://developers.bump.sh/changes/750f15d8/current.json"
  }
}