refactor: update getTags() function to handle webhooks (#833)

* refactor: update getTags() function to handle webhooks

* chore: bump @readme/oas-examples

* chore: update getTags() comment since it supports webhooks

* test: update test to correct casing

packages/oas/src/index.ts

@@ -734,7 +734,6 @@ export default class Oas {
   /**
    * Return an array of all tag names that exist on this API definition.
    *
-   * Note: This method right now does **not** factor in webhooks that have tags.
    *
    * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#oasObject}
    * @see {@link https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object}
@@ -758,6 +757,20 @@ export default class Oas {
       });
     });
 
+    Object.entries(this.getWebhooks()).forEach(([path, webhooks]) => {
+      Object.values(webhooks).forEach(webhook => {
+        const tags = webhook.getTags();
+        if (setIfMissing && !tags.length) {
+          allTags.add(path);
+          return;
+        }
+
+        tags.forEach(tag => {
+          allTags.add(tag.name);
+        });
+      });
+    });
+
     return Array.from(allTags);
   }
 

packages/oas/test/index.test.ts

@@ -527,6 +527,7 @@ describe('#operation()', () => {
       responses: {
         200: expect.any(Object),
       },
+      tags: expect.any(Array),
     });
   });
 
@@ -1613,8 +1614,9 @@ describe('#getWebhooks()', () => {
 });
 
 describe('#getTags()', () => {
-  it('should all tags that are present in a definition', () => {
+  it('should return all tags that are present in a definition', () => {
     expect(petstore.getTags()).toStrictEqual(['pet', 'store', 'user']);
+    expect(webhooks.getTags()).toStrictEqual(['Webhooks']);
   });
 
   describe('setIfMissing option', () => {