Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
1f9aeaf
docs(extension): update latest bindings docs
Oct 15, 2025
a0ed185
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 16, 2025
a0748c9
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 17, 2025
cdd8c59
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 17, 2025
0d89c4d
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 20, 2025
6cefcb2
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 21, 2025
589d68f
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 21, 2025
6a28d96
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 22, 2025
a2bbc72
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 24, 2025
076e416
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 24, 2025
8071b75
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 27, 2025
7c42cc3
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 27, 2025
5095314
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 27, 2025
8e90d68
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 28, 2025
fad5ec2
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Oct 30, 2025
2e16da1
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 3, 2025
07b1087
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 4, 2025
53f1e1a
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 4, 2025
12446ae
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 5, 2025
406b805
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 5, 2025
c582e9e
Merge master into update-bindings-docs-6e293e50474c421bc5488563b244a3…
asyncapi-bot-eve Nov 6, 2025
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
4 changes: 4 additions & 0 deletions config/edit-page-config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
[
{
"value": "reference/bindings/",
"href": "https://github.com/asyncapi/bindings/tree/master"
},
{
"value": "/tools/generator",
"href": "https://github.com/asyncapi/generator/tree/master/apps/generator/docs"
Expand Down
307 changes: 307 additions & 0 deletions markdown/docs/reference/bindings/2.x.x.md

Large diffs are not rendered by default.

332 changes: 332 additions & 0 deletions markdown/docs/reference/bindings/3.0.0.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions markdown/docs/reference/bindings/_section.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: Bindings
weight: 15
---
weight: 11
---
159 changes: 159 additions & 0 deletions markdown/docs/reference/bindings/amqp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
---
title: 'amqp'
weight: 11
---

# AMQP 0-9-1 Bindings

This document defines how to describe AMQP-specific information on AsyncAPI.

<a name="version"></a>

## Version

Current version is `0.3.0`.


<a name="server"></a>

## Server Binding Object

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




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

## Channel Binding Object

This object contains information about the channel representation in AMQP.

##### Fixed Fields

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="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`.
<a name="channelBindingObjectExchangeDurable"></a>`exchange.durable` | boolean | Whether the exchange should survive broker restarts or not.
<a name="channelBindingObjectExchangeAutoDelete"></a>`exchange.autoDelete` | boolean | Whether the exchange should be deleted when the last queue is unbound from it.
<a name="channelBindingObjectExchangeVHost"></a>`exchange.vhost` | string | The virtual host of the exchange. Defaults to `/`.
<a name="channelBindingObjectQueue"></a>`queue` | Map[string, any] | When `is`=`queue`, this object defines the queue properties.
<a name="channelBindingObjectQueueName"></a>`queue.name` | string | The name of the queue. It MUST NOT exceed 255 characters long.
<a name="channelBindingObjectQueueDurable"></a>`queue.durable` | boolean | Whether the queue should survive broker restarts or not.
<a name="channelBindingObjectQueueExclusive"></a>`queue.exclusive` | boolean | Whether the queue should be used only by one connection or not.
<a name="channelBindingObjectAutoDelete"></a>`queue.autoDelete` | boolean | Whether the queue should be deleted when the last consumer unsubscribes.
<a name="channelBindingObjectQueueVHost"></a>`queue.vhost` | string | The virtual host of the queue. Defaults to `/`.
<a name="channelBindingObjectBindingVersion"></a>`bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

##### Example

```yaml
channels:
userSignup:
address: 'user/signup'
bindings:
amqp:
is: routingKey
exchange:
name: myExchange
type: topic
durable: true
autoDelete: false
vhost: /
bindingVersion: 0.3.0
```

```yaml
channels:
userSignup:
address: 'user/signup'
bindings:
amqp:
is: queue
queue:
name: my-queue-name
durable: true
exclusive: true
autoDelete: false
vhost: /
bindingVersion: 0.3.0
```

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

## Operation Binding Object

This object contains information about the operation representation in AMQP.

##### Fixed Fields

Field Name | Type | Applies To Action | Description
---|:---:|:---:|---
<a name="operationBindingObjectExpiration"></a>`expiration` | integer | `receive`, `send` | TTL (Time-To-Live) for the message. It MUST be greater than or equal to zero.
<a name="operationBindingObjectUserId"></a>`userId` | string | `receive`, `send` | Identifies the user who has sent the message.
<a name="operationBindingObjectCC"></a>`cc` | [string] | `receive`, `send` | The routing keys the message should be routed to at the time of publishing.
<a name="operationBindingObjectPriority"></a>`priority` | integer | `receive`, `send` | A priority for the message.
<a name="operationBindingObjectDeliveryMode"></a>`deliveryMode` | integer | `receive`, `send` | Delivery mode of the message. Its value MUST be either 1 (transient) or 2 (persistent).
<a name="operationBindingObjectMandatory"></a>`mandatory` | boolean | `receive` | Whether the message is mandatory or not.
<a name="operationBindingObjectBCC"></a>`bcc` | [string] | `receive` | Like [cc](#operationBindingObjectCC) but consumers will not receive this information.
<a name="operationBindingObjectTimestamp"></a>`timestamp` | boolean | `receive`, `send` | Whether the message should include a timestamp or not.
<a name="operationBindingObjectAck"></a>`ack` | boolean | Subscribe | Whether the consumer should ack 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.

##### Example

```yaml
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
```


<a name="message"></a>

## Message Binding Object

This object contains information about the message representation in AMQP.

##### Fixed Fields

Field Name | Type | Description
---|:---:|---
<a name="messageBindingObjectContentEncoding"></a>`contentEncoding` | string | A MIME encoding for the message content.
<a name="messageBindingObjectMessageType"></a>`messageType` | string | Application-specific message type.
<a name="messageBindingObjectBindingVersion"></a>`bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

```yaml
channels:
userSignup:
address: 'user/signup'
messages:
userSignupMessage:
bindings:
amqp:
contentEncoding: gzip
messageType: 'user.signup'
bindingVersion: 0.3.0
```
42 changes: 42 additions & 0 deletions markdown/docs/reference/bindings/amqp1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: 'amqp1'
weight: 12
---

# AMQP 1.0 Bindings

This document defines how to describe AMQP 1.0-specific information on AsyncAPI.

<a name="version"></a>

## Version

Current version is `0.1.0`.


<a name="server"></a>

## Server Binding Object

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




<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

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

<a name="message"></a>

## Message Binding Object

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