Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Documentation - Looking for contributors 🚀 #45

Open
chrishubert opened this issue Jun 28, 2023 · 6 comments
Open

Missing Documentation - Looking for contributors 🚀 #45

chrishubert opened this issue Jun 28, 2023 · 6 comments

Comments

@chrishubert
Copy link
Owner

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!

@firmanalams
Copy link

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

@kaua-alves-queiros
Copy link

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

@avoylenko
Copy link
Collaborator

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

@kaua-alves-queiros
Copy link

@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
Copy link

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.

@afikri99
Copy link

afikri99 commented Jan 2, 2025

Very interesting and helpful! Thanks!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants