Support for webhoooks tags (#49)

Author: eranelbaz

README.md

@@ -498,6 +498,26 @@ export namespace MyApi {
 }
 ```
 
+You can also add Webhook tags by using `webhookTags` keyword it will auto add tag to all webhooks
+```yaml
+custom:
+  documentation:
+    apiNamespace: MyApi
+    webhookTags:
+      - name: ProjectWebhooks
+        description: This is the description for ProjectWebhooks
+    webhooks:
+      WebhookName:
+        post:
+          requestBody:
+            description: |
+              This is a request body description
+          responses:
+            200:
+              description: |
+                This is a expected response description
+```
+
 
 ## Install
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-openapi-typescript",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "An extension of @conqa/serverless-openapi-documentation that also generates your OpenAPI models from TypeScript",
   "main": "dist/index.js",
   "scripts": {

src/serverless-openapi-typescript.ts

@@ -69,6 +69,10 @@ export default class ServerlessOpenapiTypeScript {
       return this.serverless.service.custom.documentation.webhooks || {};
     }
 
+    get webhookTags() {
+      return (this.serverless.service.custom.documentation.webhookTags || []).map(tag => tag.name);
+    }
+
     log(msg) {
         this.serverless.cli.log(`[serverless-openapi-typescript] ${msg}`);
     }
@@ -104,6 +108,7 @@ export default class ServerlessOpenapiTypeScript {
           const webhook = this.webhooks[webhookName];
           const methodDefinition = webhook['post'];
           if (methodDefinition) {
+            methodDefinition.tags = this.webhookTags;
             this.setWebhookModels(methodDefinition, webhookName);
             this.log(`Generating docs for webhook ${webhookName}`);
           }

test/fixtures/expect-openapi-full.yml

@@ -247,6 +247,7 @@ webhooks:
         '200':
           description: |
             This is a expected response description
+      tags: []
 tags:
   - name: Project
     description: >

test/fixtures/expect-openapi-webhooks-custom-tags.yml

@@ -0,0 +1,38 @@
+openapi: 3.1.0
+components:
+  schemas:
+    ProjectApi.Webhooks.OnCreateWebhook:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+      required:
+        - id
+        - name
+      additionalProperties: false
+info:
+  title: ProjectApi
+  description: DummyDescription
+paths: { }
+webhooks:
+  OnCreateWebhook:
+    post:
+      requestBody:
+        description: |
+          This is a request body description
+        content:
+          application/json:
+            schema:
+              $ref: >-
+                #/components/schemas/ProjectApi.Webhooks.OnCreateWebhook
+      responses:
+        '200':
+          description: |
+            This is a expected response description
+      tags:
+        - ProjectWebhooks
+tags:
+  - name: ProjectApi
+    description: DummyDescription

test/fixtures/expect-openapi-webhooks.yml

@@ -31,6 +31,7 @@ webhooks:
         '200':
           description: |
             This is a expected response description
+      tags: []
 tags:
   - name: Project
     description: DummyDescription

test/serverless-openapi-typescript.spec.ts

@@ -17,6 +17,7 @@ describe('ServerlessOpenapiTypeScript', () => {
     ${'Hyphenated Functions'}  | ${'hyphenated-functions'}
     ${'Full Project'} | ${'full'}
     ${'Webhooks'} | ${'webhooks'}
+    ${'Webhooks Tags'} | ${'webhooks-custom-tags'}
     `('when using $testCase', ({projectName}) => {
 
         beforeEach(async () => {

test/serverless-webhooks-custom-tags/api.d.ts

@@ -0,0 +1,8 @@
+export namespace ProjectApi {
+  export namespace Webhooks {
+    export type OnCreateWebhook = {
+      id: string;
+      name: string;
+    }
+  }
+}

test/serverless-webhooks-custom-tags/resources/serverless.yml

@@ -0,0 +1,26 @@
+service: serverless-openapi-typescript-demo
+provider:
+  name: aws
+
+plugins:
+  - ../node_modules/@conqa/serverless-openapi-documentation
+  - ../src/index
+
+custom:
+  documentation:
+    title: 'ProjectApi'
+    description: DummyDescription
+    apiNamespace: ProjectApi
+    webhookTags:
+      - name: ProjectWebhooks
+        description: This is the description for ProjectWebhooks
+    webhooks:
+      OnCreateWebhook:
+        post:
+          requestBody:
+            description: |
+              This is a request body description
+          responses:
+            200:
+              description: |
+                This is a expected response description