feat: classification of cnahges of OAS extension for Path Item object

enable corresponding tests in classification suite

Author: b41ex

src/openapi/openapi3.rules.ts

@@ -74,6 +74,20 @@ import { encodingParamsCalculator } from './openapi3.description.encoding'
 const documentAnnotationRule: CompareRules = { $: allAnnotation }
 const operationAnnotationRule: CompareRules = { $: allAnnotation }
 
+const openApiExtensionRulesFunction: (fallbackRules: CompareRules | (() => CompareRules)) => CompareRules = (fallbackRules) => ({
+  '/*': (ctx) => {
+    const { key } = ctx
+    return typeof key === 'string' && key.startsWith('x-')
+      ? {
+        $: allUnclassified,
+        '/**': {
+          $: allUnclassified,
+        },
+      }
+      : typeof fallbackRules === 'function' ? fallbackRules() : fallbackRules
+  },
+})
+
 export const openApi3Rules = (options: OpenApi3RulesOptions): CompareRules => {
   const requestSchemaRules = openApiSchemaRules(options)
   const responseSchemaRules = openApiSchemaRules({ ...options, response: true })
@@ -331,6 +345,51 @@ export const openApi3Rules = (options: OpenApi3RulesOptions): CompareRules => {
     },
   }
 
+  const operationCompareRules:CompareRules = {
+    $: [nonBreaking, breaking, unclassified],
+    '/*': operationAnnotationRule,
+    '/tags': {
+      ...operationAnnotationRule,
+      mapping: deepEqualsUniqueItemsArrayMappingResolver,
+      '/*': {
+        ...operationAnnotationRule,
+        [IGNORE_DIFFERENCE_IN_KEYS_RULE]: true,
+      },
+    },
+    '/parameters': {
+      ...parametersRules,
+      $: [nonBreaking, apihubParametersRemovalClassifyRule, breaking],
+      mapping: paramMappingResolver(2),
+    },
+    '/requestBody': requestBodiesRules,
+    '/callbacks': {
+      '/*': {
+        //no support?
+      },
+    },
+    '/responses': responsesRules,
+    '/deprecated': { $: allDeprecated },
+    '/security': {
+      $: operationSecurityClassifyRule,
+      '/*': {
+        $: operationSecurityItemClassifyRule,
+        '/*': {
+          $: allBreaking,
+          mapping: deepEqualsUniqueItemsArrayMappingResolver,
+          '/*': {
+            $: [breaking, nonBreaking, breaking],
+            ignoreKeyDifference: true,
+          },
+        },
+      },
+    },
+    '/servers': serversRules,
+    '/externalDocs': {
+      $: allAnnotation,
+      '/*': { $: allAnnotation },
+    },
+  }
+
   return {
     '/openapi': documentAnnotationRule,
     '/info': {
@@ -346,50 +405,7 @@ export const openApi3Rules = (options: OpenApi3RulesOptions): CompareRules => {
         mapping: options.mode === COMPARE_MODE_OPERATION ? singleOperationPathMappingResolver : pathMappingResolver,
         '/summary': { $: allAnnotation },
         '/description': { $: allAnnotation },
-        '/*': {
-          $: [nonBreaking, breaking, unclassified],
-          '/*': operationAnnotationRule,
-          '/tags': {
-            ...operationAnnotationRule,
-            mapping: deepEqualsUniqueItemsArrayMappingResolver,
-            '/*': {
-              ...operationAnnotationRule,
-              [IGNORE_DIFFERENCE_IN_KEYS_RULE]: true,
-            },
-          },
-          '/parameters': {
-            ...parametersRules,
-            $: [nonBreaking, apihubParametersRemovalClassifyRule, breaking],
-            mapping: paramMappingResolver(2),
-          },
-          '/requestBody': requestBodiesRules,
-          '/callbacks': {
-            '/*': {
-              //no support?
-            },
-          },
-          '/responses': responsesRules,
-          '/deprecated': { $: allDeprecated },
-          '/security': {
-            $: operationSecurityClassifyRule,
-            '/*': {
-              $: operationSecurityItemClassifyRule,
-              '/*': {
-                $: allBreaking,
-                mapping: deepEqualsUniqueItemsArrayMappingResolver,
-                '/*': {
-                  $: [breaking, nonBreaking, breaking],
-                  ignoreKeyDifference: true,
-                },
-              },
-            },
-          },
-          '/servers': serversRules,
-          '/externalDocs': {
-            $: allAnnotation,
-            '/*': { $: allAnnotation },
-          },
-        },
+        ...openApiExtensionRulesFunction(operationCompareRules),
         '/servers': serversRules,
         '/parameters': {
           ...parametersRules,

test/compatibility-suites/openapi/general-operation-parameters.test.ts

@@ -1,6 +1,6 @@
 import { compareFiles, TEST_DEFAULTS_DECLARATION_PATHS } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
-import { annotation, breaking, deprecated, DiffAction, nonBreaking } from '../../../src'
+import { annotation, breaking, deprecated, DiffAction, nonBreaking, unclassified } from '../../../src'
 
 const SUITE_ID = 'general-operation-parameters'
 const COMMON_PATH1_GET = ['paths', '/path1', 'get']
@@ -595,42 +595,39 @@ describe('Openapi3 General Operation Parameters', () => {
     ]))
   })
 
-  // No changes
-  test.skip('Add custom property in path', async () => {
+  test('Add custom property in path', async () => {
     const testId = 'add-custom-property-in-path'
     const result = await compareFiles(SUITE_ID, testId)
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
         afterDeclarationPaths: [['paths', '/pets', 'x-feature-flag']],
-        type: nonBreaking,
+        type: unclassified,
       }),
     ]))
   })
 
-  // No changes
-  test.skip('Update custom property in path', async () => {
+  test('Update custom property in path', async () => {
     const testId = 'update-custom-property-value-in-path'
     const result = await compareFiles(SUITE_ID, testId)
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
         beforeDeclarationPaths: [['paths', '/pets', 'x-feature-flag']],
         afterDeclarationPaths: [['paths', '/pets', 'x-feature-flag']],
-        type: nonBreaking,
+        type: unclassified,
       }),
     ]))
   })
 
-  // No changes
-  test.skip('Remove custom property in path', async () => {
+  test('Remove custom property in path', async () => {
     const testId = 'remove-custom-property-in-path'
     const result = await compareFiles(SUITE_ID, testId)
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
         beforeDeclarationPaths: [['paths', '/pets', 'x-feature-flag']],
-        type: nonBreaking,
+        type: unclassified,
       }),
     ]))
   })