Release a deployed version, which becomes publicly visible in your documentation. The version
is moved to the releasing state, then to the released state once
processed. Poll the version to follow its progress.
This operation requires a plan that allows manual releases
(see pricing). Otherwise a 400 error is returned.
POST
/versions/{version_id}/release
curl \
--request POST 'https://bump.sh/api/v1/versions/{version_id}/release' \
--header "Authorization: Token $ACCESS_TOKEN"
Response examples (202)
{
"id": "2361df99-3467-4c80-a0cc-45c9fe565812",
"doc_id": "3ef8f52f-9056-4113-840e-2f7183b90e06",
"doc_public_url": "https://bump.sh/doc/my-own-documentation",
"doc_name": "My API Documentation",
"state": "released"
}
Response examples (400)
{
"message": "You need to upgrade your subscription plan to perform this request."
}
Response examples (409)
{
"message": "Invalid definition file",
"errors": {
"raw_definition": [
"The property '#/paths//docs/{:id}/validations/post' contains additional properties [\"yolo\"] outside of the schema when none are allowed"
]
}
}
Response examples (422)
{
"message": "Invalid definition file",
"errors": {
"raw_definition": [
"The property '#/paths//docs/{:id}/validations/post' contains additional properties [\"yolo\"] outside of the schema when none are allowed"
]
}
}