Edit

Release notes

This article explains how to publish and display public release notes for each of your app versions.

Public release notes

How to publish new release notes:

1. Upload a new OPK to the production environment on the Developers Console.
2. Click on the "Add release notes" button.
3. Enter your release notes for this version in the markdown format (you can also use the predefined headers: (new), (improved) and (bugs))
4. Preview your release notes by clicking the "Preview" button.
5. Make sure that the "Publish" switch is on.
6. Save

How to request the relevant notes from the Overwolf release notes endpoint:

Request:

GET https://console-api.overwolf.com/v1/apps/<uid>/versions/<version>/release-notes/<page>`

uid - your app's UID

version - you will get release notes for this version and below

page - pagination (you get 3 versions / notes per page)

Response:

{
  "versions": [
    {
      "important": Boolean,
      "version": String,
      "html": String,
      "timestamp": Number
    }
  ],
  "meta": {
    "perPage": Number
  }
}

Example:

GET https://console-api.overwolf.com/v1/apps/npijmgiaiiemcnijaljcfddgeihcbifdbhpffihe/versions/3.1.5/release-notes/1

{
  "versions": [
    {
      "important": true,
      "version": "3.1.5",
      "html": "<p>release notes for 3.1.5</p>",
      "timestamp": 1643024580643
    },
    {
      "important": false,
      "version": "3.0.33",
      "html": "<p>release notes for 3.0.33</p>",
      "timestamp": 1643036589211
    },
    {
      "important": false,
      "version": "2.0.0",
      "html": "<p>release notes for 2.0.0</p>",
      "timestamp": 1643036589211
    }
  ],
  "meta": {
    "perPage": 3
  }
}