🔄 Export and Import Documentation Versions
The Export and Import functionality in All Things API (ATA) supports seamless portability, version backup, migration, and restoration of API documentation. This feature empowers teams to reuse documentation across environments, safeguard against data loss, and collaborate with external stakeholders without manual effort.
✨ Feature Overview
- 🗂️ Version Backup and Recovery Export versions to keep offline backups and restore when needed.
- 🔄 Cross-Platform Portability Migrate documentation between ATA workspaces or instances.
- ♻️ Migration and Duplication Use exported versions as templates for other teams or departments.
- 🕓 Restoring Deprecated Versions Bring back archived content without recreating pages or tabs manually.
- 🤝 Collaborative Sharing Share exported files with external reviewers or for offline access.
✅ All exports maintain version integrity, including all tabs, pages, configurations, and content types.
📤 Exporting Documentation Versions
Exporting allows users to extract a full documentation version from ATA and save it for later use.
🔧 Step-by-Step: How to Export a Version
1. Navigate to the Documentation Portal
- From the ATA Dashboard, find the Product containing the version you want to export.
2. Select the Target Version
- Under the product card, identify the specific version you wish to export.
3. Open Export Options
- Click the three-dot menu (⋮) next to the version name.
- Choose “Export” from the dropdown.
4. View Exported Files
- Go to the Exported Portal section in the left sidebar.
- This shows a list of all exported versions along with:
- Version Name
- Date of Export
- Status and available Actions
5. Manage Exported Entries
Each export entry provides the following options:
- Download: Save the export file in
.jsonformat to your local device. - Delete: Remove exported versions from the portal to keep it clean and organized.
📥 Importing Documentation Versions
Importing allows users to restore old backups or bring in external documentation versions into a product with minimal effort.
🔧 Step-by-Step: How to Import a Version
1. Open the Documentation Portal
- Navigate to the Product where you want to import the documentation version.
2. Initiate Import Process
- Click the “Import” button at the product level.
3. Upload the Exported File
In the pop-up dialog:
- Drag & drop a valid
.jsonor.zipfile, or - Browse and select the exported file from your local system.
4. Configure Import Settings
- Provide a new version name for the imported documentation.
- Confirm other version-specific settings if prompted.
5. Complete the Import
- Click “Import” to finalize.
- Once imported, the version will appear in the Version List of the selected product, ready for editing or publishing.
📌 Example Use Cases
🔁 Cross-Environment Replication
A QA team exports documentation from a staging environment and imports it into production to ensure both remain in sync.
🛡️ Backup Before Major Edits
Before overhauling content, the team exports the current version as a backup to restore if needed.
📦 Restoring Archived Versions
An older version that was previously deprecated can be re-imported for internal reference or to support legacy users.
📤 Sharing with External Reviewers
Exported .json files are sent to third-party reviewers or stored in version control tools (like Git) for audit purposes.
✅ Summary
ATA’s Export and Import capabilities offer a safe, scalable, and reusable approach to documentation management. By allowing users to migrate, replicate, back up, or restore versions effortlessly, these tools help:
- Maintain documentation consistency across environments
- Protect against accidental loss
- Facilitate collaboration across teams and organizations
- Speed up documentation workflows by reusing prebuilt structures