REreleases
Sources

Get source changelog

Changed on

Returns the source's tracked CHANGELOG.md (or the file selected by ?path=), sliced by characters (?offset=, ?limit=) or by a cl100k_base token budget (?tokens=). Page with nextOffset. Always includes the full files index so clients can render a file picker.

get/orgs/{orgSlug}/sources/{sourceSlug}/changelog

Request

  • Base URL
    https://api.releases.sh
  • URL
    https://api.releases.sh/orgs/{orgSlug}/sources/{sourceSlug}/changelog
  • Auth
    • none
    • or HTTP bearer

Path parameters

orgSlugstring required
sourceSlugstring required

Query parameters

pathstring

Repo path of the file to return, from files[].path. Defaults to the root CHANGELOG.

offsetinteger
limitinteger

Slice length in characters.

tokensinteger

Slice to this many cl100k_base tokens instead of limit characters.

Response

Changelog slice with file index

pathstring required
filenamestring required
urlstring required
rawUrlstring required
contentstring required
bytesinteger required
fetchedAtstring required
offsetinteger required
limitinteger required
nextOffsetinteger nullable required
totalCharsinteger required
tokensinteger
sliceTokensinteger
totalTokensinteger required
truncatedboolean required
truncatedAtinteger nullable required

Changes