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

Hide models from the buttom of the swagger ui #100

Open
michaelbukachi opened this issue Mar 25, 2020 · 4 comments
Open

Hide models from the buttom of the swagger ui #100

michaelbukachi opened this issue Mar 25, 2020 · 4 comments
Labels
enhancement New feature or request

Comments

@michaelbukachi
Copy link

Is your feature request related to a problem? Please describe.
I'm just re-raising this issue from the previous repo

Describe the solution you'd like
I already opened a PR on the previous repo. I'd like to do the same here.

Describe alternatives you've considered
I haven't found any alternative solutions.

@michaelbukachi michaelbukachi added the enhancement New feature or request label Mar 25, 2020
@ziirish
Copy link
Contributor

ziirish commented Mar 25, 2020

The correct link to the PR seems to be: noirbizarre/flask-restplus#644

But IMHO, this improvement is related to #16

@michaelbukachi
Copy link
Author

I see. Is there a discussion currently ongoing on gitter Or it's temporarily on hold?

@ziirish
Copy link
Contributor

ziirish commented Mar 25, 2020

It's not on hold, we just didn't have the opportunity to dig this topic yet.

If you have materials to start the discussion, then feel free to do so (preferably in #16 so we can eventually gather multiple feedbacks at the same place).

Thanks

@AFlowOfCode
Copy link

It would be especially excellent if the models associated with an explicitly hidden resource were also hidden automatically. Unfortunately this is not the case. If you use models in @api.expect or @api.response for a route for which you have set @api.route('/test', doc=False), those models still show up at the bottom.

In a use case where different documentation must be distributed to different audiences, endpoints can be easily hidden programmatically but hiding models is a tedious manual task.

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

No branches or pull requests

3 participants