docs.nestjs.com

docs.nestjs.com copied to clipboard

PR Checklist

Please check if your PR fulfills the following requirements:

• [x] The commit message follows our guidelines: https://github.com/nestjs/docs.nestjs.com/blob/master/CONTRIBUTING.md

PR Type

What kind of change does this PR introduce?

• [ ] Bugfix
• [ ] Feature
• [ ] Code style update (formatting, local variables)
• [ ] Refactoring (no functional changes, no api changes)
• [ ] Build related changes
• [x] Docs
• [ ] Other... Please describe:

What is the current behavior?

The documentation page about swagger setup option currently show the custom options available, but only for express and does not show the options or explain how to find the options for fastify.

Issue Number: N/A

What is the new behavior?

The available options for fastify are added just after the express one.

Does this PR introduce a breaking change?

• [ ] Yes
• [x] No

Other information

I presented the options like for express. Maybe in the future it would be nice to add details about what each options are used for. Like it's done with comments on the document options in the same page.

I don't know each options so I won't be able to do it for all options, but if you want I could start with the one that I know Let me know.

AFAIR FastifySwaggerCustomOptions no longer exists in the latest version of @nestjs/swagger