fix(specmap): suppress merging examples (#2437)

Refs swagger-api/swagger-ui#4175
swagger-api · Feb 2, 2022 · 2a88e2a · 2a88e2a
1 parent 2bd283a
commit 2a88e2a
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 0 deletions.
diff --git a/src/specmap/lib/all-of.js b/src/specmap/lib/all-of.js
@@ -75,6 +75,12 @@ export default {
       return undefined;
     });
 
+    // If there was an example in the original definition,
+    // keep it instead of merging with examples from other schema
+    if (originalDefinitionObj.example) {
+      // Delete other schema examples
+      patches.push(specmap.remove([].concat(parent, 'example')));
+    }
     // Merge back the values from the original definition
     patches.push(specmap.mergeDeep(parent, originalDefinitionObj));
 

diff --git a/test/specmap/all-of.js b/test/specmap/all-of.js
@@ -541,4 +541,102 @@ describe('allOf', () => {
         },
       });
     }));
+
+  // https://github.com/swagger-api/swagger-ui/issues/4175
+  test('should suppress merging examples when composing a schema', async () => {
+    const res = await mapSpec({
+      plugins: [plugins.refs, plugins.allOf],
+      spec: {
+        definitions: {
+          Pet: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+            },
+            example: {
+              name: 'my pet',
+            },
+          },
+          Cat: {
+            allOf: [
+              { $ref: '#/definitions/Pet' },
+              {
+                type: 'object',
+                properties: {
+                  meow: {
+                    type: 'string',
+                  },
+                },
+                example: {
+                  name: 'my cat',
+                  meow: 'meow',
+                },
+              },
+            ],
+          },
+          PetCat: {
+            allOf: [{ $ref: '#/definitions/Pet' }, { $ref: '#/definitions/Cat' }],
+            properties: {
+              id: {
+                type: 'string',
+              },
+            },
+            example: {
+              id: '1',
+            },
+          },
+        },
+      },
+    });
+    expect(res.errors).toEqual([]);
+    expect(res.spec).toEqual({
+      definitions: {
+        Pet: {
+          type: 'object',
+          properties: {
+            name: {
+              type: 'string',
+            },
+          },
+          example: {
+            name: 'my pet',
+          },
+        },
+        Cat: {
+          type: 'object',
+          properties: {
+            name: {
+              type: 'string',
+            },
+            meow: {
+              type: 'string',
+            },
+          },
+          example: {
+            name: 'my cat',
+            meow: 'meow',
+          },
+        },
+        PetCat: {
+          type: 'object',
+          properties: {
+            id: {
+              type: 'string',
+            },
+            name: {
+              type: 'string',
+            },
+            meow: {
+              type: 'string',
+            },
+          },
+          example: {
+            id: '1',
+          },
+        },
+      },
+    });
+  });
 });