fix(ibm-major-version-in-path): extend rule to check major version is the first segment

packages/ruleset/src/functions/major-version-in-path.js

@@ -106,6 +106,16 @@ function checkMajorVersion(apiDef) {
       return [];
     }
 
+    if (!verionIsFirstInPaths(urls) && versionIsInPath(urls)) {
+      logger.debug(`${ruleId}: first segment of path isn't the major version`);
+      return [
+        {
+          message: "First segment of path isn't the major version of the API",
+          path: ['paths'],
+        },
+      ];
+    }
+
     const versions = urls.map(url => getVersion(url));
 
     if (versions.length > 1 && !versions.every(v => v === versions[0])) {
@@ -197,3 +207,15 @@ function getDefaultUrl(server) {
 
   return urlString;
 }
+
+function verionIsFirstInPaths(paths) {
+  const versionRegex = /^\/v\d+\//;
+
+  return paths.every(path => versionRegex.test(path));
+}
+
+function versionIsInPath(paths) {
+  const versionRegex = /\/v\d+\//;
+
+  return paths.every(path => versionRegex.test(path));
+}

packages/ruleset/test/rules/major-version-in-path.test.js

@@ -135,4 +135,21 @@ describe(`Spectral rule: ${ruleId}`, () => {
     expect(validation.path).toStrictEqual([]);
     expect(validation.severity).toBe(severityCodes.warning);
   });
+
+  it('should error when paths start with different versions', async () => {
+    const testDocument = makeCopy(rootDocument);
+    testDocument.paths['metadata/v1/some_path'] = {};
+
+    const results = await testRule(ruleId, rule, testDocument);
+
+    expect(results).toHaveLength(1);
+
+    const validation = results[0];
+    expect(validation.code).toBe(ruleId);
+    expect(validation.message).toBe(
+      "First segment of path isn't the major version of the API"
+    );
+    expect(validation.path).toStrictEqual(['paths']);
+    expect(validation.severity).toBe(severityCodes.warning);
+  });
 });