postmanlabs / postman-app-support

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.
https://www.postman.com
5.84k stars 839 forks source link

Hide specific API's from Documentation. #10384

Open Lincimary opened 3 years ago

Lincimary commented 3 years ago

Is there an existing request for this feature?

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

mlabarca commented 2 years ago

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.

petkostas commented 2 years ago

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.

eleniums commented 2 years ago

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!

crazyoptimist commented 2 years ago

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.

Thibault2ss commented 2 years ago

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

srhyne commented 2 years ago

This would be a really useful feature.

CNFishead commented 1 year ago

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

kieransimkin commented 1 year ago

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.

felipecpc commented 1 year ago

Is there a timeline for this feature to be out?

zendus commented 1 year ago

Would really love to see this feature implemented

joshajiniran commented 1 year ago

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.

Christone007 commented 1 year ago

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

n0n0n0 commented 1 year ago

Would be nice to implement this feature!

crice88 commented 1 year ago

Would love this feature!!

FdvTerje commented 11 months ago

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

kieransimkin commented 11 months ago

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

Xqua commented 7 months ago

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

WiseCues commented 4 months ago

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

gilsonsouzah commented 3 months ago

This is a feature we love to see soon!

bergur commented 1 month ago

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

pamungkasandono commented 2 weeks ago

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

obrienware commented 2 weeks ago

+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.