Merge pull request #158 from atlassian/EDM-11606-fix-warning-log

Prevent example additional keyword from logging warning
atlassian · Feb 11, 2025 · d33f488 · d33f488
2 parents bc9d442 + 1262224
commit d33f488
Show file tree

Hide file tree

Showing 3 changed files with 64 additions and 0 deletions.
diff --git a/.changeset/sharp-donuts-kneel.md b/.changeset/sharp-donuts-kneel.md
@@ -0,0 +1,5 @@
+---
+'oas3-chow-chow': patch
+---
+
+Prevent example keyword from causing warning logs when present in openapi spec
diff --git a/__test__/chow-strict.spec.ts b/__test__/chow-strict.spec.ts
@@ -46,4 +46,57 @@ describe('strict mode', () => {
     );
     warnSpy.mockRestore();
   });
+
+  it('should not log warning about example keyword', async () => {
+    const warnSpy = jest.spyOn(console, 'warn').mockImplementation();
+    const doc: OpenAPIObject = {
+      openapi: '3.0.1',
+      info: {
+        title: 'service open api spec',
+        version: '1.0.1',
+      },
+      components: {
+        schemas: {
+          ResolveUnsupportedError: {
+            type: 'object',
+            description: 'some description',
+            properties: {
+              error: {
+                type: 'object',
+                properties: {
+                  message: {
+                    type: 'string',
+                    example: 'some example',
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      paths: {
+        '/resolve': {
+          post: {
+            operationId: 'resolve',
+            responses: {
+              '404': {
+                content: {
+                  'application/json': {
+                    schema: {
+                      $ref: '#/components/schemas/ResolveUnsupportedError',
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    };
+    expect(await ChowChow.create(doc)).toBeDefined();
+    expect(warnSpy).not.toHaveBeenCalledWith(
+      'strict mode: unknown keyword: "example"'
+    );
+    warnSpy.mockRestore();
+  });
 });
diff --git a/src/compiler/CompiledSchema.ts b/src/compiler/CompiledSchema.ts
@@ -36,6 +36,12 @@ export default class CompiledSchema {
       validate: (schema: any) =>
         schema ? context.schemaContext === 'response' : true,
     });
+    ajvInstance.addKeyword({
+      keyword: 'example',
+      metaSchema: {
+        type: ['object', 'array', 'string', 'number', 'boolean', 'null'],
+      },
+    });
     this.validator = ajvInstance.compile(schemaObject);
   }