AsyncAPI Best Practices

general > asyncapi-operation-operationId

Guidance

This operation ID is essentially a reference for the operation, which can be used to visually suggest a connection

to other operations. This is like some theoretical static HATEOAS-style referencing, but it's also used for the

URL in some documentation systems.

Message

Operation '{{apiContract.method}}' must have and operationId field describing the actions that are being performed in hyphen-case.

Examples

valid

/endpoint:
  subscribe:
    operationId: subs-ops
    message:
      x-pageSize: 5

invalid

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

Applies to Operation

Constraint

Type: Declarative Validation