Fetch a full documentation version including diff summary
Fetch a full documentation version including diff summary.
Path parameters
-
UUID of an existing version from which to fetch a documentation change
GET /versions/{version_id}
curl \
-X GET https://bump.sh/api/v1/versions/{version_id} \
-H "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": "modified",
"type": "endpoint",
"breaking": true,
"previous": {
"path": "/versions",
"verb": "POST",
"deprecated": false
},
"current": {
"path": "/version",
"verb": "PUT",
"deprecated": false
},
"breaking_details": {
"message_key": "removed_not_deprecated",
"breaking_attributes": [
"verb",
"path"
]
},
"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
}
Response examples (400)
{
"message": "You need to upgrade to a paid plan to perform this request. Please go to https://bump.sh/account/billing"
}