Skip to content

Commit

Permalink
tw editorial fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
quetzalliwrites authored Nov 16, 2023
1 parent 1d98d15 commit 2ab0545
Showing 1 changed file with 16 additions and 20 deletions.
36 changes: 16 additions & 20 deletions pages/docs/concepts/asyncapi-document/adding-bindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Adding Bindings
weight: 260
---

Bindings in AsyncAPI provide a way to add protocol-specific information to the AsyncAPI documentation. They can be added to different document parts, such as servers, channels, or messages, to specify standard details specific to a particular protocol. The purpose of bindings is to enhance the understanding and usage of the API by providing additional context and configuration options for different protocols.
Bindings in AsyncAPI provide a way to add protocol-specific information to the AsyncAPI documentation. They can be added to different document parts, such as servers, channels, or messages; they specify standard details specific to a particular protocol. The purpose of bindings is to enhance the API's understanding and usage by providing additional context and configuration options for different protocols.

Here is a diagram explaining binding:
The following diagram highlights the sections where bindings can be implemented:

```mermaid
graph TD
Expand All @@ -24,13 +24,12 @@ style H fill:#47BCEE,stroke:#47BCEE;
style I fill:#47BCEE,stroke:#47BCEE;
```

This diagram illustrates the structure of an AsyncAPI document and the areas where bindings can be applied.

## Server bindings

Server bindings provide protocol-specific information related to the server configuration. For example, if you use Pulsar as your message broker, you can specify tenant name in the server bindings.
Server bindings provide protocol-specific information related to the server configuration. For example, if you use Pulsar as your message broker, you can specify the tenant name in the server bindings.

Here is a diagram explaining server binding:
Here is a diagram explaining server bindings:

```mermaid
graph LR
Expand All @@ -42,7 +41,7 @@ style C fill:#47BCEE,stroke:#47BCEE;

This diagram shows where server bindings fit into the AsyncAPI document structure.

Here is an example of using server bindings to specify protocol-specific information related to the server configuration:
The next example showcases how to use server bindings to detail protocol-specific configurations for the server:

```yml
servers:
Expand All @@ -53,13 +52,13 @@ servers:
bindingVersion: '0.1.0'
```
This document shows how to set up server bindings for a server that is a Pulsar broker.
The previous document shows how to set up server bindings for a server that is a Pulsar broker.
## Channel bindings
Channel bindings are used to specify protocol-specific information for a specific channel. For example, in Kafka, you can specify number of partitions for a given topic.
Here is a diagram explaining channel binding:
Here is a diagram explaining where channel bindings fit into the AsyncAPI document structure:
```mermaid
graph LR
Expand All @@ -69,7 +68,6 @@ D --> G{Channel Bindings}
style G fill:#47BCEE,stroke:#47BCEE;
```

This diagram shows where channel bindings fit into the AsyncAPI document structure.

Here is an example of using channel bindings to specify protocol-specific information for a specific channel:

Expand All @@ -90,13 +88,13 @@ channels:
bindingVersion: '0.4.0'
```
This document shows how to set up channel bindings for a channel that represents Kafka topic.
The previous document shows how to configure channel bindings for a Kafka topic-representative channel.
## Message bindings
Message bindings provide protocol-specific information for a specific message. For example, for AMQP protocol you can specify the type of the message in a protocol specific notation.
Message bindings provide protocol-specific information for a specific message. For example, for the AMQP protocol, you can specify the message type in a protocol-specific notation.
Here is a diagram explaining message binding:
Here is a diagram explaining where message bindings fit into the AsyncAPI document structure:
```mermaid
graph LR
Expand All @@ -106,7 +104,6 @@ F --> G{Message Bindings}
style G fill:#47BCEE,stroke:#47BCEE;
```

This diagram shows where Message Bindings fit into the AsyncAPI document structure.

Here is an example of using message bindings to provide protocol-specific information for a specific message:

Expand All @@ -123,13 +120,13 @@ channels:
bindingVersion: 0.3.0
```
This document shows how to set up message bindings for a message transported using AMQP protocol.
The previous document shows how to set up message bindings for a message transported using the AMQP protocol.
## Operation Bindings
## Operation bindings
Operation bindings allow you to specify protocol-specific information for a specific operation. For example, for MQTT, you can specify the quality of the service for given operation.
Operation bindings allow you to specify protocol-specific information for a specific operation. For example, for MQTT, you can specify the quality of the service for a given operation.
Here is a diagram explaining operation binding:
Here is a diagram explaining where operation bindings fit into the AsyncAPI document structure:
```mermaid
graph LR
Expand All @@ -140,7 +137,6 @@ E --> H{Operation Bindings}
style H fill:#47BCEE,stroke:#47BCEE;
```

This diagram shows where operation bindings fit into the AsyncAPI document structure.

Here is an example of using operation bindings to specify protocol-specific information for a specific operation:

Expand All @@ -157,6 +153,6 @@ operations:
bindingVersion: 0.2.0
```
This document shows how to set up operation bindings for operation that describes how application that uses MQTT as transport, receives the message.
The previous document shows how to set up operation bindings for an operation that describes how an application that uses MQTT as transport, receives the message.
By using bindings, you can enhance the AsyncAPI documentation with protocol-specific details, making it easier for developers to understand and implement the API.
Using bindings helps you enhance the AsyncAPI documentation with protocol-specific details, making it easier to understand and implement the API.

0 comments on commit 2ab0545

Please sign in to comment.