feat: exclude common inconsistent property names (#230)

Author: Christian Compton

README.md

@@ -483,7 +483,7 @@ The default values for each rule are described below.
 | no_property_description     | warning |
 | description_mentions_json   | warning |
 | array_of_arrays             | warning |
-| inconsistent_property_type  | warning |
+| inconsistent_property_type  | warning, [code, default, type, value]]<br>(list of property names to exclude)|
 | property_case_convention    | error, lower_snake_case |
 | property_case_collision     | error   |
 | enum_case_convention        | warning, lower_snake_case |

src/.defaultsForValidator.js

@@ -65,7 +65,7 @@ const defaults = {
       'no_property_description': 'warning',
       'description_mentions_json': 'warning',
       'array_of_arrays': 'warning',
-      'inconsistent_property_type': 'warning',
+      'inconsistent_property_type': ['warning', ['code', 'default', 'type', 'value']],
       'property_case_convention': [ 'error', 'lower_snake_case'],
       'property_case_collision': 'error',
       'enum_case_convention': [ 'warning', 'lower_snake_case'],

src/plugins/validation/2and3/semantic-validators/schema-ibm.js

@@ -617,23 +617,26 @@ function checkProperties(
             messages.addMessage(
               propertiesToCompare[key].path,
               `Property has inconsistent type: ${key}.`,
-              configOption,
+              configOption[0],
               'inconsistent_property_type'
             );
           }
           messages.addMessage(
             contextPath.concat(['properties', key]).join('.'),
             `Property has inconsistent type: ${key}.`,
-            configOption,
+            configOption[0],
             'inconsistent_property_type'
           );
         }
       } else {
-        propertiesToCompare[key] = {
-          type: value.type,
-          path: contextPath.concat(['properties', key]).join('.'),
-          printed: false
-        };
+        if (configOption && configOption[1] && !configOption[1].includes(key)) {
+          // add property if the name is not excluded
+          propertiesToCompare[key] = {
+            type: value.type,
+            path: contextPath.concat(['properties', key]).join('.'),
+            printed: false
+          };
+        }
       }
     }
   }

test/plugins/validation/2and3/schema-ibm.test.js

@@ -1759,4 +1759,45 @@ describe('validation plugin - semantic - schema-ibm - OpenAPI 3', () => {
       'components.schemas.kid.properties.name'
     );
   });
+
+  it('should not produce a warning for properties with duplicate common names', () => {
+    const spec = {
+      components: {
+        schemas: {
+          person: {
+            description: 'Produce warnings',
+            properties: {
+              name: {
+                description: 'type integer',
+                type: 'integer'
+              }
+            }
+          },
+          adult: {
+            description: 'Causes first warnings',
+            properties: {
+              code: {
+                description: 'different type',
+                type: 'number'
+              }
+            }
+          },
+          kid: {
+            description: 'Causes second warning',
+            properties: {
+              code: {
+                type: 'string',
+                description: 'differnt type'
+              }
+            }
+          }
+        }
+      }
+    };
+
+    const res = validate({ jsSpec: spec }, config);
+
+    expect(res.warnings.length).toEqual(0);
+    expect(res.errors.length).toEqual(0);
+  });
 });