You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: amqp/README.md
+35-34Lines changed: 35 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This document defines how to describe AMQP-specific information on AsyncAPI.
6
6
7
7
## Version
8
8
9
-
Current version is `0.2.0`.
9
+
Current version is `0.3.0`.
10
10
11
11
12
12
<aname="server"></a>
@@ -49,7 +49,8 @@ This object MUST contain only the properties defined above.
49
49
50
50
```yaml
51
51
channels:
52
-
user/signedup:
52
+
userSignup:
53
+
address: 'user/signup'
53
54
bindings:
54
55
amqp:
55
56
is: routingKey
@@ -65,7 +66,7 @@ channels:
65
66
durable: true
66
67
autoDelete: false
67
68
vhost: /
68
-
bindingVersion: 0.2.0
69
+
bindingVersion: 0.3.0
69
70
```
70
71
71
72
@@ -77,41 +78,40 @@ This object contains information about the operation representation in AMQP.
77
78
78
79
##### Fixed Fields
79
80
80
-
Field Name | Type | Applies To | Description
81
+
Field Name | Type | Applies To Action | Description
81
82
---|:---:|:---:|---
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.
91
91
<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.
93
93
94
94
This object MUST contain only the properties defined above.
95
95
96
96
##### Example
97
97
98
98
```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
115
115
```
116
116
117
117
@@ -133,12 +133,13 @@ This object MUST contain only the properties defined above.
0 commit comments