postman-app-support icon indicating copy to clipboard operation
postman-app-support copied to clipboard

Hide specific API's from Documentation.

Open Lincimary opened this issue 4 years ago • 20 comments

Is there an existing request for this feature?

  • [X] I have searched the existing issues for this feature request

Is your feature request related to a problem?

We have a few endpoints that we don’t want to share with clients, it would be a very useful feature if we have an option to hide specific API to the documentation.

Describe the solution you'd like

Ability to set “Private” on requests or folders so they’re hidden from docs.

Describe alternatives you've considered

Create two versions of docs and keeping them manually in sync causes some overhead.

Additional context

We have a similar community thread: https://community.postman.com/t/hide-subfolder-from-documentation/1569/9

Lincimary avatar Oct 20 '21 12:10 Lincimary

Will this be picked up? it's still an issue for me to not be able to toggle visibility for some endpoints with postman docs.

mlabarca avatar Mar 23 '22 15:03 mlabarca

Would be possibly nice to add support for custom extensions for this kind of thing. We are also in need of something similar, Stoplight for example supports the x-private flag for operations or entire APIs.

petkostas avatar Apr 05 '22 15:04 petkostas

Hey, just ran into a need for this today. I assumed there would be a toggle to make certain endpoints private, but a quick google search led me here. Please add this functionality soon!

eleniums avatar Jun 02 '22 16:06 eleniums

I assumed there would be a toggle to make certain endpoints private, but a quick google search led me here.

👍 Same here. Would be appreciated if this feature is coming soon.

crazyoptimist avatar Jul 25 '22 15:07 crazyoptimist

Same here, we need to hide some endpoints in the docs:

  • endpoints under development
  • private/internal endpoints

Thibault2ss avatar Jul 26 '22 20:07 Thibault2ss

This would be a really useful feature.

srhyne avatar Aug 17 '22 14:08 srhyne

Bump Would love to see this featuer implementation, i do not want to keep track of many different folders just to weed out endpoints that shouldnt be made aware to the public

CNFishead avatar Jan 03 '23 17:01 CNFishead

Is this issue still being considered? We need to have a public and private version of our API and I don't wanna have to duplicate the documentation, as then we'd have to update the documentation for the public endpoints twice.

kieransimkin avatar Feb 28 '23 17:02 kieransimkin

Is there a timeline for this feature to be out?

felipecpc avatar Apr 21 '23 06:04 felipecpc

Would really love to see this feature implemented

zendus avatar Jul 10 '23 17:07 zendus

TBC, this is a highly needed feature, have some folders (backoffice and admin requests) that should not be included in the published documentation handed to clients.

joshajiniran avatar Jul 14 '23 08:07 joshajiniran

I have a some private endpoints in my API that should only be known to the Admin. I need to keep it out of the public docs but still want it to be in the collection. This feature would really be helpful

Christone007 avatar Aug 08 '23 15:08 Christone007

Would be nice to implement this feature!

n0n0n0 avatar Sep 24 '23 07:09 n0n0n0

Would love this feature!!

crice88 avatar Oct 23 '23 20:10 crice88

This is something our team would also like to have, researched it today and found this post. It would be a very useful addition.

FdvTerje avatar Dec 12 '23 16:12 FdvTerje

Quite happy to add this feature myself if I'm given access to the codebase @postman-staff

kieransimkin avatar Dec 12 '23 17:12 kieransimkin

I would like to emphasize that this feature would be really appreciated! Not every function in our API should be opened to the public, but having only one project helps avoid duplications

Xqua avatar Apr 10 '24 15:04 Xqua

This is also a feature we would like to have. Thanks

WiseCues avatar Jun 17 '24 18:06 WiseCues

This is a feature we love to see soon!

gilsonsouzah avatar Jul 25 '24 14:07 gilsonsouzah

+1 on this. We use postman both for internal development and external documentation. It is pain to maintain two documentation

bergur avatar Sep 21 '24 19:09 bergur

I’m on board with this request! It’d be super helpful to hide specific endpoints from the documentation for better security

pamungkasandono avatar Oct 19 '24 04:10 pamungkasandono

+1 here too! Seems there is plenty of demand for this feature and it makes sense that most have the same use case which is also not uncommon, moreover I would have expected that most developers would have need of this.

obrienware avatar Oct 19 '24 19:10 obrienware

Its been more than 3 years and this most needed feature is still not completed

609harsh avatar Dec 23 '24 17:12 609harsh

Its been more than 3 years and this most needed feature is still not completed

To be honest postman reeks of a project that has lost its original developer, or it's original developer has lost their mojo, and it's become something of a zombie. I stopped using and switched to Swagger a while ago.

kieransimkin avatar Dec 24 '24 20:12 kieransimkin