Skip to content

Changelog ​

Changelog body lives only on GET .../changelog/{channel}/{os}/{arch}. Check JSON has no changelog.

When to use ​

Use when the client UI shows a version range. Store protocols still project Version changelog into their document (for example Sparkle <description>).

Configuration entry ​

Project Settings → Changelog Defaults (scope, layout, counts). Click-path: Settings. Instance ceilings: changelog.default_entries / max_entries in config.yaml. YAML default > max refuses to listen.

Rules and error codes ​

ConditionHTTPCode
Bad scope/layout or illegal from_version400CHANGELOG_QUERY_INVALIDIllegal changelog query
Unknown path channel400INVALID_QUERY_PARAMIllegal query (including announcement version and unknown changelog channel)
Channel token mismatch404NOT_FOUNDGeneric missing resource
Unknown from/to version404VERSION_NOT_FOUNDVersion missing
Project counts above instance ceiling400INVALID_REQUESTIllegal body/fields (including non-.mmdb, caps, unknown matrix pair, duplicate listing)

No from_version returns the newest default_entries (product default 5). With from, truncate to max_entries (default 50); overflow stays 200. Markdown ${site_url} expands from RequestOrigin.

Client duties ​

GET changelog after check if you need the body. Do not put changelog query params on check.

Related: Changelog API.