Skip to main content

NewsUpdateAvailableDto

A newer Codex release than the one this server runs.

currentVersionstringrequired
Example: 2.6.3
latestVersionstringrequired
Example: 2.7.0
releases object[]required

Every Codex release newer than the running one, highest version first: what upgrading would bring.

  • Array [
    • bodystringrequired

    Markdown. Render without raw HTML.

    idstringrequired

    Stable feed id.

    Example: codex-v2.7.0
    kindstringrequired

    release or post.

    Example: release
    projectstringrequired

    Feed the entry came from: codex or codex-ios.

    Example: codex
    publishedAtstring<date-time>required
    summarystringrequired

    Plain text, a few hundred characters at most.

    titlestringrequired
    Example: Codex 2.7.0
    unreadbooleanrequired

    Unread by the calling admin.

    urlstring | nullnullable
    versionstring | nullnullable
    Example: 2.7.0
  • ]
    • urlstring | nullnullable

    Release notes for the latest version, when the feed links them.

    Example: https://github.com/AshDevFr/codex/releases/tag/v2.7.0
    NewsUpdateAvailableDto
    {
      "currentVersion": "2.6.3",
      "latestVersion": "2.7.0",
      "releases": [
        {
          "body": "string",
          "id": "codex-v2.7.0",
          "kind": "release",
          "project": "codex",
          "publishedAt": "2024-07-29T15:51:28.071Z",
          "summary": "string",
          "title": "Codex 2.7.0",
          "unread": true,
          "url": "string",
          "version": "2.7.0"
        }
      ],
      "url": "https://github.com/AshDevFr/codex/releases/tag/v2.7.0"
    }