Skip to content
BookendBookend Docs

Get release notes

GET
/v1/releases
curl --request GET \
  --url http://localhost:8080/v1/releases

Returns the running version and the release notes shipped inside the image (CHANGELOG.md, Keep a Changelog format), parsed into releases, sections and items. Any authenticated principal, including API keys.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

The running version and the release notes shipped inside the image (CHANGELOG.md, Keep a Changelog format).

object
currentVersion
required
string
releases
required
Array<object>
object
version
required
string
date
required
null | string
sections
required
Array<object>
object
heading
required
string
items
required
Array<string>
source
required
string
Examplegenerated
{
  "currentVersion": "example",
  "releases": [
    {
      "version": "example",
      "date": "example",
      "sections": [
        {
          "heading": "example",
          "items": [
            "example"
          ]
        }
      ]
    }
  ],
  "source": "example"
}