whatsapp-api icon indicating copy to clipboard operation
whatsapp-api copied to clipboard

Missing Documentation - Looking for contributors 🚀

Open chrishubert opened this issue 2 years ago • 7 comments

This one is a lot of work,

I use Swagger Autogen (swagger-autogen) I'm calling for potential contributors to help improve it 🥰

The syntax is quite straightforward with multiple examples across the code with an example here

Once written, it's as easy as running npm run swagger to generate the doc!

chrishubert avatar Jun 28 '23 06:06 chrishubert

Hi, i think i can help. Can you give me an example where should i improve?

firmanalams avatar Apr 16 '24 06:04 firmanalams

Very good! I had already suggested doing this because I also use NSwag to generate the SDK

kaua-alves-queiros avatar Dec 10 '24 04:12 kaua-alves-queiros

@kaua-alves-queiros feel free to use the forked project https://github.com/avoylenko/wwebjs-api with improved documentation.

avoylenko avatar Dec 10 '24 07:12 avoylenko

@avoylenko I made some adjustments directly in the swagger.json code to generate some parts correctly. I will clone the repository and try to bring these improvements to the documentation in the proper way.

kaua-alves-queiros avatar Dec 12 '24 23:12 kaua-alves-queiros

Note: I'm from dotnet and I've never used swagger this way.

from what I understand despite a lot of work it is not difficult

I managed to bring the workaround I did to generate it correctly using autogen instead of hardcoding it in swagger.json image

that generated the expected result image

I will take another look at the standards that are being applied in the project to ensure that it is well done and without my vices in other stacks, soon I will start sending the improvements in the documentation.

kaua-alves-queiros avatar Dec 13 '24 01:12 kaua-alves-queiros

Very interesting and helpful! Thanks!!!

afikri99 avatar Jan 02 '25 07:01 afikri99