AsyncAPI Best Practices

asyncapi-channel-parameters

general > asyncapi-channel-parameters


Guidance

All channel parameters should be defined in the parameters object of the channel. They should also not contain
redundant parameters that do not exist in the channel address.

Message

Channel "{{apiContract.path}}" has undefined parameters in the parameters object.

Examples

valid

/endpoint/{userId}:
  parameters:
    userId:
      description: Id of the user.
      schema:
        type: string

invalid

/endpoint:
  parameters:
    userId:
      description: Id of the user.
      schema:
        type: string

Applies to EndPoint

Constraint

Type: Rego Validation
TypeRuleset
OrganizationMuleSoft
Published by
Mulesoft Organization
Published onOct 26, 2026
Asset overview

Asset versions for 1.3.x

Asset versions
VersionActions
1.3.0

Tags