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
- Navigate to the Public Changelog section on your dashboard.
- Click the “Add Release Note” button.
- 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
💡 This is especially useful for teams that want clear, reliable summaries without manual drafting.
Saving Release Notes
After writing or generating your release note:
- Click Save to associate the note with the current API update
- The note will be automatically displayed:
- On the dashboard, within the changelog section
- On the public changelog page
Deleting a Release Note
- Hover over an existing release note
- Click the trash icon that appears
- The note will be permanently removed from both views
Real-Time Email Notifications
How to Subscribe
- Enter Your Email: On the Changelog page, there’s a field to enter your email.
- 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.
Changelog Field Visibility Controls
Project Editors can now control exactly which fields appear on the public-facing Changelog page. Fields can be marked as hidden directly from the project dashboard, keeping auto-generated or irrelevant entries out of the public view — without deleting the underlying records. Hidden fields remain fully intact in the system and can be made visible again at any time.
How It Works
Visible fields
Appear on the public Changelog page. Readable by anyone with access to your documentation portal. This is the default state for all changelog fields.
Hidden fields
Excluded from the public Changelog page. The underlying record is preserved in full — hiding a field does not modify or delete it. Only Editors can see hidden fields from the project dashboard.
Who Can Use This Feature
Changelog field visibility is controlled at the project level by Project Editors. Workspace Admins have the same access.
Workspace Admin | Yes | Yes |
Project Editor | Yes | Yes |
Viewer / Public reader | No | No |
Hiding Changelog Fields
1
Open your project dashboard
Navigate to the Public Changelog tab.
2
Click Manage Visibility
Locate the Manage Visibility button.
3
Select the fields to hide
Use the multi-select interface to choose one or more fields you want to remove from the public Changelog page. You can select as many fields as needed in a single action. Fields generated automatically - such as those created during API spec imports or system-triggered updates - are common candidates for hiding.
4
Confirm and apply
Confirm your selection to apply the visibility changes. All selected fields are immediately hidden from the public Changelog page. A hidden indicator is shown against each field within the dashboard so Editors can identify them at a glance.
Changes take effect immediately on the live public Changelog page. No republishing is required.
5
Confirm the public view
Open your public-facing Changelog page to verify the selected fields no longer appear. All other fields in the entry remain intact and visible.
Making Hidden Fields Visible Again
Hidden fields can be restored to the public Changelog page at any time without any data loss.
1
Click Manage Visibility
Manage Visibility
Hidden
2
Deselect the fields to restore
Deselect the fields you want to make public again. You can restore multiple fields in a single action.
3
Confirm and apply
Confirm your selection. The restored fields appear immediately on the public Changelog page. No republishing is required.
FAQ
Can I turn off the changelog?
Can I turn off the changelog?
Yes, the changelog feature in Theneo is optional. You can disable it at any time by going to your project settings, navigating to the 'Features' section, and toggling off the changelog feature.
Can I edit the changelog?
Can I edit the changelog?
Currently, direct editing of changelog entries is not available. However, if you need to remove a specific entry from the public changelog, you can delete it. To do this, go to your project configuration, select 'Public Changelog,' and use the delete button next to the entry you wish to remove.
Can I edit versions?
Can I edit versions?
The ability to edit version details is a feature that is in the pipeline and will be available soon. This upcoming feature will provide more control over how you document and present version changes in the changelog.
Will this create a new API version if there are breaking changes?
Will this create a new API version if there are breaking changes?
Theneo is designed to track changes meticulously. The functionality to automatically create a new API version upon detecting breaking changes is being developed. When released, it will allow users to manage versions more effectively and ensure that versioning reflects significant changes or updates.
What made this section helpful for you?
What made this section unhelpful for you?
On this page
- API Changelog