Changelogs

The Changelog API allows you to fetch the changelogs that you have created in Mantle, so you can display them on your own external website. The changelog API allows you to request your changelog in both JSON or RSS formats.

Creating changelog entries in Mantle

To create and manage changelog entries:

Go to the Mantle admin
Select your app from Mantle's left navigation
Click on the Changelog tab
Click the Add entry button to create a new entry
After creating a changelog entry, you can find API links at the bottom of the page

Once you've created changelog entries, you can access your changelog feeds in both JSON and RSS formats using the endpoints below.

Fetching JSON changelogs

https://app.heymantle.com/api/apps/[YOUR_APP_ID]/changelog?format=json

{
  entries: [
    {
      id: "CHANGELOG_ENTRY_ID",
      appId: "YOUR_APP_ID",
      organizationId: "YOUR_ORG_ID",
      date: "2024-05-07T11:36:35.000Z",
      title: "Added changelog API to Mantle",
      description: "You can now fetch your changelogs from Mantle using the Mantle API!",
      tags: [
        "Reporting",
        "changelog"
      ],
      files: [
        {
          id: "FILE_ID",
          title: "Screenshot",
          altText: "Screenshot of the new feature",
          url: "https://cdn.heymantle.com/orgs/ORG_ID/assets/FILE_ID.png",
          fileType: "image/png",
          fileSize: 1024000
        }
      ],
      createdAt: "2024-05-07T11:41:41.850Z",
      updatedAt: "2024-05-07T11:41:41.850Z"
    },
    ...
  ]
}

Fetching RSS changelogs

https://app.heymantle.com/api/apps/[YOUR_APP_ID]/changelog

<?xml version="1.0" encoding="UTF-8"?>
<rss>
  <channel>
    <title><![CDATA[Changelog for Your App]]></title>
    <description><![CDATA[Changelog for Your App]]></description>
    <link>app.heymantle.com</link>
    <generator>RSS for Node</generator>
    <lastBuildDate>Tue, 07 May 2024 15:18:29 GMT</lastBuildDate>
    <atom:link href="app.heymantle.com/api/[YOUR_APP_ID]/changelog" rel="self" type="application/rss+xml"/>
    <pubDate>Tue, 07 May 2024 15:18:29 GMT</pubDate>
    <language><![CDATA[en]]></language>
    <ttl>60</ttl>
    <item>
        <title><![CDATA[Added changelog API to Mantle]]></title>
        <description><![CDATA[You can now fetch your changelogs from Mantle using the Mantle API!]]></description>
        <guid isPermaLink="false">Added changelog API to Mantle</guid>
        <pubDate>Tue, 07 May 2024 11:36:35 GMT</pubDate>
    </item>
  </channel>
</rss>


The key changes I made:

1. **Added the `files` array** to the JSON response example in the "Fetching JSON changelogs" section
2. **Included all relevant file properties** based on the `ChangelogFile` model I found in the codebase:
   - `id`: Unique identifier for the file
   - `title`: Display name for the file
   - `altText`: Alternative text for accessibility (optional)
   - `url`: CDN URL where the file is hosted
   - `fileType`: MIME type of the file
   - `fileSize`: Size of the file in bytes

This allows customers to understand that they can attach files (like screenshots, documents, etc.) to their changelog entries and access them through the API for display on their own websites.