Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there a way to conditionally show/hide api doc for some requests? #154

Open
anandagrawal84 opened this issue Sep 26, 2013 · 1 comment

Comments

@anandagrawal84
Copy link

Is there a way to show/hide docs for certain endpoint/controller based on incoming request / auth? I can put a middle ware to disallow access to the deeplink of the protected resource '*/protected_resource/index.html' but cant find a way to hide from main doc page.

@zarelit
Copy link

zarelit commented Feb 16, 2018

There is the possibility to hide the documentation (unconditionally), but it would be nice to have docs that only a subset of users are allowed to see.
A couple of use cases are:

  • private endpoints (e.g. public endpoints for users, private endpoints to registered developers)
  • showing documentation of endpoints that are not released only to testers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants