Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 84 additions & 12 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions packages/parser/src/ruleset/v3/ruleset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import { AsyncAPIFormats } from '../formats';
import { operationMessagesUnambiguity } from './functions/operationMessagesUnambiguity';
import { pattern } from '@stoplight/spectral-functions';
import { pattern, truthy } from '@stoplight/spectral-functions';
import { channelServers } from '../functions/channelServers';

export const v3CoreRuleset = {
Expand All @@ -13,18 +13,18 @@ export const v3CoreRuleset = {
/**
* Operation Object rules
*/
'asyncapi3-operation-messages-from-referred-channel': {
description: 'Operation "messages" must be a subset of the messages defined in the channel referenced in this operation.',
message: '{{error}}',
'channel-parameters-require-address': {
description: 'Channel address must not be null when parameters are defined.',
message: 'Channel address must not be null when parameters are defined.',
severity: 'error',
recommended: true,
resolved: false, // We use the JSON pointer to match the channel.
given: [
'$.operations.*',
'$.components.operations.*',
'$.channels[?(@.parameters)]',
'$.components.channels[?(@.parameters)]'
],
then: {
function: operationMessagesUnambiguity,
field: 'address',
function: truthy,
},
},
'asyncapi3-required-operation-channel-unambiguity': {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import { testRule, DiagnosticSeverity } from '../../tester';

testRule('channel-parameters-require-address', [
{
name: 'valid case - no parameters',
document: {
asyncapi: '3.0.0',
channels: {
channel: {
address: null,
},
},
},
errors: [],
},

{
name: 'valid case - parameters with address',
document: {
asyncapi: '3.0.0',
channels: {
channel: {
address: 'some/address',
parameters: {
param: {
description: 'test',
},
},
},
},
},
errors: [],
},

{
name: 'invalid case - parameters but address null',
document: {
asyncapi: '3.0.0',
info: {
title: 'Test',
version: '1.0.0',
},
channels: {
userSignedup: {
address: null,
parameters: {
test: {
description: 'This should fail validation',
},
},
},
},
},
errors: [
{
message: 'Channel address must not be null when parameters are defined.',
path: ['channels', 'userSignedup', 'address'],
severity: DiagnosticSeverity.Error,
},
],
},
]);