Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: adapt MQTT bindings to v3 #205

Merged
merged 5 commits into from
Jul 25, 2023
Merged

feat: adapt MQTT bindings to v3 #205

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4577b97
adapt readme
jonaslagoni Jun 13, 2023
ece9cab
Merge branch 'next-major-spec' into v3_mqtt
jonaslagoni Jun 22, 2023
63546bf
finilize binding
jonaslagoni Jun 22, 2023
4bcfac2
Update mqtt/README.md
jonaslagoni Jun 26, 2023
98c3c29
Merge branch 'next-major-spec' into v3_mqtt
jonaslagoni Jun 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions mqtt/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This document defines how to describe MQTT-specific information on AsyncAPI.

## Version

Current version is `0.1.0`.
Current version is `0.2.0`.


<a name="server"></a>
Expand Down Expand Up @@ -46,18 +46,15 @@ servers:
message: Guest gone offline.
retain: false
keepAlive: 60
bindingVersion: 0.1.0
bindingVersion: 0.2.0
```


<a name="channel"></a>

## Channel Binding Object

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



<a name="operation"></a>

## Operation Binding Object
Expand All @@ -66,11 +63,11 @@ This object contains information about the operation representation in MQTT.

##### Fixed Fields

Field Name | Type | Applies To | Description
Field Name | Type | Applies To Action | Description
---|:---:|:---:|---
<a name="operationBindingObjectQoS"></a>`qos` | integer | Publish, Subscribe | Defines the Quality of Service (QoS) levels for the message flow between client and server. Its value MUST be either 0 (At most once delivery), 1 (At least once delivery), or 2 (Exactly once delivery).
<a name="operationBindingObjectRetain"></a>`retain` | boolean | Publish, Subscribe | Whether the broker should retain the message or not.
<a name="operationBindingObjectBindingVersion"></a>`bindingVersion` | string | Publish, Subscribe | The version of this binding. If omitted, "latest" MUST be assumed.
<a name="operationBindingObjectQoS"></a>`qos` | integer | `receive`, `send` | Defines the Quality of Service (QoS) levels for the message flow between client and server. Its value MUST be either 0 (At most once delivery), 1 (At least once delivery), or 2 (Exactly once delivery).
<a name="operationBindingObjectRetain"></a>`retain` | boolean | `receive`, `send` | Whether the broker should retain the message or not.
<a name="operationBindingObjectBindingVersion"></a>`bindingVersion` | string | `receive`, `send` | The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

Expand All @@ -79,12 +76,14 @@ This object MUST contain only the properties defined above.
```yaml
channels:
user/signup:
publish:
bindings:
mqtt:
qos: 2
retain: true
bindingVersion: 0.1.0
operations:
userSignup:
action: receive
bindings:
mqtt:
qos: 2
retain: true
bindingVersion: 0.2.0
```


Expand All @@ -104,10 +103,11 @@ This object MUST contain only the properties defined above.

```yaml
channels:
user/signup:
publish:
message:
userSignup:
address: user/signup
messages:
userSignup:
bindings:
mqtt:
bindingVersion: 0.1.0
bindingVersion: 0.2.0
```