fix: allows user to set example(s) value(s) when using Form and/or multiple Body parameters #5297
Conversation
|
📝 Docs preview for commit 465fa70 at: https://6304a9f3f932165c1c5f3902--fastapi.netlify.app |
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #5297 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 540 540
Lines 13969 13955 -14
=========================================
- Hits 13969 13955 -14
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
|
📝 Docs preview for commit 54c3cce at: https://6304ceb57221bc00af3fdb7f--fastapi.netlify.app |
Otherwise scripts/lint.sh encounter an error
|
📝 Docs preview for commit ddb8c97 at: https://6304d21be4d2a200b6672bf8--fastapi.netlify.app |
…str with example value
…//github.com/Thytu/fastapi into fix/move-example-value-into-field_info-extra
|
📝 Docs preview for commit a6927c3 at: https://6304e7d434435108f8ec8054--fastapi.netlify.app |
Otherwise scripts/lint.sh encounter an error
…str with example value
Thytu
force-pushed
the
fix/move-example-value-into-field_info-extra
branch
from
ad579ea
to
082da0a
Compare
|
📝 Docs preview for commit 082da0a at: https://6304eb466af6460e89830243--fastapi.netlify.app |
…//github.com/Thytu/fastapi into fix/move-example-value-into-field_info-extra
…y-example/ endpoint
|
📝 Docs preview for commit 6776a87 at: https://6304ee5e40f0bf09bcfcc3c2--fastapi.netlify.app |
|
@JarroVGIT is the test coverage KO? It's running since yesterday 🫤 |
|
That is weird, I am not the maintainer of this project (@tiangolo) is, maybe it’s just stuck and a nonsense commit would force it to restart? |
|
📝 Docs preview for commit fc7a4e3 at: https://63514fea133908387a64036b--fastapi.netlify.app |
|
📝 Docs preview for commit 516ac3e at: https://63651605f1f3d2004eef785b--fastapi.netlify.app |
|
📝 Docs preview for commit 0baaca7 at: https://637670959ffd0c114a4849bf--fastapi.netlify.app |
|
Legend says that one day, this PR will be either merger or closed, but no one know which and when 🫠 |
|
📝 Docs preview for commit 010df4a at: https://637e24626bc32f4503acf9b7--fastapi.netlify.app |
|
📝 Docs preview for commit e11412a at: https://638366b289f64174f6e8f97c--fastapi.netlify.app |
|
📝 Docs preview for commit 2de9b27 at: https://6383702d603c3c69a92c000b--fastapi.netlify.app |
|
📝 Docs preview for commit 75b10ac at: https://63847192d901c52783138872--fastapi.netlify.app |
|
📝 Docs preview for commit dc5f4ec at: https://638e2b21fc1d9854575661c1--fastapi.netlify.app |
|
📝 Docs preview for commit 2f5bdc4 at: https://639ce566a12b8e05b99de518--fastapi.netlify.app |
|
📝 Docs preview for commit c0c8198 at: https://639ed7ce04318b4f66823fd5--fastapi.netlify.app |
|
📝 Docs preview for commit 1c83608 at: https://64254c5d8bd61a4016f6c349--fastapi.netlify.app |
|
I'm stubborn (and working on a fork since Aug 2022 🤡) |
|
Cleaning my PR history (takes WAY too long to be merged...) |
|
@tiangolo this is a great example on why there needs to be a better format for managing this project. You ask for help specifically on this project, but if you don’t even comment on active code contributions, people will move away. |
|
Thanks for the input @JarroVGIT, I'm trying to work on the things that can make the biggest impact, switching back and forth in reviewing things and the others that are already planned. In this particular case, I have been wanting to support Pydantic models for Form, Query, and others, but I haven't been able to see how that would work and if it would be feasible or not, so I didn't (and still don't) know if this would be the approach to go or not, so I didn't comment before, as I don't really have something valuable to comment yet. |
|
@tiangolo I have no doubt that you're are prioritizing the PR / Issues than can produce the biggest impact, but @JarroVGIT's point is still valid. You should consider changing the current format of management for this project for one than could result in a faster iteration rate and thus biggest impact. The current working do results in people moving away and in our case considering switching FastAPI for something else. I hope you'll consider those elements, either way well done for the work accomplished. |
|
Thanks for the feedback. I'll try to make things more transparent, I think probably a tentative roadmap will help (although I'm afraid people would be disappointed if they find out I discarded/changed later some of the ideas in that roadmap). That could help understanding what is planned and what will come in features. On the other hand, meanwhile, something everyone could help is reviewing existing PRs (@JarroVGIT did it here, thanks!), in particular, checking they have tests, and that the code in the PR solved the problem. For example, there are many PRs, you could help me asking for them. There's more info and instructions here: https://fastapi.tiangolo.com/help-fastapi/#review-pull-requests |
This would allow the user to use and display
example(s)value(s) when usingForm(or multipleBodyparam).Explication:
f.field_info.extrawas empty, thus when callingcreate_response_fieldthe return value also has en emptyextrafield.Note : I know this is not a perfect fix as it does not handle every cases (and is hard-coded) but this would fix the issue while giving time for a developing a better fix to come latter.
Better fix for latter : When creating the
field_infoinget_param_field, we should determine which value to put into theextrafield.Closes #5249