diff --git a/amqp/README.md b/amqp/README.md index 547fa25e..626dfb0f 100644 --- a/amqp/README.md +++ b/amqp/README.md @@ -6,7 +6,7 @@ This document defines how to describe AMQP-specific information on AsyncAPI. ## Version -Current version is `0.2.0`. +Current version is `0.3.0`. @@ -49,7 +49,8 @@ This object MUST contain only the properties defined above. ```yaml channels: - user/signedup: + userSignup: + address: 'user/signup' bindings: amqp: is: routingKey @@ -65,7 +66,7 @@ channels: durable: true autoDelete: false vhost: / - bindingVersion: 0.2.0 + bindingVersion: 0.3.0 ``` @@ -77,41 +78,40 @@ This object contains information about the operation representation in AMQP. ##### Fixed Fields -Field Name | Type | Applies To | Description +Field Name | Type | Applies To Action | Description ---|:---:|:---:|--- -`expiration` | integer | Publish, Subscribe | TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero. -`userId` | string | Publish, Subscribe | Identifies the user who has sent the message. -`cc` | [string] | Publish, Subscribe | The routing keys the message should be routed to at the time of publishing. -`priority` | integer | Publish, Subscribe | A priority for the message. -`deliveryMode` | integer | Publish, Subscribe | Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent). -`mandatory` | boolean | Publish | Whether the message is mandatory or not. -`bcc` | [string] | Publish | Like [cc](#operationBindingObjectCC) but consumers will not receive this information. -`replyTo` | string | Publish, Subscribe | Name of the queue where the consumer should send the response. -`timestamp` | boolean | Publish, Subscribe | Whether the message should include a timestamp or not. +`expiration` | integer | `receive`, `send` | TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero. +`userId` | string | `receive`, `send` | Identifies the user who has sent the message. +`cc` | [string] | `receive`, `send` | The routing keys the message should be routed to at the time of publishing. +`priority` | integer | `receive`, `send` | A priority for the message. +`deliveryMode` | integer | `receive`, `send` | Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent). +`mandatory` | boolean | `receive` | Whether the message is mandatory or not. +`bcc` | [string] | `receive` | Like [cc](#operationBindingObjectCC) but consumers will not receive this information. +`timestamp` | boolean | `receive`, `send` | Whether the message should include a timestamp or not. `ack` | boolean | Subscribe | Whether the consumer should ack the message or not. -`bindingVersion` | string | Publish, Subscribe | The version of this binding. If omitted, "latest" MUST be assumed. +`bindingVersion` | string | `receive`, `send` | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. ##### Example ```yaml -channels: - user/signup: - publish: - bindings: - amqp: - expiration: 100000 - userId: guest - cc: ['user.logs'] - priority: 10 - deliveryMode: 2 - mandatory: false - bcc: ['external.audit'] - replyTo: user.signedup - timestamp: true - ack: false - bindingVersion: 0.2.0 +operations: + userSignup: + channel: + $ref: '#/channels/userSignup' + bindings: + amqp: + expiration: 100000 + userId: guest + cc: ['user.logs'] + priority: 10 + deliveryMode: 2 + mandatory: false + bcc: ['external.audit'] + timestamp: true + ack: false + bindingVersion: 0.3.0 ``` @@ -133,12 +133,13 @@ This object MUST contain only the properties defined above. ```yaml channels: - user/signup: - publish: - message: + userSignup: + address: 'user/signup' + messages: + userSignupMessage: bindings: amqp: contentEncoding: gzip messageType: 'user.signup' - bindingVersion: 0.2.0 + bindingVersion: 0.3.0 ```