API Changelog

Theneo’s Changelog is an essential tool for developers and stakeholders to track changes and updates to your API specifications. This powerful feature not only documents all modifications automatically but also provides an option for users to subscribe and receive email notifications for each update.

Automated Changelog Documentation

When a new API specification is imported and the "Publish" button is clicked, Theneo automatically detects and summarizes all changes, including:

• Breaking changes in the API
• Newly added endpoints
• Updates to existing sections
• Modified descriptions
• Removed sections or endpoints

These updates are meticulously logged on a dedicated changelog page, providing a detailed version history with timestamps.

Changelog Release Notes

Theneo allows users to include concise release notes or summaries for updates made to their API documentation. These notes help highlight changes clearly for both internal teams and external users, and are automatically displayed on the dashboard and the public changelog page.

Feature Purpose

The Changelog Release Note feature provides a quick and efficient way to communicate important updates. Whether written manually or generated by AI, these notes help keep everyone informed of what’s new, changed, or removed in each API release.

Configuration Details

Release notes can be added from the Public Changelog section on your dashboard.

How to Add a Release Note

1. Navigate to the Public Changelog section on your dashboard.
2. Click the “Add Release Note” button.
3. A new input field will appear where you can either:

• Manually enter a brief summary of the changes
• Or click “Ask AI” to automatically create a professional summary

AI Summary for Release Notes

In addition to manual input, Theneo offers AI-generated summaries. With a single click, our AI detects all changes in the newly published API specification and provides a professionally written release note.

• Acts as a technical writer, summarizing key changes
• Highlights new endpoints, updated descriptions, removed sections, and breaking changes
• Saves time and ensures consistency in release communications

Saving Release Notes

After writing or generating your release note:

1. Click Save to associate the note with the current API update
2. The note will be automatically displayed:

• On the dashboard, within the changelog section
• On the public changelog page

Deleting a Release Note

1. Hover over an existing release note
2. Click the trash icon that appears
3. The note will be permanently removed from both views

Real-Time Email Notifications

How to Subscribe

1. Enter Your Email: On the Changelog page, there’s a field to enter your email.
2. Hit Subscribe: Click the “Subscribe” button to start receiving updates on the documentation changes.

Benefits of Subscription

• Immediate Awareness: Get notified as soon as changes are published, allowing for prompt action or adaptation in your workflow.
• Convenient Overviews: Email notifications provide a summary of the changes, making it easier to stay informed without needing to check the changelog manually.
• Version Tracking: Keep a close eye on version progression and ensure that all team members and API consumers are aligned with the latest API developments.

FAQ