AsyncAPI Channel Parameters Examples (Edit)

AsyncAPI channel parameters should include examples to support mocking, testing, and documentation. Examples help consumers understand expected parameter values for channel subscriptions.

AsyncAPIChannelsParametersExamplesMocking

Rule Definition

asyncapi-channel-parameters-examples-warn.yaml
{"asyncapi-channel-parameters-examples-warn":{"description":"AsyncAPI channel parameters should include examples to support mocking, testing, and documentation. Examples help consumers understand expected parameter values for channel subscriptions.","message":"AsyncAPI channel parameters SHOULD include examples.","given":"$.channels[*].parameters.*","severity":"warn","then":{"field":"examples","function":"truthy"}}}

Back to All of the Rules