docs(bindings): WebSockets docs

asyncapi · May 14, 2024 · b7276dc · b7276dc
1 parent dcce9aa
commit b7276dc
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 21 deletions.
diff --git a/asyncapi-core/src/main/java/com/asyncapi/bindings/websockets/WebSocketsChannelBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/websockets/WebSocketsChannelBinding.java
@@ -15,9 +15,10 @@
  * WebSockets doesn't support virtual channels or, put it another way, there's only one channel and its characteristics
  * are strongly related to the protocol used for the handshake, i.e., HTTP.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#channel-binding-object">WebSockets channel binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</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/websockets/WebSocketsMessageBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/websockets/WebSocketsMessageBinding.java
@@ -7,15 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class <b>MUST NOT</b> contain any properties.
- * <p>
- * Its name is reserved for future use.
- * <p>
  * Describes WebSockets message binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#message-binding-object">WebSockets message binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</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/websockets/WebSocketsOperationBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/websockets/WebSocketsOperationBinding.java
@@ -7,15 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class <b>MUST NOT</b> contain any properties.
- * <p>
- * Its name is reserved for future use.
- * <p>
  * Describes WebSockets operation binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#operation-binding-object">WebSockets operation binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</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/websockets/WebSocketsServerBinding.java b/asyncapi-core/src/main/java/com/asyncapi/bindings/websockets/WebSocketsServerBinding.java
@@ -7,15 +7,12 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * This class <b>MUST NOT</b> contain any properties.
- * <p>
- * Its name is reserved for future use.
- * <p>
  * Describes WebSockets server binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#server-binding-object">WebSockets server binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @since 1.0.0-RC2
  */
 @JsonTypeInfo(
         use = JsonTypeInfo.Id.NAME,

diff --git a/.../main/java/com/asyncapi/bindings/websockets/v0/_1_0/channel/WebSocketsChannelBinding.java b/.../main/java/com/asyncapi/bindings/websockets/v0/_1_0/channel/WebSocketsChannelBinding.java
@@ -21,9 +21,11 @@
  * WebSockets doesn't support virtual channels or, put it another way, there's only one channel and its characteristics
  * are strongly related to the protocol used for the handshake, i.e., HTTP.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#channel-binding-object">WebSockets channel binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
  */
 @Data
 @AllArgsConstructor

diff --git a/...c/main/java/com/asyncapi/bindings/websockets/v0/_1_0/channel/WebSocketsChannelMethod.java b/...c/main/java/com/asyncapi/bindings/websockets/v0/_1_0/channel/WebSocketsChannelMethod.java
@@ -7,8 +7,10 @@
  * <p>
  * Its value <b>MUST</b> be either GET or POST.
  *
- * @version 0.1.0
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
  */
 public enum WebSocketsChannelMethod {
 

diff --git a/.../main/java/com/asyncapi/bindings/websockets/v0/_1_0/message/WebSocketsMessageBinding.java b/.../main/java/com/asyncapi/bindings/websockets/v0/_1_0/message/WebSocketsMessageBinding.java
@@ -11,9 +11,11 @@
  * <p>
  * Describes WebSockets message binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#message-binding-object">WebSockets message binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
  */
 @Data
 @EqualsAndHashCode(callSuper = true)

diff --git a/...n/java/com/asyncapi/bindings/websockets/v0/_1_0/operation/WebSocketsOperationBinding.java b/...n/java/com/asyncapi/bindings/websockets/v0/_1_0/operation/WebSocketsOperationBinding.java
@@ -11,9 +11,11 @@
  * <p>
  * Describes WebSockets operation binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#operation-binding-object">WebSockets operation binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
  */
 @Data
 @EqualsAndHashCode(callSuper = true)

diff --git a/...rc/main/java/com/asyncapi/bindings/websockets/v0/_1_0/server/WebSocketsServerBinding.java b/...rc/main/java/com/asyncapi/bindings/websockets/v0/_1_0/server/WebSocketsServerBinding.java
@@ -11,9 +11,11 @@
  * <p>
  * Describes WebSockets server binding.
  *
- * @version 0.1.0
  * @see <a href="https://github.com/asyncapi/bindings/tree/master/websockets#server-binding-object">WebSockets server binding</a>
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API">MDN WebSockets</a>
  * @author Pavel Bodiachevskii
+ * @version 0.1.0
+ * @since 1.0.0-RC2
  */
 @Data
 @EqualsAndHashCode(callSuper = true)