Why did connecting an API in Postman to GitLab create a second copy of the API document in the repository?

[pcolmer (Philip Colmer)]

I’ve imported an OpenAPI document into Postman and then connected the resulting API entry to a GitLab repository.

In doing so, I selected the root document, which is at docs/API/OpenAPI.yaml. Postman then wanted me to push changes to the git repository … which included Postman creating a second copy of the OpenAPI document but, this time, in the root of the repository.

Why did it do that? As far as I can tell, from looking at the git repository, it is a complete copy of the original file … which means I’ve now got to keep two files in sync???

[houssem-gharssallah]

Hi @pcolmer ,
From my experience with the API Builder when Git repos are involved, it is better to start with an empty repo and then import your API documentation.
Same experience goes when using an existing API in Postman.

As for what happened in your case, it is similar to adding Git to an existing folder on your computer . Postman now is trying to reconciliate the content that existed prior to connecting to Git.
I am assuming the imported spec (prior to setting the Git repo) was sitting in the root of the API hierarchy in Postman.

Since you specified docs/API/OpenAPI.yaml as root document, then that’s your source of truth and that’s the file Postman will use going forward. I recommend you double check that all your changes are in that file and it’s up to date.

Hint: The entire resulting file hierarchy (post moving to Git) is located in an autogenerated .postman/api file. You won’t see the file in Postman, but you will see it in your repo. Postman uses that file for configuration. Any possible misconfiguration will definitely show up there.

I hope this helps you understand the issue you are having

[pcolmer (Philip Colmer)]

Thanks, @houssem-gharssallah

This is a snippet of the .postman/api file after connecting Postman to the GitLab repository:

[config.relations.apiDefinition]
files[] = {"path":"docs/API/openapi.yaml","metaData":{}}
files[] = {"path":"openapi.yaml","metaData":{}}

[config.relations.apiDefinition.metaData]
type = openapi:3
rootFiles[] = docs/API/openapi.yaml

Would it seem “safe” to remove the openapi.yaml file from the root folder in the repository and to remove that corresponding entry from the api file?

I don’t really want to have two copies of the file

[houssem-gharssallah]

Absolutely @pcolmer

Unless the root definition file docs/API/openapi.yaml is referencing something from the openapi.yaml, it should be safe to be removed (I recommend backing it up somewhere though… you never know if you end up needing it ).

I recommend you delete it using the Postman API Builder UI. .postman/api is auto-generated and managed by the editor. Touching these auto-generated files is never safe (Old experience from Visual Studio lol).

[pcolmer (Philip Colmer)]

Thanks, @houssem-gharssallah. I (finally) figured out where in the API Builder UI to remove the extra, unrequired file.

Goodness only knows why Postman added it in the first place, but there is now only one copy.

Thanks again.