MQTT 5 Bindings

December 4, 2023 ยท View on GitHub

This document defines how to describe MQTT 5-specific information on AsyncAPI.

Deprecation Warning: MQTT version 5 specific bindings are deprecated in favor of MQTT bindings that are not version specific.

Version

Current version is 0.2.0.

Server Binding Object

This object contains information about the server representation in MQTT5.

Fixed Fields
Field NameTypeDescription
sessionExpiryIntervalSchema Object | Reference Object | integerSession Expiry Interval in seconds or a Schema Object containing the definition of the interval.
bindingVersionstringThe version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

Example
servers:
  production:
    bindings:
      mqtt5:
        sessionExpiryInterval: 60
        bindingVersion: 0.2.0
servers:
  production:
    bindings:
      mqtt5:
        sessionExpiryInterval:
          type: integer
          minimum: 100
        bindingVersion: 0.2.0

Channel Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Operation Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Message Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.