openapi-python-client icon indicating copy to clipboard operation
openapi-python-client copied to clipboard

Add more docs

Open dbanty opened this issue 5 years ago • 2 comments

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.

dbanty avatar May 19 '20 12:05 dbanty

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(...)

synchronizing avatar Feb 10 '21 01:02 synchronizing

Thanks for reporting the issue @synchronizing ! It will be fixed with #337

dbanty avatar Feb 10 '21 17:02 dbanty

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.

dbanty avatar Aug 13 '23 02:08 dbanty