AsyncAPI Best Practices

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