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

feat: add amqp exchange routing pattern and ref in channel operation #259

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

feat: add amqp exchange routing pattern and ref in channel operation #259

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
712736e
feat: add amqp routing information to channelOperation
timonback Aug 27, 2024
3b37c0a
feat: update example channelIds
timonback Oct 28, 2024
f3a5c7b
feat: update amqp binding version
timonback Oct 28, 2024
b859f14
feat: improve amqp binding description
timonback Oct 28, 2024
eb64eec
feat: use reference object description in amqp binding
timonback Oct 28, 2024
1c02850
feat: use destinct exchange address
timonback Oct 28, 2024
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
28 changes: 16 additions & 12 deletions amqp/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 AMQP-specific information on AsyncAPI.

## Version

Current version is `0.3.0`.
Current version is `0.4.0`.


<a name="server"></a>
Expand All @@ -29,6 +29,8 @@ This object contains information about the channel representation in AMQP.
Field Name | Type | Description
---|:---:|---
<a name="channelBindingObjectIs"></a>`is` | string | Defines what type of channel is it. Can be either `queue` or `routingKey` (default).
<a name="channelBindingObjectName"></a>`name` | string | When `is`=`routingKey`, this defines the actual routing pattern to route the message from the exchange to the queue.
<a name="channelBindingObjectChannel"></a>`channel` | [Reference Object](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#referenceObject) | When `is`=`routingKey`, a $ref pointer to the definition of the channel where the amqp message is routed to. If defined, this property MUST point to a Channel Object in any location. Please note the channel property value MUST be a Reference Object and, therefore, MUST NOT contain a Channel Object.
<a name="channelBindingObjectExchange"></a>`exchange` | Map[string, any] | When `is`=`routingKey`, this object defines the exchange properties.
<a name="channelBindingObjectExchangeName"></a>`exchange.name` | string | The name of the exchange. It MUST NOT exceed 255 characters long.
<a name="channelBindingObjectExchangeType"></a>`exchange.type` | string | The type of the exchange. Can be either `topic`, `direct`, `fanout`, `default` or `headers`.
Expand All @@ -49,24 +51,27 @@ This object MUST contain only the properties defined above.

```yaml
channels:
userSignup:
address: 'user/signup'
userSignupExchange:
address: 'signup'
bindings:
amqp:
is: routingKey
name: user.signup
channel:
$ref: #/components/channels/userSignupQueue
exchange:
name: myExchange
type: topic
durable: true
autoDelete: false
vhost: /
bindingVersion: 0.3.0
bindingVersion: 0.4.0
```

```yaml
channels:
userSignup:
address: 'user/signup'
userSignupQueue:
address: 'user.signup'
bindings:
amqp:
is: queue
Expand All @@ -76,7 +81,7 @@ channels:
exclusive: true
autoDelete: false
vhost: /
bindingVersion: 0.3.0
bindingVersion: 0.4.0
```

<a name="operation"></a>
Expand Down Expand Up @@ -108,7 +113,7 @@ This object MUST contain only the properties defined above.
operations:
userSignup:
channel:
$ref: '#/channels/userSignup'
$ref: '#/channels/userSignupQueue'
bindings:
amqp:
expiration: 100000
Expand All @@ -120,7 +125,7 @@ operations:
bcc: ['external.audit']
timestamp: true
ack: false
bindingVersion: 0.3.0
bindingVersion: 0.4.0
```


Expand All @@ -142,13 +147,12 @@ This object MUST contain only the properties defined above.

```yaml
channels:
userSignup:
address: 'user/signup'
userSignupQueue:
messages:
userSignupMessage:
bindings:
amqp:
contentEncoding: gzip
messageType: 'user.signup'
bindingVersion: 0.3.0
bindingVersion: 0.4.0
```
Loading