nestjs-openapi-next 1.0.0 → 1.0.1

package/.idea/codeStyles/Project.xml

@@ -0,0 +1,70 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <HTMLCodeStyleSettings>
+      <option name="HTML_SPACE_INSIDE_EMPTY_TAG" value="true" />
+    </HTMLCodeStyleSettings>
+    <JSCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </JSCodeStyleSettings>
+    <JetCodeStyleSettings>
+      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
+    </JetCodeStyleSettings>
+    <TypeScriptCodeStyleSettings version="0">
+      <option name="FORCE_SEMICOLON_STYLE" value="true" />
+      <option name="SPACE_BEFORE_FUNCTION_LEFT_PARENTH" value="false" />
+      <option name="FORCE_QUOTE_STYlE" value="true" />
+      <option name="ENFORCE_TRAILING_COMMA" value="Remove" />
+      <option name="SPACES_WITHIN_OBJECT_LITERAL_BRACES" value="true" />
+      <option name="SPACES_WITHIN_IMPORTS" value="true" />
+    </TypeScriptCodeStyleSettings>
+    <VueCodeStyleSettings>
+      <option name="INTERPOLATION_NEW_LINE_AFTER_START_DELIMITER" value="false" />
+      <option name="INTERPOLATION_NEW_LINE_BEFORE_END_DELIMITER" value="false" />
+    </VueCodeStyleSettings>
+    <codeStyleSettings language="HTML">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JAVA">
+      <indentOptions>
+        <option name="USE_TAB_CHARACTER" value="true" />
+        <option name="SMART_TABS" value="true" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="JavaScript">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="TypeScript">
+      <option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="Vue">
+      <option name="SOFT_MARGINS" value="80" />
+      <indentOptions>
+        <option name="CONTINUATION_INDENT_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+    <codeStyleSettings language="kotlin">
+      <option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
+    </codeStyleSettings>
+  </code_scheme>
+</component>

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

package/.idea/compiler.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="TypeScriptCompiler">
+    <option name="useServicePoweredTypesEnabledManually" value="true" />
+  </component>
+</project>

package/.idea/copilot.data.migration.agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.ask2agent.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Ask2AgentMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/copilot.data.migration.edit.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EditMigrationStateService">
+    <option name="migrationStatus" value="COMPLETED" />
+  </component>
+</project>

package/.idea/easycode.ignore

@@ -0,0 +1,13 @@
+.idea
+.vscode
+node_modules/
+dist/
+vendor/
+cache/
+.*/
+*.min.*
+*.test.*
+*.spec.*
+*.bundle.*
+*.bundle-min.*
+*.log

package/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
+  </profile>
+</component>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/nestjs-openapi-next.iml" filepath="$PROJECT_DIR$/.idea/nestjs-openapi-next.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/nestjs-openapi-next.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/prettier.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PrettierConfiguration">
+    <option name="myConfigurationMode" value="AUTOMATIC" />
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -1,39 +1,32 @@
 # nestjs-openapi-next
 
-This repository is a fork of `@nestjs/swagger` (upstream: `nestjs/swagger`).
-
-Its goal is to add first-class support for key **OpenAPI 3.2** features (see PR #1), while keeping compatibility with existing `@nestjs/swagger` usage as much as possible.
-
-> Note: `package.json` currently still uses the package name `@nestjs/swagger`. If your project also depends on the upstream package, use lockfiles / overrides / resolutions to avoid dependency conflicts.
-
-## What this fork adds (PR #1)
-
-- **HTTP `QUERY` method (OAS 3.2)**
-  - `@ApiQueryMethod()` to explicitly emit an OpenAPI `query` operation.
-- **Enhanced Tags (OAS 3.2)**
-  - `@ApiTagGroup()` to define tag metadata including `parent` and `kind`, merged into top-level `document.tags`.
-  - `DocumentBuilder.addTag()` supports an additional `summary` field.
-- **Streaming responses (OAS 3.2)**
-  - `@ApiStreamingResponse()` to emit per-item schema via `itemSchema` (e.g. SSE `text/event-stream`).
-- **OAuth 2.0 Device Authorization Flow (OAS 3.2 / RFC 8628)**
-  - OpenAPI typings include `flows.deviceAuthorization`.
-  - `@ApiSecurityDeviceFlow()` convenience decorator for security requirements.
+`nestjs-openapi-next` is a fork of `@nestjs/swagger` (upstream: `nestjs/swagger`).
+The goal is to keep upstream behavior as compatible as possible while adding a set of **OpenAPI 3.2** features and widely-used **OpenAPI extension fields** (`x-`) that are commonly consumed by tools like Redoc.
+
+## Key differences from upstream
+
+- **Richer OpenAPI 3.2 typings**
+  - e.g. `TagObject.summary`, `OAuthFlowsObject.deviceAuthorization`, etc.
+- **Enhanced tag support**
+  - `@ApiTag(options)` (class/controller-level): defines tag metadata (`summary`, `x-displayName`, `description`, `parent`, `kind`, ...) and merges it into the top-level `document.tags`.
+  - `x-displayName` support for tags, mirrored with `summary` (setting either results in both fields being written with the same value).
+  - Root-level `x-tagGroups` support (commonly used by Redoc). If you use `parent` to form relationships, `x-tagGroups` is auto-derived; you can also set it explicitly via `DocumentBuilder`.
+- **Additional OAS 3.2 behaviors**
+  - HTTP `QUERY` method via `@ApiQueryMethod()` (emits `paths['/x'].query`).
+  - Streaming responses via `@ApiStreamingResponse()` (`itemSchema`, e.g. SSE `text/event-stream`).
+  - OAuth2 Device Authorization Flow typing + `@ApiSecurityDeviceFlow()` helper.
+- **Convenience APIs**
+  - `DocumentBuilder.addServerWithName()` for a non-standard-but-common `server.name`.
 
 Test coverage: `test/openapi-3-2.spec.ts`.
 
 ## Compatibility
 
 - **NestJS**: peerDependencies target `@nestjs/common` / `@nestjs/core` `^11.0.1`
-- **Runtime deps**: generally aligned with `@nestjs/swagger` (e.g. `reflect-metadata`, optional `class-validator` / `class-transformer`, etc.)
+- **Runtime deps**: aligned with upstream `@nestjs/swagger` (`reflect-metadata`, optional `class-validator` / `class-transformer`, etc.)
 
 ## Installation
 
-### Install from this fork (recommended for OAS 3.2 extensions)
-
-```bash
-npm i --save github:undownding/nestjs-openapi-next
-```
-
 ### Install from npm
 
 ```bash
@@ -44,98 +37,121 @@ npm i --save nestjs-openapi-next
 
 See the official Nest OpenAPI tutorial: `https://docs.nestjs.com/openapi/introduction`
 
-Typical setup (minimal skeleton):
-
 ```ts
 import { NestFactory } from '@nestjs/core';
-import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { DocumentBuilder, SwaggerModule } from 'nestjs-openapi-next';
 
-// ...
 const app = await NestFactory.create(AppModule);
 
 const config = new DocumentBuilder()
   .setTitle('Example')
   .setDescription('API description')
   .setVersion('1.0')
-  // If you want to declare OAS 3.2 in the document, set it explicitly:
+  // If you want the document to declare OAS 3.2, set it explicitly:
   .setOpenAPIVersion('3.2.0')
   .build();
 
 const document = SwaggerModule.createDocument(app, config);
 SwaggerModule.setup('api', app, document);
-
-await app.listen(3000);
 ```
 
-## OpenAPI 3.2 extensions
+## Usage
 
-### 1) HTTP QUERY method: `@ApiQueryMethod()`
+### 1) `@ApiTag(options)` (recommended) and deprecation of `@ApiTagGroup()`
 
-OAS 3.2 supports a `query` operation under `paths`. This decorator makes a Nest handler emit a `query` operation **in the generated OpenAPI document**.
+`@ApiTag(options)` is the primary decorator for defining tag metadata at the controller level.
+
+`@ApiTagGroup(options)` is kept as a backward-compatible alias, but is **deprecated** and may be removed in a future major version.
 
 ```ts
-import { Controller, Post } from '@nestjs/common';
-import { ApiQueryMethod } from '@nestjs/swagger';
+import { Controller, Get } from '@nestjs/common';
+import { ApiTag } from 'nestjs-openapi-next';
 
-@Controller()
-export class QueryController {
-  @Post('search')
-  @ApiQueryMethod()
-  search() {
-    return { ok: true };
+@ApiTag({
+  name: 'Customers',
+  summary: 'Customers'
+  // you may also set: 'x-displayName': 'Customers'
+})
+@Controller('customers')
+export class CustomersController {
+  @Get()
+  list() {
+    return [];
   }
 }
 ```
 
-- Output: `document.paths['/search'].query` is defined (and `post` is not emitted for that handler).
-- Important: this does **not** change Nest routing at runtime — it only affects the generated OpenAPI document.
+### 2) Tag `x-displayName` (mirrored with `summary`)
+
+This fork treats tag `summary` and `x-displayName` as equivalent display fields:
 
-### 2) Enhanced Tags: `@ApiTagGroup()`
+- set either one;
+- the generated `document.tags` will contain **both** `summary` and `x-displayName` with the same value.
 
-OAS 3.2 Enhanced Tags allow nesting and classification via `parent` and `kind`.
+### 3) Root-level `x-tagGroups` (tag grouping)
+
+#### Auto-derived (recommended)
+
+If you use tag `parent` relationships (via `@ApiTag()`), the root-level `x-tagGroups` will be derived automatically:
 
 ```ts
-import { Controller, Get } from '@nestjs/common';
-import { ApiTagGroup } from '@nestjs/swagger';
-
-@ApiTagGroup({
-  name: 'Cats',
-  summary: 'Cats',
-  description: 'Cat operations',
-  parent: 'Admin',
-  kind: 'nav'
-})
-@Controller('cats')
-export class CatsController {
-  @Get()
-  list() {
-    return [];
-  }
-}
+@ApiTag({ name: 'Customers' })
+@Controller('customers')
+export class CustomersController {}
+
+@ApiTag({ name: 'Customer Authentication', parent: 'Customers' })
+@Controller('auth')
+export class AuthController {}
+```
+
+Illustrative output:
+
+```yaml
+tags:
+  - name: Customers
+  - name: Customer Authentication
+x-tagGroups:
+  - name: Customers
+    tags:
+      - Customers
+      - Customer Authentication
 ```
 
-- `@ApiTagGroup()` also ensures operations are tagged (internally it behaves like applying `@ApiTags(name)`).
-- During scanning, tag group metadata is merged into top-level `document.tags` and then merged with tags coming from `DocumentBuilder`.
+#### Manual configuration
 
-#### `DocumentBuilder.addTag()` supports `summary`
+You can also set `x-tagGroups` explicitly via `DocumentBuilder.addTagGroup()`:
 
 ```ts
-new DocumentBuilder()
-  .addTag('Cats', 'Cat operations', undefined, 'Cats')
+const config = new DocumentBuilder()
+  .setTitle('t')
+  .setVersion('1')
+  .addTag('Customers')
+  .addTag('Customer Authentication')
+  .addTagGroup('Customers', ['Customers', 'Customer Authentication'])
   .build();
 ```
 
-Signature (adds the 4th argument compared to upstream):
+### 4) HTTP `QUERY` method: `@ApiQueryMethod()`
 
-- `addTag(name, description?, externalDocs?, summary?)`
+```ts
+import { Controller, Post } from '@nestjs/common';
+import { ApiQueryMethod } from 'nestjs-openapi-next';
 
-### 3) Streaming responses: `@ApiStreamingResponse()` (`itemSchema`)
+@Controller()
+export class QueryController {
+  @Post('search')
+  @ApiQueryMethod()
+  search() {
+    return { ok: true };
+  }
+}
+```
 
-For streaming responses (e.g. SSE), OAS 3.2 supports describing each streamed item via `itemSchema` under the media type.
+### 5) Streaming responses: `@ApiStreamingResponse()` (`itemSchema`)
 
 ```ts
 import { Controller, Get } from '@nestjs/common';
-import { ApiProperty, ApiStreamingResponse } from '@nestjs/swagger';
+import { ApiProperty, ApiStreamingResponse } from 'nestjs-openapi-next';
 
 class SseItemDto {
   @ApiProperty()
@@ -156,17 +172,11 @@ export class EventsController {
 }
 ```
 
-Result (illustrative):
-
-- `responses['200'].content['text/event-stream'].itemSchema` -> `#/components/schemas/SseItemDto`
-
-### 4) OAuth2 Device Authorization Flow: `flows.deviceAuthorization` + `@ApiSecurityDeviceFlow()`
-
-Define the OAuth2 scheme (with `flows.deviceAuthorization`) via `DocumentBuilder.addOAuth2()`, then declare per-operation requirements with the decorator.
+### 6) OAuth2 Device Authorization Flow: `flows.deviceAuthorization` + `@ApiSecurityDeviceFlow()`
 
 ```ts
 import { Controller, Get } from '@nestjs/common';
-import { ApiSecurityDeviceFlow, DocumentBuilder } from '@nestjs/swagger';
+import { ApiSecurityDeviceFlow, DocumentBuilder } from 'nestjs-openapi-next';
 
 @Controller()
 export class SecuredController {
@@ -196,15 +206,29 @@ const config = new DocumentBuilder()
   .build();
 ```
 
-Notes:
+### 7) OpenAPI 3.1 Webhooks: `@ApiWebhook()`
 
-- `@ApiSecurityDeviceFlow()` is a convenience wrapper around `@ApiSecurity(name, scopes)` for requirements.
-- The device flow scheme definition still comes from `addOAuth2({ flows: { deviceAuthorization: ... } })`.
+OpenAPI 3.1 introduces a root-level `webhooks` object for out-of-band callbacks
+initiated by the API provider.
 
-## Upstream relationship / migration notes
+This fork supports emitting webhook operations via a decorator:
+
+```ts
+import { Controller, Post } from '@nestjs/common';
+import { ApiWebhook } from '@nestjs/swagger';
+
+@Controller()
+export class StripeWebhooksController {
+  @Post('stripe')
+  @ApiWebhook('stripeEvent')
+  stripe() {
+    return { ok: true };
+  }
+}
+```
 
-- The OAS 3.2 support in PR #1 is implemented as an additive extension to minimize breaking changes.
-- If you don’t use the new decorators/fields, behavior should be broadly compatible with upstream `@nestjs/swagger`.
+The generated document will contain `document.webhooks.stripeEvent.post`, and the
+corresponding route will **not** be emitted under `document.paths`.
 
 ## License
 

package/dist/constants.d.ts

@@ -7,6 +7,7 @@ export declare const DECORATORS: {
     API_TAGS: string;
     API_TAG_GROUP: string;
     API_QUERY_METHOD: string;
+    API_WEBHOOK: string;
     API_CALLBACKS: string;
     API_PARAMETERS: string;
     API_HEADERS: string;

package/dist/constants.js

@@ -10,6 +10,7 @@ exports.DECORATORS = {
     API_TAGS: `${exports.DECORATORS_PREFIX}/apiUseTags`,
     API_TAG_GROUP: `${exports.DECORATORS_PREFIX}/apiTagGroup`,
     API_QUERY_METHOD: `${exports.DECORATORS_PREFIX}/apiQueryMethod`,
+    API_WEBHOOK: `${exports.DECORATORS_PREFIX}/apiWebhook`,
     API_CALLBACKS: `${exports.DECORATORS_PREFIX}/apiCallbacks`,
     API_PARAMETERS: `${exports.DECORATORS_PREFIX}/apiParameters`,
     API_HEADERS: `${exports.DECORATORS_PREFIX}/apiHeaders`,

package/dist/decorators/api-tag-group.decorator.d.ts

@@ -1,11 +1,15 @@
 import { TagObject } from '../interfaces/open-api-spec.interface';
-export type ApiTagGroupKind = 'audience' | 'badge' | 'nav' | (string & {});
-export interface ApiTagGroupOptions extends Pick<TagObject, 'name' | 'summary' | 'description' | 'externalDocs' | 'parent' | 'kind'> {
+export type ApiTagKind = 'audience' | 'badge' | 'nav' | (string & {});
+export type ApiTagGroupKind = ApiTagKind;
+export interface ApiTagOptions extends Pick<TagObject, 'name' | 'summary' | 'x-displayName' | 'description' | 'externalDocs' | 'parent' | 'kind'> {
     name: string;
     summary?: string;
+    'x-displayName'?: string;
     description?: string;
     externalDocs?: TagObject['externalDocs'];
     parent?: string;
-    kind?: ApiTagGroupKind;
+    kind?: ApiTagKind;
 }
-export declare function ApiTagGroup(options: ApiTagGroupOptions): ClassDecorator;
+export declare function ApiTag(options: ApiTagOptions): ClassDecorator;
+export declare function ApiTagGroup(options: ApiTagOptions): ClassDecorator;
+export type ApiTagGroupOptions = ApiTagOptions;

package/dist/decorators/api-tag-group.decorator.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiTag = ApiTag;
 exports.ApiTagGroup = ApiTagGroup;
 const constants_1 = require("../constants");
 const api_use_tags_decorator_1 = require("./api-use-tags.decorator");
-function ApiTagGroup(options) {
+function ApiTag(options) {
     return (target) => {
         const previous = Reflect.getMetadata(constants_1.DECORATORS.API_TAG_GROUP, target) || [];
         Reflect.defineMetadata(constants_1.DECORATORS.API_TAG_GROUP, [...previous, options], target);
@@ -11,3 +12,6 @@ function ApiTagGroup(options) {
         return target;
     };
 }
+function ApiTagGroup(options) {
+    return ApiTag(options);
+}

package/dist/decorators/api-webhook.decorator.d.ts

@@ -0,0 +1 @@
+export declare function ApiWebhook(name?: string): MethodDecorator;

package/dist/decorators/api-webhook.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiWebhook = ApiWebhook;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiWebhook(name) {
+    return (0, helpers_1.createMethodDecorator)(constants_1.DECORATORS.API_WEBHOOK, name !== null && name !== void 0 ? name : true);
+}

package/dist/decorators/index.d.ts

@@ -17,6 +17,7 @@ export * from './api-produces.decorator';
 export { ApiProperty, ApiPropertyOptional, ApiPropertyOptions, ApiResponseProperty } from './api-property.decorator';
 export * from './api-query.decorator';
 export * from './api-query-method.decorator';
+export * from './api-webhook.decorator';
 export * from './api-response.decorator';
 export * from './api-streaming-response.decorator';
 export * from './api-security.decorator';

package/dist/decorators/index.js

@@ -37,6 +37,7 @@ Object.defineProperty(exports, "ApiPropertyOptional", { enumerable: true, get: f
 Object.defineProperty(exports, "ApiResponseProperty", { enumerable: true, get: function () { return api_property_decorator_1.ApiResponseProperty; } });
 __exportStar(require("./api-query.decorator"), exports);
 __exportStar(require("./api-query-method.decorator"), exports);
+__exportStar(require("./api-webhook.decorator"), exports);
 __exportStar(require("./api-response.decorator"), exports);
 __exportStar(require("./api-streaming-response.decorator"), exports);
 __exportStar(require("./api-security.decorator"), exports);

package/dist/document-builder.d.ts

@@ -12,9 +12,11 @@ export declare class DocumentBuilder {
     setLicense(name: string, url: string): this;
     setOpenAPIVersion(version: string): this;
     addServer(url: string, description?: string, variables?: Record<string, ServerVariableObject>): this;
+    addServerWithName(name: string, url: string, description?: string, variables?: Record<string, ServerVariableObject>): this;
     setExternalDoc(description: string, url: string): this;
     setBasePath(path: string): this;
     addTag(name: string, description?: string, externalDocs?: ExternalDocumentationObject, summary?: string): this;
+    addTagGroup(name: string, tags: string[]): this;
     addExtension(extensionKey: string, extensionProperties: any, location?: ExtensionLocation): this;
     addSecurity(name: string, options: SecuritySchemeObject): this;
     addGlobalResponse(...respones: ApiResponseOptions[]): this;

package/dist/document-builder.js

@@ -48,6 +48,10 @@ class DocumentBuilder {
         this.document.servers.push({ url, description, variables });
         return this;
     }
+    addServerWithName(name, url, description, variables) {
+        this.document.servers.push({ name, url, description, variables });
+        return this;
+    }
     setExternalDoc(description, url) {
         this.document.externalDocs = { description, url };
         return this;
@@ -57,14 +61,21 @@ class DocumentBuilder {
         return this;
     }
     addTag(name, description = '', externalDocs, summary) {
+        const normalizedSummary = summary;
         this.document.tags = this.document.tags.concat((0, lodash_1.pickBy)({
             name,
-            summary,
+            summary: normalizedSummary,
+            'x-displayName': normalizedSummary,
             description,
             externalDocs
         }, (0, lodash_1.negate)(lodash_1.isUndefined)));
         return this;
     }
+    addTagGroup(name, tags) {
+        const existing = this.document['x-tagGroups'] || [];
+        this.document['x-tagGroups'] = existing.concat({ name, tags });
+        return this;
+    }
     addExtension(extensionKey, extensionProperties, location = 'root') {
         if (!extensionKey.startsWith('x-')) {
             throw new Error('Extension key is not prefixed. Please ensure you prefix it with `x-`.');

package/dist/extra/swagger-shim.d.ts

@@ -71,9 +71,11 @@ export declare function ApiSchema(): () => void;
 export declare function ApiSecurity(): () => void;
 export declare function ApiSecurityDeviceFlow(): () => void;
 export declare function ApiTags(): () => void;
+export declare function ApiTag(): () => void;
 export declare function ApiTagGroup(): () => void;
 export declare function ApiCallbacks(): () => void;
 export declare function ApiQueryMethod(): () => void;
+export declare function ApiWebhook(): () => void;
 export declare function ApiStreamingResponse(): () => void;
 export declare function ApiLink(): () => void;
 export declare function ApiDefaultGetter(): () => void;

package/dist/extra/swagger-shim.js

@@ -73,9 +73,11 @@ exports.ApiSchema = ApiSchema;
 exports.ApiSecurity = ApiSecurity;
 exports.ApiSecurityDeviceFlow = ApiSecurityDeviceFlow;
 exports.ApiTags = ApiTags;
+exports.ApiTag = ApiTag;
 exports.ApiTagGroup = ApiTagGroup;
 exports.ApiCallbacks = ApiCallbacks;
 exports.ApiQueryMethod = ApiQueryMethod;
+exports.ApiWebhook = ApiWebhook;
 exports.ApiStreamingResponse = ApiStreamingResponse;
 exports.ApiLink = ApiLink;
 exports.ApiDefaultGetter = ApiDefaultGetter;
@@ -309,6 +311,9 @@ function ApiSecurityDeviceFlow() {
 function ApiTags() {
     return () => { };
 }
+function ApiTag() {
+    return () => { };
+}
 function ApiTagGroup() {
     return () => { };
 }
@@ -318,6 +323,9 @@ function ApiCallbacks() {
 function ApiQueryMethod() {
     return () => { };
 }
+function ApiWebhook() {
+    return () => { };
+}
 function ApiStreamingResponse() {
     return () => { };
 }

package/dist/interfaces/denormalized-doc.interface.d.ts

@@ -3,6 +3,8 @@ export interface DenormalizedDoc extends Partial<OpenAPIObject> {
     root?: {
         method: string;
         path: string;
+        isWebhook?: boolean;
+        webhookName?: string;
     } & OperationObject;
     responses?: ResponsesObject;
 }