Fetch detailed information from an existing diff

GET /diffs/{id}

Fetch the result of a previously created diff with the POST /diffs API endpoint.

Path parameters

id string Required

UUID of an existing diff from which to fetch diff details

Query parameters

formats array[string]

A list of formats to render in the response. Possible values are text, markdown, html or json. If not provided defaults to render both text and markdown formats.

Responses

200

Diff successfully retrieved
Hide response attributes Show response attributes object
- 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
  
  Hide details attributes Show details attributes array[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
  
  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
- markdown string
  
  The comparaison diff summary in markdown format
- html string
  
  The comparaison diff summary in HTML format
- text string
  
  The comparaison diff summary in plain text format
202

Diff is still being processed. Please try again later
404

Diff not found

GET /diffs/{id}

curl \
 -X GET https://bump.sh/api/v1/diffs/{id}

Response examples (200)

{
  "id": "2361df99-1234-4c80-a0cc-45c9fe565812",
  "public_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812",
  "breaking": false,
  "previous_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/previous.json",
  "current_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/current.json",
  "text": "Updated: POST /versions\n  Response modified: 201\n    Body attribute added: doc_id\n",
  "markdown": "## Modified (1)\n\n* `POST /user`\n  * Path parameters added: `id`, `email`\n  * Query parameters added: `period`, `limit`\n"
}

{
  "id": "2361df99-1234-4c80-a0cc-45c9fe565812",
  "public_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812",
  "breaking": false,
  "previous_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/previous.json",
  "current_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/current.json",
  "html": "<ul class=\"changelog-event__diff expandable\" data-expander-target=\"content\">\n  <li class=\"changelog-event__diff-operation added\">\n     Added: <a href=\"http://localhost:3000/diff/c1e36203-5b04-4adc-b8c5-8ac626ce8592#operation-get-diffs-parameter\"><code class=\"code-inline root\">GET /diffs/{id}</code></a>\n  </li>\n</ul>\n"
}

{
  "id": "2361df99-1234-4c80-a0cc-45c9fe565812",
  "public_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812",
  "breaking": false,
  "previous_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/previous.json",
  "current_version_url": "https://bump.sh/diff/2361df99-3467-4c80-a0cc-45c9fe565812/current.json",
  "details": [
    {
      "id": "post-versions",
      "name": "POST /versions",
      "status": "added",
      "type": "endpoint",
      "breaking": false,
      "children": []
    }
  ]
}

Response examples (200)

{
  "id": "2361df99-1234-4c80-a0cc-45c9fe565812",
  "title": "Bump Api",
  "public_url": "https://bump.sh/doc/my-own-documentation/change/2361df99-3467-4c80-a0cc-45c9fe565812",
  "breaking": false,
  "details": [
    {
      "id": "post-versions",
      "name": "POST /versions",
      "status": "added",
      "type": "endpoint",
      "breaking": false,
      "children": []
    }
  ],
  "previous_version_url": "https://developers.bump.sh/changes/750f15d8-6c41-47b9-8f80-e3ed812dbca9/previous.json",
  "current_version_url": "https://developers.bump.sh/changes/750f15d8-6c41-47b9-8f80-e3ed812dbca9/current.json",
  "markdown": "## Modified (1)\n\n* `POST /user`\n  * Path parameters added: `id`, `email`\n  * Query parameters added: `period`, `limit`\n",
  "html": "<ul class=\"changelog-event__diff expandable\" data-expander-target=\"content\">\n    <li class=\"changelog-event__diff-operation added\">\n         Added: <a href=\"http://localhost:3000/diff/c1e36203-5b04-4adc-b8c5-8ac626ce8592#operation-get-diffs-parameter\"><code class=\"code-inline root\">GET /diffs/{id}</code></a>\n    </li>\n</ul>\n",
  "text": "Updated: POST /versions\n  Response modified: 201\n    Body attribute added: doc_id\n"
}