AsyncAPI Best Practices

general > asyncapi-parameter-description

Guidance / Message

Parameter "{{core.name}}" should have a description.

Examples

valid

/endpoint:
  subscribe:
    operationId: subs-ops
    message:
      x-pageSize: 5
  parameters:
    userId:
      description: Id of the user.
      schema:
        type: string

invalid

/endpoint:
  subscribe:
    operationId: subs-ops
    message:
      x-pageSize: 5
  parameters:
    userId:
      schema:
        type: string

Applies to Parameter

Constraint

Type: Declarative Validation