I would like to integrate Apidog and GitLab into my documentation update workflow.
I use Apidog JSON as the export format.
Steps before
I exported the Apidog main branch and committed the export file to GitLab.
I have made some changes in the Apidog main branch for sone endpoint
I decided to bring the Apidog develop branch to the state of the export from GitLab (I imported the file exported in step 1). So I imported this file into the Apidog develop branch using the default overwrite behavior.
In the Import Preview & Configuration, I saw the Introduction.md file marked for import.
After the import process, a table with statistics appeared, and from it I saw that this MD file was not imported → (stats from imporing table + couldn’t find it in my develop branch)
Current Behavior
Introduction.md was not imported
Expected Behavior
Introduction.md was imported
Please let me know if you need additional details or clarifications.
Thank you for your feedback. I tried to reproduce the issue with the following steps:
Exported a project from Apidog
Imported it back into the same project
When the project already contained a markdown file with the same name, using the default “Overwrite” import mode didn’t create a new file (no new records in modification history)
When I deleted the existing markdown file first, the import successfully created a new markdown document
Exported a project from Apidog from the main branch.
Imported it back into the same project in the empty sprint branch (let’s call it develop) based on the main branch.
After the import, the endpoints are visible in the develop branch’s side menu, but the MD file doesn’t appear. I expect to see it too.
I guess this is somehow connected to the fact that develop branch is based on main. The endpoints are visible because the IDs in response examples are inconsistent and change during the import. From Apidog’s view, these are “changed” files compared to the main branch. The MD file, however, stays the same without any changes, so from Apidog’s perspective, it is “the same” as in the parent branch and because of this, Apidog doesn’t visualize it in the side menu. I would like to understand how this works.
For endpoints, they become visible in the develop branch because their response example IDs change during import (creating “changed” files). However, for markdown files like Introduction.md, if the content remains identical to the main branch, Apidog won’t create a separate copy in the develop branch—only modified files are duplicated.