fix: ingore violations from invalid locations of an api definition

packages/validator/src/spectral/index.js

@@ -71,6 +71,12 @@ function convertResults(spectralResults, { config, logger }) {
       continue;
     }
 
+    // Ingore any rule violations that occur in sections of the spec that are
+    // not valid locations for API validation.
+    if (invalidLocation(r.path)) {
+      continue;
+    }
+
     const severity = convertSpectralSeverity(r.severity);
     // only collect errors when "errors only" is true
     if (errorsOnly && r.severity > 0) {
@@ -224,3 +230,10 @@ function convertSpectralSeverity(s) {
   const mapping = { 0: 'error', 1: 'warning', 2: 'info', 3: 'hint' };
   return mapping[s];
 }
+
+function invalidLocation(pathArray) {
+  // The 'x-sdk-apiref' extension is an IBM internal section for providing
+  // SDK-related metadata. It is not appropriate for the validator to consider.
+  const invalidLocations = ['x-sdk-apiref'];
+  return invalidLocations.some(l => pathArray.includes(l));
+}

packages/validator/test/cli-validator/mock-files/oas31/err-and-warn.yaml

@@ -210,3 +210,10 @@ components:
     UnusedString:
       description: string
       type: string
+
+x-sdk-apiref:
+  type: int64
+  enum:
+    - this would trigger spectrals 'typed-enum' rule
+    - without our custom filter for invalid openapi locations
+    - this just tests that no warning is emitted for the 'x-sdk-apiref' location