fix: exapand check for operation id duplciates to include referenced …

…paths
IBM · Apr 10, 2019 · 21e2460 · 21e2460
1 parent cb3545a
commit 21e2460
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 4 deletions.
diff --git a/src/plugins/validation/2and3/semantic-validators/operation-ids.js b/src/plugins/validation/2and3/semantic-validators/operation-ids.js
@@ -5,7 +5,7 @@ const reduce = require('lodash/reduce');
 const merge = require('lodash/merge');
 const each = require('lodash/each');
 
-module.exports.validate = function({ jsSpec }) {
+module.exports.validate = function({ resolvedSpec }) {
   const errors = [];
   const warnings = [];
 
@@ -21,7 +21,7 @@ module.exports.validate = function({ jsSpec }) {
   ];
 
   const operations = reduce(
-    jsSpec.paths,
+    resolvedSpec.paths,
     (arr, path, pathKey) => {
       const pathOps = pickBy(path, (obj, k) => {
         return validOperationKeys.indexOf(k) > -1;

diff --git a/test/plugins/validation/2and3/operation-ids.js b/test/plugins/validation/2and3/operation-ids.js
@@ -1,4 +1,5 @@
 const expect = require('expect');
+const resolver = require('json-schema-ref-parser');
 const {
   validate
 } = require('../../../../src/plugins/validation/2and3/semantic-validators/operation-ids');
@@ -20,7 +21,7 @@ describe('validation plugin - semantic - operation-ids', function() {
       }
     };
 
-    const res = validate({ jsSpec: spec });
+    const res = validate({ resolvedSpec: spec });
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual('paths./coolPath.get.operationId');
     expect(res.errors[0].message).toEqual('operationIds must be unique');
@@ -49,10 +50,51 @@ describe('validation plugin - semantic - operation-ids', function() {
       }
     };
 
-    const res = validate({ jsSpec: spec });
+    const res = validate({ resolvedSpec: spec });
     expect(res.errors.length).toEqual(1);
     expect(res.errors[0].path).toEqual('paths./greatPath.put.operationId');
     expect(res.errors[0].message).toEqual('operationIds must be unique');
     expect(res.warnings.length).toEqual(0);
   });
+
+  it('should complain about a repeated operationId in a shared path item', async function() {
+    const spec = {
+      paths: {
+        '/coolPath': {
+          $ref: '#/components/paths/SharedPath'
+        },
+        '/greatPath': {
+          $ref: '#/components/paths/SharedPath'
+        }
+      },
+      components: {
+        paths: {
+          SharedPath: {
+            get: {
+              operationId: 'shouldBeUnique',
+              responses: {
+                '200': {
+                  content: {
+                    'application/json': {
+                      schema: {
+                        type: 'string'
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    };
+
+    const resolvedSpec = await resolver.dereference(spec);
+
+    const res = validate({ resolvedSpec });
+    expect(res.errors.length).toEqual(1);
+    expect(res.errors[0].path).toEqual('paths./greatPath.get.operationId');
+    expect(res.errors[0].message).toEqual('operationIds must be unique');
+    expect(res.warnings.length).toEqual(0);
+  });
 });