Use Spectral pattern function

smoya · Nov 28, 2023 · e17e7cd · e17e7cd
1 parent 40d8e7a
commit e17e7cd
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 53 deletions.
diff --git a/src/ruleset/v3/functions/requiredOperationChannelUnambiguity.ts b/src/ruleset/v3/functions/requiredOperationChannelUnambiguity.ts
diff --git a/src/ruleset/v3/ruleset.ts b/src/ruleset/v3/ruleset.ts
@@ -2,7 +2,8 @@
 
 import { AsyncAPIFormats } from '../formats';
 import { operationMessagesUnambiguity } from './functions/operationMessagesUnambiguity';
-import { requiredOperationChannelUnambiguity } from './functions/requiredOperationChannelUnambiguity';
+// import { requiredOperationChannelUnambiguity } from './functions/requiredOperationChannelUnambiguity';
+import { pattern } from '@stoplight/spectral-functions';
 
 export const v3CoreRuleset = {
   description: 'Core AsyncAPI 3.x.x ruleset.',
@@ -26,16 +27,17 @@ export const v3CoreRuleset = {
       },
     },
     'asyncapi3-required-operation-channel-unambiguity': {
-      description: 'Required operation (under root channels) "channel" must reference to a required channel (under root channels).',
-      message: '{{error}}',
+      description: 'The "channel" field of an operation under the root "operations" object must always reference a channel under the root "channels" object.',
       severity: 'error',
       recommended: true,
       resolved: false, // We use the JSON pointer to match the channel.
-      given: [
-        '$.operations.*',
-      ],
+      given: '$.operations.*',      
       then: {
-        function: requiredOperationChannelUnambiguity,
+        field: 'channel.$ref',
+        function: pattern,
+        functionOptions: {
+          match: '#\\/channels\\/', // If doesn't match, rule fails.
+        },
       },
     }
   },

diff --git a/test/ruleset/rules/v3/asyncapi3-required-operation-channel-unambiguity.spec.ts b/test/ruleset/rules/v3/asyncapi3-required-operation-channel-unambiguity.spec.ts
@@ -222,8 +222,8 @@ testRule('asyncapi3-required-operation-channel-unambiguity', [
     },
     errors: [
       {
-        message: 'The channel field of a required operation should point to a required channel.',
-        path: ['operations', 'UserSignedUp', 'channel'],
+        message: 'The "channel" field of an operation under the root "operations" object must always reference a channel under the root "channels" object.',
+        path: ['operations', 'UserSignedUp', 'channel', '$ref'],
         severity: DiagnosticSeverity.Error,
       }
     ],
@@ -252,8 +252,8 @@ testRule('asyncapi3-required-operation-channel-unambiguity', [
     },
     errors: [
       {
-        message: 'The channel field of a required operation should point to a required channel.',
-        path: ['operations', 'UserSignedUp', 'channel'],
+        message: 'The "channel" field of an operation under the root "operations" object must always reference a channel under the root "channels" object.',
+        path: ['operations', 'UserSignedUp', 'channel', '$ref'],
         severity: DiagnosticSeverity.Error,
       }
     ],