Skip to content

Commit 306f1fc

Browse files
jonaslagonismoyasambhavgupta0705whitlockjclbroudoux
authored
feat!: release v3 compatible bindings (#224)
Co-authored-by: Sergio Moya <1083296+smoya@users.noreply.github.com> Co-authored-by: Sambhav Gupta <81870866+sambhavgupta0705@users.noreply.github.com> Co-authored-by: Jeremy Whitlock <jcwhitlock@google.com> Co-authored-by: Laurent Broudoux <laurent.broudoux@gmail.com> Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
1 parent e14c678 commit 306f1fc

File tree

39 files changed

+174
-3081
lines changed

39 files changed

+174
-3081
lines changed

amqp/README.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document defines how to describe AMQP-specific information on AsyncAPI.
66

77
## Version
88

9-
Current version is `0.2.0`.
9+
Current version is `0.3.0`.
1010

1111

1212
<a name="server"></a>
@@ -49,7 +49,8 @@ This object MUST contain only the properties defined above.
4949

5050
```yaml
5151
channels:
52-
user/signedup:
52+
userSignup:
53+
address: 'user/signup'
5354
bindings:
5455
amqp:
5556
is: routingKey
@@ -65,7 +66,7 @@ channels:
6566
durable: true
6667
autoDelete: false
6768
vhost: /
68-
bindingVersion: 0.2.0
69+
bindingVersion: 0.3.0
6970
```
7071
7172
@@ -77,41 +78,40 @@ This object contains information about the operation representation in AMQP.
7778
7879
##### Fixed Fields
7980
80-
Field Name | Type | Applies To | Description
81+
Field Name | Type | Applies To Action | Description
8182
---|:---:|:---:|---
82-
<a name="operationBindingObjectExpiration"></a>`expiration` | integer | Publish, Subscribe | TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero.
83-
<a name="operationBindingObjectUserId"></a>`userId` | string | Publish, Subscribe | Identifies the user who has sent the message.
84-
<a name="operationBindingObjectCC"></a>`cc` | [string] | Publish, Subscribe | The routing keys the message should be routed to at the time of publishing.
85-
<a name="operationBindingObjectPriority"></a>`priority` | integer | Publish, Subscribe | A priority for the message.
86-
<a name="operationBindingObjectDeliveryMode"></a>`deliveryMode` | integer | Publish, Subscribe | Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent).
87-
<a name="operationBindingObjectMandatory"></a>`mandatory` | boolean | Publish | Whether the message is mandatory or not.
88-
<a name="operationBindingObjectBCC"></a>`bcc` | [string] | Publish | Like [cc](#operationBindingObjectCC) but consumers will not receive this information.
89-
<a name="operationBindingObjectReplyTo"></a>`replyTo` | string | Publish, Subscribe | Name of the queue where the consumer should send the response.
90-
<a name="operationBindingObjectTimestamp"></a>`timestamp` | boolean | Publish, Subscribe | Whether the message should include a timestamp or not.
83+
<a name="operationBindingObjectExpiration"></a>`expiration` | integer | `receive`, `send` | TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero.
84+
<a name="operationBindingObjectUserId"></a>`userId` | string | `receive`, `send` | Identifies the user who has sent the message.
85+
<a name="operationBindingObjectCC"></a>`cc` | [string] | `receive`, `send` | The routing keys the message should be routed to at the time of publishing.
86+
<a name="operationBindingObjectPriority"></a>`priority` | integer | `receive`, `send` | A priority for the message.
87+
<a name="operationBindingObjectDeliveryMode"></a>`deliveryMode` | integer | `receive`, `send` | Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent).
88+
<a name="operationBindingObjectMandatory"></a>`mandatory` | boolean | `receive` | Whether the message is mandatory or not.
89+
<a name="operationBindingObjectBCC"></a>`bcc` | [string] | `receive` | Like [cc](#operationBindingObjectCC) but consumers will not receive this information.
90+
<a name="operationBindingObjectTimestamp"></a>`timestamp` | boolean | `receive`, `send` | Whether the message should include a timestamp or not.
9191
<a name="operationBindingObjectAck"></a>`ack` | boolean | Subscribe | Whether the consumer should ack the message or not.
92-
<a name="operationBindingObjectBindingVersion"></a>`bindingVersion` | string | Publish, Subscribe | The version of this binding. If omitted, "latest" MUST be assumed.
92+
<a name="operationBindingObjectBindingVersion"></a>`bindingVersion` | string | `receive`, `send` | The version of this binding. If omitted, "latest" MUST be assumed.
9393

9494
This object MUST contain only the properties defined above.
9595

9696
##### Example
9797

9898
```yaml
99-
channels:
100-
user/signup:
101-
publish:
102-
bindings:
103-
amqp:
104-
expiration: 100000
105-
userId: guest
106-
cc: ['user.logs']
107-
priority: 10
108-
deliveryMode: 2
109-
mandatory: false
110-
bcc: ['external.audit']
111-
replyTo: user.signedup
112-
timestamp: true
113-
ack: false
114-
bindingVersion: 0.2.0
99+
operations:
100+
userSignup:
101+
channel:
102+
$ref: '#/channels/userSignup'
103+
bindings:
104+
amqp:
105+
expiration: 100000
106+
userId: guest
107+
cc: ['user.logs']
108+
priority: 10
109+
deliveryMode: 2
110+
mandatory: false
111+
bcc: ['external.audit']
112+
timestamp: true
113+
ack: false
114+
bindingVersion: 0.3.0
115115
```
116116

117117

@@ -133,12 +133,13 @@ This object MUST contain only the properties defined above.
133133

134134
```yaml
135135
channels:
136-
user/signup:
137-
publish:
138-
message:
136+
userSignup:
137+
address: 'user/signup'
138+
messages:
139+
userSignupMessage:
139140
bindings:
140141
amqp:
141142
contentEncoding: gzip
142143
messageType: 'user.signup'
143-
bindingVersion: 0.2.0
144+
bindingVersion: 0.3.0
144145
```

amqp/json_schemas/channel.json

Lines changed: 0 additions & 137 deletions
This file was deleted.

amqp/json_schemas/message.json

Lines changed: 0 additions & 37 deletions
This file was deleted.

amqp/json_schemas/operation.json

Lines changed: 0 additions & 89 deletions
This file was deleted.

0 commit comments

Comments
 (0)