From 524f6aa6cb5bcd5def97252923e2f4a5e3978018 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20My=C5=9Bliwiec?= Date: Mon, 28 Oct 2024 15:32:01 +0100 Subject: [PATCH] chore: update readme --- README.md | 40 +--------------------------------------- 1 file changed, 1 insertion(+), 39 deletions(-) diff --git a/README.md b/README.md index 8917fb2b4..82fb01e9f 100644 --- a/README.md +++ b/README.md @@ -25,51 +25,13 @@ ## Installation ```bash -$ npm i --save @nestjs/swagger +$ npm i --save @nestjs/swagger ``` ## Quick Start [Overview & Tutorial](https://docs.nestjs.com/openapi/introduction) -## Migration from v3 - -If you're currently using `@nestjs/swagger@3.*`, note the following breaking/API changes in version 4.0. - -The following decorators have been changed/renamed: - -- `@ApiModelProperty` is now `@ApiProperty` -- `@ApiModelPropertyOptional` is now `@ApiPropertyOptional` -- `@ApiResponseModelProperty` is now `@ApiResponseProperty` -- `@ApiImplicitQuery` is now `@ApiQuery` -- `@ApiImplicitParam` is now `@ApiParam` -- `@ApiImplicitBody` is now `@ApiBody` -- `@ApiImplicitHeader` is now `@ApiHeader` -- `@ApiOperation({ title: 'test' })` is now `@ApiOperation({ summary: 'test' })` -- `@ApiUseTags` is now `@ApiTags` - -The following decorators have been added: - -- `@ApiDefaultGetter` to generate [link objects](https://swagger.io/docs/specification/links/) together with `@ApiProperty({link: () => Type})` -- `@ApiLink` to directly generate link objects - -`DocumentBuilder` breaking changes (updated method signatures): - -- `addTag` -- `addBearerAuth` -- `addOAuth2` -- `setContactEmail` is now `setContact` -- `setHost` has been removed -- `setSchemes` has been removed (use the `addServer` instead, e.g., `addServer('http://')`) - -The following methods have been added: - -- `addServer` -- `addApiKey` -- `addBasicAuth` -- `addSecurity` -- `addSecurityRequirements` - ## Support Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).