search

bauerji / flask-pydantic

flask extension for integration with the awesome pydantic package
MIT License
368 stars 58 forks source link

Request change: the example in the main README.md file is not clear #21

Closed OmarThinks closed 3 years ago

OmarThinks commented 3 years ago

Before I start, I really thank you so much for this package.

I request to make a change: The example at the README.md file in the main page of the package is not clear. At first, I thought that the package was not working correctly. I kept working, and sending requests till finally worked after about 15 minutes of trying.

For this reason: The example is very advanced, and for someone who wanna learn the package for the first time, the learning curve of the example is very hard to learn. This is dangerous for someone who wants to learn about the package for the first time.

So I would like to solve this problem by doing this. Create 3 separate endpoints:

  1. To read the GET request only, and above it the pydantic class of it.
  2. To read the JSON request body only, and above it the pydantic class of it.
  3. To read both the JSON request and the GET request together, using the old pydantic classes.

    If God willed, I can make this change. I will make these changes, If you give the permission. Thank you!

bauerji commented 3 years ago

Hello Omar,

feel free to modify README to give it more clarity and submit a PR. Any contribution is welcome!

Jirka

OmarThinks commented 3 years ago

Okay. If God willed, I will do my best. Thank you so much for giving me this opportunity. 👍 💯 🥇

bauerji commented 3 years ago

released in version 0.6.0