docs(bindings): JMS docs

asyncapi · May 14, 2024 · ba7d396 · ba7d396
1 parent 95f826e
commit ba7d396
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 23 deletions.
diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSChannelBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSChannelBinding.java
@@ -6,13 +6,13 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS channel binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#channel-binding-object">JMS channel binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSMessageBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSMessageBinding.java
@@ -6,13 +6,13 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS message binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#message-binding-object">JMS message binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSOperationBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSOperationBinding.java
@@ -6,13 +6,13 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS operation binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#operation-binding-object">JMS operation binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSServerBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/JMSServerBinding.java
@@ -6,13 +6,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS server binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#server-binding-object">JMS server binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/channel/JMSChannelBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/channel/JMSChannelBinding.java
@@ -5,13 +5,13 @@
 import org.jetbrains.annotations.Nullable;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS channel binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#channel-binding-object">JMS channel binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @Data
 @Builder

diff --git a/...re/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/channel/JMSChannelDestinationType.java b/...re/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/channel/JMSChannelDestinationType.java
@@ -2,6 +2,15 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 
+/**
+ * Describes JMS channel destination type.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#channel-binding-object">JMS channel binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
+ */
 public enum JMSChannelDestinationType {
 
     @JsonProperty("queue")

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/message/JMSMessageBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/message/JMSMessageBinding.java
@@ -6,13 +6,12 @@
 import org.jetbrains.annotations.Nullable;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS message binding.
  *
- * @version 0.1.0
- * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#message-binding-object">JMS message binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @Data
 @Builder

diff --git a/...i-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/operation/JMSOperationBinding.java b/...i-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/operation/JMSOperationBinding.java
@@ -10,9 +10,11 @@
  * <p>
  * Describes JMS operation binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#operation-binding-object">JMS operation binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @Data
 @NoArgsConstructor

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/server/JMSServerBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/server/JMSServerBinding.java
@@ -8,13 +8,13 @@
 import java.util.List;
 
 /**
- * This class MUST NOT contain any properties. Its name is reserved for future use.
- * <p>
  * Describes JMS server binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#server-binding-object">JMS server binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
  * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
  */
 @Data
 @Builder

diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/server/JMSServerProperty.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/jms/v0/_0_1/server/JMSServerProperty.java
@@ -5,6 +5,15 @@
 import lombok.NoArgsConstructor;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * Describes JMS server property.
+ *
+ * @see <a href="https://github.com/asyncapi/bindings/tree/master/jms#server-binding-object">JMS server binding</a>
+ * @see <a href="https://www.oracle.com/java/technologies/java-message-service.html">Java Message Service</a>
+ * @author Pavel Bodiachevskii
+ * @version 0.0.1
+ * @since 1.0.0-RC2
+ */
 @Data
 @NoArgsConstructor
 @AllArgsConstructor