-
-
Notifications
You must be signed in to change notification settings - Fork 348
[16.0][IMP]fastapi: expose FastAPI docs only if field is set #537
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
base: 16.0
Are you sure you want to change the base?
Conversation
Hi @lmignon, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer a configuration parameter on the endpoint in place of a global config parameter.
dcc5ceb
to
881bfdc
Compare
While testing it I found a problem, not necessarily related to this implementation. If I enable the endpoint with I found that the |
881bfdc
to
de344b4
Compare
It's because you must add the new field into the list returned by the method |
de344b4
to
649b406
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR!
Good work 👏
I just have a few suggestions, mainly about documentation of the code, please have a look at the comments below.
85bda5a
to
8ca9d00
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PicchiSeba Thank you once again. LGTM
8ca9d00
to
95c8ca1
Compare
95c8ca1
to
4eea801
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code review, LGTM
This PR has the |
If we go into production right now, the FastAPI documentation endpoints (Swagger, Redoc, OpenAPI) are reachable by anyone.
There might be cases where this feature is not required or even prohibited.
With this PR we aim to hide these interfaces with a System Parameter