feat: add mqtt v5 specific bindings to mqtt #201

pearmaster · 2023-06-02T04:33:36Z

Description
According to #199 (comment) , I'm only adding fields to the mqtt binding. This is because we don't want to create new sets of bindings for each version of each protocol.

Some general changes:

Increased mqtt binding version to 0.2.0
Added a column to the tables to indicate which MQTT versions the binding applied to.
Create a new message binding
Added a deprecation warning to the mqtt5 readme to indicate a consolidation of bindings under mqtt only.

Here are specific fields being added:

sessionExpiryInterval added to the server binding
maximumPacketSize added to the server binding
messageExpiryInterval added to the operation binding
payloadFormatIndicator added to the message binding
correlationData added to the message binding
contentType added to the message binding
responseTopic added to the message binding.

Related issue(s)
Fixes #199 by adding new v5 properties to the mqtt binding
Fixes #198 by adding maximum packet size

github-actions

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

fmvilas · 2023-06-26T16:03:09Z

@dalelane @derberg @smoya @char0n would love to know your opinion.

mqtt5/README.md

KhudaDad414

Documentation seems to match the JSON schema specification. 🙇

Co-authored-by: Lukasz Gornicki <[email protected]>

derberg

lgtm

ping @fmvilas @smoya @dalelane @char0n

smoya · 2023-08-11T11:42:39Z

LGTM! 🚀🌔

Do we want to merge this into master and then adapt it to work with AsyncAPI v3? That already happened in #205, so we will need to update the binding in next-major-spec branch as well.
As an alternative, we could do the changes based on next-major-spec and will be released with v3 of the spec, which I think makes sense unless there is a really urgency.

Opinions? cc @jonaslagoni @dalelane @char0n @derberg

KhudaDad414

LGTM!

jonaslagoni

Think there is reason to have this for v2 regardless of v3 is right around the corner.

Someone just needs to update these afterwards 😄

jonaslagoni · 2023-08-14T10:28:41Z

mqtt/README.md

+---|:---:|:---:|---
+<a name="messageBindingObjectPayloadFormatIndicator"></a>`payloadFormatIndicator` | integer | 5 | Either: **0** (zero): Indicates that the payload is unspecified bytes, or **1**: Indicates that the payload is UTF-8 encoded character data. |
+<a name="messageBindingObjectCorrelationData"></a>`correlationData` | [Schema Object][schemaObject] \| [Reference Object](referenceObject) | 5 | Correlation Data is used by the sender of the request message to identify which request the response message is for when it is received.
+<a name="messageBindingObjectContentType"></a>`contentType` | string | 5 | String describing the content type of the message payload. This should not conflict with the `contentType` field of the associated AsyncAPI Message object.


How come the contentType of the AsyncAPI Message object is not enough 🤔 Or rather whats the difference?

The contentType of the Message object is a requirement of the payload format.

Providing a contentType message binding requires that the MQTTv5 PUBLISH packet include the "Content Type" property.

If we were talking HTTP, it would be the difference between requiring the payload to be JSON and requiring the HTTP headers include Content-Type: application/json

Got it 👍

jonaslagoni · 2023-08-14T10:32:35Z

mqtt/README.md

+Field Name | Type | MQTT Versions | Description
+---|:---:|:---:|---
+<a name="messageBindingObjectPayloadFormatIndicator"></a>`payloadFormatIndicator` | integer | 5 | Either: **0** (zero): Indicates that the payload is unspecified bytes, or **1**: Indicates that the payload is UTF-8 encoded character data. |
+<a name="messageBindingObjectCorrelationData"></a>`correlationData` | [Schema Object][schemaObject] \| [Reference Object](referenceObject) | 5 | Correlation Data is used by the sender of the request message to identify which request the response message is for when it is received.


How is this different from the correlation ID? 🤔

This is the same as a correlation ID. correlationData is the MQTT term. When this binding property is provided in the spec, it signals that the correlation ID should be provided in the MQTTv5 PUBLISH property designated for such.

I'd love to update the correlation ID runtime expression to indicate that a protocol binding field should be used for the correlation ID.

Alright 👍

derberg · 2023-09-04T13:45:17Z

we should merge to master, so it is changed for v2 too

jonaslagoni · 2023-09-27T06:36:45Z

ping ping @pearmaster 🙂

char0n

LGTM

smoya

LGTM! 🚀🌔

smoya · 2023-11-22T10:14:06Z

ping ping @pearmaster 🙂

I believe we can proceed with the merge of this PR. Nothing is expected from @pearmaster afaik. Anything else you expect @jonaslagoni ?

jonaslagoni · 2023-12-01T09:46:34Z

@smoya nothing but the JSON Schema files need to be moved to spec-json-schema repo 🙂

derberg · 2023-12-04T10:16:52Z

@smoya I just opened asyncapi/spec-json-schemas#464 so I guess we can merge this one and the other PR?

smoya · 2023-12-04T21:53:57Z

/rtm

Add MQTT5 specific bindings to mqtt.

b69946d

pearmaster requested review from KhudaDad414, derberg, fmvilas, dalelane, smoya, char0n and asyncapi-bot-eve as code owners June 2, 2023 04:33

github-actions bot reviewed Jun 2, 2023

View reviewed changes

fmvilas previously approved these changes Jun 26, 2023

View reviewed changes

derberg reviewed Jun 26, 2023

View reviewed changes

mqtt5/README.md Outdated Show resolved Hide resolved

KhudaDad414 previously approved these changes Jul 5, 2023

View reviewed changes

pearmaster and others added 2 commits July 21, 2023 10:52

Merge branch 'master' into mqttv5-bindings

5220394

Promote deprecation warning

a785000

Co-authored-by: Lukasz Gornicki <[email protected]>

pearmaster dismissed stale reviews from KhudaDad414 and fmvilas via a785000 July 21, 2023 16:56

derberg previously approved these changes Aug 11, 2023

View reviewed changes

derberg requested a review from KhudaDad414 August 11, 2023 11:13

add enum to qos field of operation object

737b865

KhudaDad414 dismissed derberg’s stale review via 737b865 August 14, 2023 09:31

KhudaDad414 approved these changes Aug 14, 2023

View reviewed changes

jonaslagoni reviewed Aug 14, 2023

View reviewed changes

tomkralidis mentioned this pull request Sep 23, 2023

add message size/length to mqtt and mqtt5 #198

Closed

Merge branch 'master' into mqttv5-bindings

1980587

char0n approved these changes Nov 10, 2023

View reviewed changes

Merge branch 'master' into mqttv5-bindings

ba33e3c

smoya approved these changes Nov 22, 2023

View reviewed changes

Merge branch 'master' into mqttv5-bindings

b36c4a1

derberg mentioned this pull request Dec 4, 2023

feat: add mqtt bindings schemas asyncapi/spec-json-schemas#464

Merged

asyncapi-bot added the ready-to-merge label Dec 4, 2023

asyncapi-bot merged commit e14c678 into asyncapi:master Dec 4, 2023
6 checks passed

aysancag mentioned this pull request Mar 13, 2024

How to define MQTT User Properties in an AsyncAPI document? asyncapi/spec#1043

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add mqtt v5 specific bindings to mqtt #201

feat: add mqtt v5 specific bindings to mqtt #201

pearmaster commented Jun 2, 2023

github-actions bot left a comment

fmvilas commented Jun 26, 2023

KhudaDad414 left a comment

derberg left a comment

smoya commented Aug 11, 2023 •

edited

Loading

KhudaDad414 left a comment

jonaslagoni left a comment

jonaslagoni Aug 14, 2023 •

edited

Loading

pearmaster Oct 10, 2023

jonaslagoni Oct 12, 2023

jonaslagoni Aug 14, 2023

pearmaster Oct 10, 2023

jonaslagoni Oct 12, 2023

derberg commented Sep 4, 2023

jonaslagoni commented Sep 27, 2023

char0n left a comment

smoya left a comment

smoya commented Nov 22, 2023

jonaslagoni commented Dec 1, 2023

derberg commented Dec 4, 2023

smoya commented Dec 4, 2023

feat: add mqtt v5 specific bindings to mqtt #201

feat: add mqtt v5 specific bindings to mqtt #201

Conversation

pearmaster commented Jun 2, 2023

github-actions bot left a comment

Choose a reason for hiding this comment

fmvilas commented Jun 26, 2023

KhudaDad414 left a comment

Choose a reason for hiding this comment

derberg left a comment

Choose a reason for hiding this comment

smoya commented Aug 11, 2023 • edited Loading

KhudaDad414 left a comment

Choose a reason for hiding this comment

jonaslagoni left a comment

Choose a reason for hiding this comment

jonaslagoni Aug 14, 2023 • edited Loading

Choose a reason for hiding this comment

pearmaster Oct 10, 2023

Choose a reason for hiding this comment

jonaslagoni Oct 12, 2023

Choose a reason for hiding this comment

jonaslagoni Aug 14, 2023

Choose a reason for hiding this comment

pearmaster Oct 10, 2023

Choose a reason for hiding this comment

jonaslagoni Oct 12, 2023

Choose a reason for hiding this comment

derberg commented Sep 4, 2023

jonaslagoni commented Sep 27, 2023

char0n left a comment

Choose a reason for hiding this comment

smoya left a comment

Choose a reason for hiding this comment

smoya commented Nov 22, 2023

jonaslagoni commented Dec 1, 2023

derberg commented Dec 4, 2023

smoya commented Dec 4, 2023

smoya commented Aug 11, 2023 •

edited

Loading

jonaslagoni Aug 14, 2023 •

edited

Loading