AsyncAPI Best Practices

general > asyncapi-operation-description

Guidance / Message

Operation '{{apiContract.method}}' should have a description.

Examples

valid

/endpoint:
  subscribe:
    description: suscribe channel
    message:
      x-pageSize: 5

invalid

/endpoint:
  subscribe:
    message:
      x-pageSize: 5

Applies to Operation

Constraint

Type: Declarative Validation