Skip to content

Commit 27d1890

Browse files
2 parents 9b77845 + 1a22faa commit 27d1890

File tree

4 files changed

+20
-11
lines changed

4 files changed

+20
-11
lines changed

.nvmrc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
20.18.0
1+
22.11.0

content/openapi/introduction.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,29 @@ export interface SwaggerDocumentOptions {
119119
120120
/**
121121
* Custom operationIdFactory that will be used to generate the `operationId`
122-
* based on the `controllerKey` and `methodKey`
123-
* @default () => controllerKey_methodKey
122+
* based on the `controllerKey`, `methodKey`, and version.
123+
* @default () => controllerKey_methodKey_version
124124
*/
125-
operationIdFactory?: (controllerKey: string, methodKey: string) => string;
125+
operationIdFactory?: OperationIdFactory;
126+
127+
/**
128+
* Custom linkNameFactory that will be used to generate the name of links
129+
* in the `links` field of responses
130+
*
131+
* @see [Link objects](https://swagger.io/docs/specification/links/)
132+
*
133+
* @default () => `${controllerKey}_${methodKey}_from_${fieldKey}`
134+
*/
135+
linkNameFactory?: (
136+
controllerKey: string,
137+
methodKey: string,
138+
fieldKey: string
139+
) => string;
126140
127141
/*
128142
* Generate tags automatically based on the controller name.
129143
* If `false`, you must use the `@ApiTags()` decorator to define tags.
130144
* Otherwise, the controller name without the suffix `Controller` will be used.
131-
*
132145
* @default true
133146
*/
134147
autoTagControllers?: boolean;
@@ -197,10 +210,6 @@ export interface SwaggerCustomOptions {
197210
/**
198211
* If `true`, the selector of OpenAPI definitions is displayed in the Swagger UI interface.
199212
* Default: `false`.
200-
*
201-
* When `true` and `swaggerOptions.urls` is provided, a dropdown labeled "Select a definition"
202-
* is shown in the Swagger UI, allowing users to select from the available API definitions
203-
* specified in the `urls` array.
204213
*/
205214
explorer?: boolean;
206215

content/recipes/prisma.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
While Prisma can be used with plain JavaScript, it embraces TypeScript and provides a level to type-safety that goes beyond the guarantees other ORMs in the TypeScript ecosystem. You can find an in-depth comparison of the type-safety guarantees of Prisma and TypeORM [here](https://www.prisma.io/docs/concepts/more/comparisons/prisma-and-typeorm#type-safety).
66

7-
> info **Note** If you want to get a quick overview of how Prisma works, you can follow the [Quickstart](https://www.prisma.io/docs/getting-started/quickstart) or read the [Introduction](https://www.prisma.io/docs/understand-prisma/introduction) in the [documentation](https://www.prisma.io/docs/). There also are ready-to-run examples for [REST](https://github.com/prisma/prisma-examples/tree/latest/typescript/rest-nestjs) and [GraphQL](https://github.com/prisma/prisma-examples/tree/latest/typescript/graphql-nestjs) in the [`prisma-examples`](https://github.com/prisma/prisma-examples/) repo.
7+
> info **Note** If you want to get a quick overview of how Prisma works, you can follow the [Quickstart](https://www.prisma.io/docs/getting-started/quickstart) or read the [Introduction](https://www.prisma.io/docs/understand-prisma/introduction) in the [documentation](https://www.prisma.io/docs/). There also are ready-to-run examples for [REST](https://github.com/prisma/prisma-examples/tree/latest/orm/rest-nestjs) and [GraphQL](https://github.com/prisma/prisma-examples/tree/latest/orm/graphql-nestjs) in the [`prisma-examples`](https://github.com/prisma/prisma-examples/) repo.
88
99
#### Getting started
1010

content/recipes/swc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Now if you use CLI plugins, `swc-loader` will not load them automatically. Inste
134134
declare a `generate-metadata.ts` file near the `main.ts` file with the following content:
135135

136136
```ts
137-
import { PluginMetadataGenerator } from '@nestjs/cli/lib/compiler/plugins';
137+
import { PluginMetadataGenerator } from '@nestjs/cli/lib/compiler/plugins/plugin-metadata-generator';
138138
import { ReadonlyVisitor } from '@nestjs/swagger/dist/plugin';
139139

140140
const generator = new PluginMetadataGenerator();

0 commit comments

Comments
 (0)