-
Notifications
You must be signed in to change notification settings - Fork 127
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
Add nested related filters to docs schema #320
Conversation
Codecov Report
@@ Coverage Diff @@
## 0.11.x #320 +/- ##
==========================================
- Coverage 98.33% 93.06% -5.27%
==========================================
Files 4 4
Lines 180 202 +22
Branches 41 46 +5
==========================================
+ Hits 177 188 +11
- Misses 1 11 +10
- Partials 2 3 +1
Continue to review full report at Codecov.
|
Please review and let me know if I missed anything. This is my first time opening a PR here |
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.
Hi @Ken4scholars. Apologies that I'm going to be a bit terse, but I can go into more detail if you have questions. I left a few comments below, but additionally:
- Schema support should be tested.
- Highly nested and recursive relationships should be considered (i.e., how deep do you go?). By default, the backend renders forms with a depth of 1. Look into
disable_subset
.
Hello @rpkilby. Thank you for the review and pointing out things that should be considered.
|
Hi @Ken4scholars. Given that the PR is targeting 0.11.x, I'm going to go ahead and close it. Happy to reconsider a PR targeting the master branch and django-filter 2. |
Hello @rpkilby sorry, but any reason why there shouldn't be new PRs for 0.11x? 1.00 is still in dev mode and has not been released yet. Is it a project policy? Just to be clear, I considered this a fix and not a new feature and that's why I decided to push it to the latest branch in use instead of waiting for the next big release. |
Currently, nested filters are not shown in swagger docs because they are not added to the OpenAPI schema. With this PR, the filters are expanded and added when generating the docs