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

Update README.md openapi section for additional clarity #109

Merged
merged 2 commits into from
Oct 27, 2024

Conversation

MannyNe
Copy link
Contributor

@MannyNe MannyNe commented Oct 25, 2024

  • The documentation section for the openapi implementation was a bit confusing to set up and where to set the patchNestJsSwagger() function in. I updated that ereadme section for more clarity for users stumbling upon that section

@BenLorantfy
Copy link
Owner

@MannyNe thanks for the contribution!

However, you don't need to call patchNestjsSwagger inside bootstrap, as shown in the example: https://github.com/BenLorantfy/nestjs-zod/blob/main/packages/example/src/main.ts#L6

@MannyNe
Copy link
Contributor Author

MannyNe commented Oct 27, 2024

Thank you for the clarification @BenLorantfy

I updated the docs again just to make it more clear for confused souls like me. I hope the update I made to the PR works. If not, you can close this PR. Thank you again, and great tool btw 😊

@BenLorantfy BenLorantfy added the documentation Improvements or additions to documentation label Oct 27, 2024
@BenLorantfy BenLorantfy changed the title docs: update README.md openapi section for additional clarity Update README.md openapi section for additional clarity Oct 27, 2024
@BenLorantfy BenLorantfy merged commit 538e3c0 into BenLorantfy:main Oct 27, 2024
1 check passed
@BenLorantfy
Copy link
Owner

LGTM, thanks for the contribution 🙂

@MannyNe
Copy link
Contributor Author

MannyNe commented Oct 28, 2024

My pleasure 😊

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

Successfully merging this pull request may close these issues.

2 participants