Publishing API documents to custom domain URL

[gerhardvr-finclude]

Is there an existing issue for this?

• [X] I have searched the tracker for existing similar issues and I know that duplicates will be closed

Describe the Issue

I’ve got an API YAML file with my API definition. Connected to this API specification is a collection. This collection is published to a company URL and always worked great, even though it has a number of shortcomings.

In Postman 10 there is now a collection that shows up directly under the API. From what I can see this is NOT the same collection that is published to our company URL (the one that can be found under the Collection button in Postman). It does looks like it is a copy of the one under the Collection button. I’ve added another request to the collection under the API but this new request doesn’t show up in the collection whose documentation is published. It is clear that the collection under the API has absolutely nothing to do with the collection it was copied from. What makes this particularly frustrating is that there seems to be no way to publish the API with the collection to our company URL. I do NOT want to publish it to a Postman public workspace. I want to be able to publish it to my company URL, like I always could. Nor do I want to make use of Partner Workspaces.

It makes logical sense to edit/update the collection directly under the API and not the one in the Collections group but I can only publish the one in the collection group? Seriously?! This is very poor design thinking, or the documentation is outdated since I cannot find any info on how to publish the API with its attached collection to our company URL.

The closest thing to useful info I can find is " Also, you can’t publish a collection that has been added to an API. Instead, you can publish a version of the API. A published version includes the API’s definition and collections."

Well, that helps nothing since it does not explain how I can publish a version of the API to my company URL instead of a public workspace. So now I cannot publish a collection that has been linked to an API specification? Why?! I used to be able to do so in the past.

Please assist since this is a major issue for us. We need to update our API definition as well as the collection and now we have to update two collections (the one under the API and the one under the Collection button). I simply cannot believe that this is what was intended.

Steps To Reproduce

1. Upgrade the API definition for use in Postman v10
2. See that there is now a collection shown under the API entry under the APIs button.
3. Add a new request to the collection under the API
4. Check the collection under the Collections button and see that the new request does not exist there
5. Try to publish the API specification with its attached collection to a custom company URL and fail

Screenshots or Videos

The Finclude B2B API collection under the Collections button show NO "mobile_lookup" request

The Finclude B2B API collection attached to the API specification under the APIs button showing the newly added "mobile_lookup" request

Operating System

Windows

Postman Version

Postman v10.6.0

Postman Platform

Postman App

User Account Type

Signed In User

Additional Context?

No response

[chrisl-za]

I'd like to second this.

It doesn't really make sense to me why we can have two places with collections and the behaviour is different in how they are published. I'd like to be able to publish the collections under APIs the same as how they are published under Collections so I can give the URL to consumers. Ideally, I wouldn't use the collections in the Collections group at all if they are in the APIs section.

Unless I'm missing something in terms of how this is supposed to work?

Thanks!

[brandonrobinson5060]

Hello, any progress on this? I was about to use Postman to power our api documentation but this is a non starter for us. Would love to use postman if we could. :(

[shashankawasthi88]

@brandonrobinson5060 @chrisl-za @gerhardvr-finclude I am the product manager for this feature. We are working on the feature for the upcoming release. It would be great if we can set up a call to understand your workflows in detail. It will help us design a proper solution for the same. Feel free to schedule a call with me using this link.

[willcanary]

@shashankawasthi88 Has any progress been made on this?

It would be valuable for us to be able to publish documentation for a collection derived from a Postman "API" to our custom domain. This way we can update the collection from the definition .yaml file that lives in our connected Github repo, publish a new API version, and republish the corresponding documentation to our custom domain.