Merge pull request #3138 from MacMacky/fix/docs-open-api-types

docs(openapi): align types in intro page with code updates

content/openapi/introduction.md

@@ -119,16 +119,29 @@ export interface SwaggerDocumentOptions {
 
   /**
    * Custom operationIdFactory that will be used to generate the `operationId`
-   * based on the `controllerKey` and `methodKey`
-   * @default () => controllerKey_methodKey
+   * based on the `controllerKey`, `methodKey`, and version.
+   * @default () => controllerKey_methodKey_version
    */
-  operationIdFactory?: (controllerKey: string, methodKey: string) => string;
+  operationIdFactory?: OperationIdFactory;
+
+  /**
+   * Custom linkNameFactory that will be used to generate the name of links
+   * in the `links` field of responses
+   *
+   * @see [Link objects](https://swagger.io/docs/specification/links/)
+   *
+   * @default () => `${controllerKey}_${methodKey}_from_${fieldKey}`
+   */
+  linkNameFactory?: (
+    controllerKey: string,
+    methodKey: string,
+    fieldKey: string
+  ) => string;
 
   /*
    * Generate tags automatically based on the controller name.
    * If `false`, you must use the `@ApiTags()` decorator to define tags.
    * Otherwise, the controller name without the suffix `Controller` will be used.
-   *
    * @default true
    */
   autoTagControllers?: boolean;
@@ -197,10 +210,6 @@ export interface SwaggerCustomOptions {
   /**
    * If `true`, the selector of OpenAPI definitions is displayed in the Swagger UI interface.
    * Default: `false`.
-   *
-   * When `true` and `swaggerOptions.urls` is provided, a dropdown labeled "Select a definition"
-   * is shown in the Swagger UI, allowing users to select from the available API definitions
-   * specified in the `urls` array.
    */
   explorer?: boolean;