Fetch a full documentation version including diff summary

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/demo/doc/bump/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
"Bump.sh MCP server": {
  "url": "https://bump.sh/demo/doc/bump/mcp"
}
Close
GET /versions/{version_id}

Fetch a full documentation version including diff summary.

Path parameters

  • version_id string Required

    UUID of an existing version from which to fetch a documentation change

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • id string

      Unique id of your version.

    • doc_id string

      Unique id of your documentation.

    • doc_public_url string

      The public URL of your documentation.

    • diff_details array[object]

      Details of each change as a list of diff items

      Hide diff_details attributes Show diff_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

      • children array[object]

        A list of children item changes

    • diff_markdown string

      The comparaison diff summary in markdown format

    • diff_summary string

      The comparaison diff summary

    • diff_public_url string

      The public URL of your diff

    • diff_breaking boolean

      Identifies if the diff includes breaking changes

  • 202

    Documentation version is still being processed. Please try again later

  • 404

    Version not found

GET /versions/{version_id}
curl \
 --request GET 'https://bump.sh/api/v1/versions/{version_id}' \
 --header "Authorization: Token $ACCESS_TOKEN"
Response examples (200)
{
  "id": "2361df99-3467-4c80-a0cc-45c9fe565812",
  "doc_id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
  "doc_public_url": "https://bump.sh/doc/my-own-documentation",
  "diff_details": [
    {
      "id": "post-versions",
      "name": "POST /versions",
      "status": "added",
      "type": "endpoint",
      "breaking": false,
      "children": [
        {}
      ]
    }
  ],
  "diff_markdown": "## Modified (1)\n\n* `POST /user`\n  * Path parameters added: `id`, `email`\n  * Query parameters added: `period`, `limit`\n",
  "diff_summary": "Updated: POST /versions\n  Response modified: 201\n    Body attribute added: doc_id\n",
  "diff_public_url": "https://bump.sh/doc/my-own-documentation/change/2361df99-3467-4c80-a0cc-45c9fe565812",
  "diff_breaking": false
}