Skip to content

Commit

Permalink
docs(bindings): AMQP docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Pakisan
Pakisan committed May 14, 2024
1 parent 45b5ece commit 0d27495
Show file tree
Hide file tree
Showing 28 changed files with 80 additions and 34 deletions.
3 changes: 2 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/AMQPChannelBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
* <p>
* Contains information about the channel representation in AMQP.
*
* @since 1.0.0-RC2
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
3 changes: 2 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/AMQPMessageBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
* <p>
* Contains information about the message representation in AMQP.
*
* @since 1.0.0-RC2
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#message-binding-object">AMQP message binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
3 changes: 2 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/AMQPOperationBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
* <p>
* Contains information about the operation representation in AMQP.
*
* @since 1.0.0-RC2
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#operation-binding-object">AMQP operation binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
3 changes: 2 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/AMQPServerBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
* <p>
* Contains information about the server representation in AMQP.
*
* @since 1.0.0-RC2
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#server-binding-object">AMQP server binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @since 1.0.0-RC2
*/
@JsonTypeInfo(
use = JsonTypeInfo.Id.NAME,
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_1_0/channel/AMQPChannelBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
* <p>
* Contains information about the channel representation in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_1_0/channel/AMQPChannelType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the type of channel in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
public enum AMQPChannelType {

Expand Down
4 changes: 3 additions & 1 deletion ...va/com/asyncapi/bindings/amqp/v0/_1_0/channel/exchange/AMQPChannelExchangeProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the channel exchange properties in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_1_0/channel/exchange/AMQPChannelExchangeType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the channel exchange type in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@JsonClassDescription("Describes AMQP 0-9-1 channel exchange type.")
public enum AMQPChannelExchangeType {
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_1_0/channel/queue/AMQPChannelQueueProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the queue exchange properties in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_1_0/message/AMQPMessageBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#message-binding-object">AMQP message binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...core/src/main/java/com/asyncapi/bindings/amqp/v0/_1_0/operation/AMQPOperationBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
* <p>
* Contains information about the operation representation in AMQP.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#operation-binding-object">AMQP operation binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
6 changes: 3 additions & 3 deletions asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_1_0/server/AMQPServerBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

/**
* This class MUST NOT contain any properties. Its name is reserved for future use.
* <p>
* Describes AMQP 0-9-1 server binding.
*
* @version 0.1.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#server-binding-object">AMQP server binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_2_0/channel/AMQPChannelBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
* <p>
* Contains information about the channel representation in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_2_0/channel/AMQPChannelType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the type of channel in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
public enum AMQPChannelType {

Expand Down
4 changes: 3 additions & 1 deletion ...va/com/asyncapi/bindings/amqp/v0/_2_0/channel/exchange/AMQPChannelExchangeProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the channel exchange properties in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_2_0/channel/exchange/AMQPChannelExchangeType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the channel exchange type in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@JsonClassDescription("Describes AMQP 0-9-1 channel exchange type.")
public enum AMQPChannelExchangeType {
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_2_0/channel/queue/AMQPChannelQueueProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the queue exchange properties in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.1.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_2_0/message/AMQPMessageBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#message-binding-object">AMQP message binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...core/src/main/java/com/asyncapi/bindings/amqp/v0/_2_0/operation/AMQPOperationBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
* <p>
* Contains information about the operation representation in AMQP.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#operation-binding-object">AMQP operation binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
6 changes: 3 additions & 3 deletions asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_2_0/server/AMQPServerBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

/**
* This class MUST NOT contain any properties. Its name is reserved for future use.
* <p>
* Describes AMQP 0-9-1 server binding.
*
* @version 0.2.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#server-binding-object">AMQP server binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.2.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_3_0/channel/AMQPChannelBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
* <p>
* Contains information about the channel representation in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_3_0/channel/AMQPChannelType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the type of channel in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
public enum AMQPChannelType {

Expand Down
4 changes: 3 additions & 1 deletion ...va/com/asyncapi/bindings/amqp/v0/_3_0/channel/exchange/AMQPChannelExchangeProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the channel exchange properties in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_3_0/channel/exchange/AMQPChannelExchangeType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@
* <p>
* Contains information about the channel exchange type in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@JsonClassDescription("Describes AMQP 0-9-1 channel exchange type.")
public enum AMQPChannelExchangeType {
Expand Down
4 changes: 3 additions & 1 deletion ...ain/java/com/asyncapi/bindings/amqp/v0/_3_0/channel/queue/AMQPChannelQueueProperties.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the queue exchange properties in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#channel-binding-object">AMQP channel binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...api-core/src/main/java/com/asyncapi/bindings/amqp/v0/_3_0/message/AMQPMessageBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
* <p>
* Contains information about the message representation in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#message-binding-object">AMQP message binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
4 changes: 3 additions & 1 deletion ...core/src/main/java/com/asyncapi/bindings/amqp/v0/_3_0/operation/AMQPOperationBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
* <p>
* Contains information about the operation representation in AMQP.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#operation-binding-object">AMQP operation binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@Builder
Expand Down
6 changes: 3 additions & 3 deletions asyncapi-core/src/main/java/com/asyncapi/bindings/amqp/v0/_3_0/server/AMQPServerBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

/**
* This class MUST NOT contain any properties. Its name is reserved for future use.
* <p>
* Describes AMQP 0-9-1 server binding.
*
* @version 0.3.0
* @see <a href="https://github.com/asyncapi/bindings/tree/master/amqp#server-binding-object">AMQP server binding</a>
* @see <a href="https://www.amqp.org">AMQP</a>
* @author Pavel Bodiachevskii
* @version 0.3.0
* @since 1.0.0-RC2
*/
@Data
@NoArgsConstructor
Expand Down

0 comments on commit 0d27495

Please sign in to comment.