Skip to content

Commit

Permalink
Update README.md openapi section for additional clarity (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
MannyNe authored Oct 27, 2024
1 parent fdc9d74 commit 538e3c0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,15 +555,15 @@ Prerequisites:

- `@nestjs/swagger` with version `^5.0.0` installed

Apply a patch:
Apply the patch `patchNestJsSwagger()` in your `main.ts` file before setting up your swagger module:

```ts
import { patchNestJsSwagger } from 'nestjs-zod'

patchNestJsSwagger()
```

Then follow the [Nest.js' Swagger Module Guide](https://docs.nestjs.com/openapi/introduction).
For addtional documentation, follow the [Nest.js' Swagger Module Guide](https://docs.nestjs.com/openapi/introduction), or you can see the example application guide [here](/packages/example/) .

### Writing more Swagger-compatible schemas

Expand Down

0 comments on commit 538e3c0

Please sign in to comment.