openapi-python-client
openapi-python-client copied to clipboard
Add more docs
README does its best to explain what you get in concise terms. It would probably be nicer to have a more expressive reference doc which walks through most of the things you could need to do with your generated client.
Generated README also needs to be updated. async methods are documented as:
from <project>_client.async_api.my_tag import get_my_data_model
...
get_my_data_model.asyncio(...)
Where it should (likely be, for the example):
from <project>_client.api.my_tag import get_my_data_model
...
get_my_data_model.asyncio(...)
Thanks for reporting the issue @synchronizing ! It will be fixed with #337
This issue has always been too broad, which is why it's never been completed 😞. I'm going to close it, and we can track any specific docs goals in the future.