Changelog#

changelog_build(self, stream, build)#

Get changelog build details.

Parameters:

  • stream (str) – The changelog stream name (eg stable40).

  • build (str) – The changelog build name (eg 20230121.1)

Return type:

Build

Notes

Implements the Get Changelog Build endpoint.

changelog_build_lookup(self, changelog, *, key=None, message_formats=[<ChangelogMessageFormat.HTML: 'html'>, <ChangelogMessageFormat.MARKDOWN: 'markdown'>])#

Look up a changelog build by version, update stream name, or id.

Parameters:

  • changelog (str) – Build version, update stream name, or build id.

  • key (str | None) – Unset to query by build version or stream name, or id to query by build id.

  • message_formats (List[ChangelogMessageFormat]) – Format to return text of changelog entries in.

Return type:

Build

Notes

Implements the Lookup Changelog Build endpoint.

changelog_listing(self, *, from_=None, to=None, max_id=None, stream=None, message_formats=[<ChangelogMessageFormat.HTML: 'html'>, <ChangelogMessageFormat.MARKDOWN: 'markdown'>])#

Get list of changelogs.

Parameters:

  • from – Minimum build version.

  • to (str | None) – Maximum build version.

  • max_id (int | None) – Maximum build id.

  • stream (str | None) – Filter changelogs by stream.

  • message_formats (List[ChangelogMessageFormat]) – Format to return text of changelog entries in.

  • from_ (str | None) –

Return type:

ChangelogListing

Notes

Implements the Get Changelog Listing endpoint.