Skip to content

Commit

Permalink
docs(websockets bindings): JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Pakisan committed Apr 21, 2024
1 parent 9c5f5ac commit 087ede7
Showing 1 changed file with 14 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
/**
* Describes WebSockets channel binding.
* <p>
* When using WebSockets, the channel represents the connection. Unlike other protocols that support multiple virtual
* channels (topics, routing keys, etc.) per connection, 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.
* When using WebSockets, the channel represents the connection.
* <p>
* Unlike other protocols that support multiple virtual channels (topics, routing keys, etc.) per connection,
* 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>
Expand All @@ -29,16 +30,19 @@
public class WebSocketsChannelBinding extends ChannelBinding {

/**
* The HTTP method to use when establishing the connection. Its value MUST be either GET or POST.
* The HTTP method to use when establishing the connection.
* <p>
* Its value <b>MUST</b> be either GET or POST.
*/
@Nullable
@JsonProperty("method")
@JsonPropertyDescription("The HTTP method to use when establishing the connection. Its value MUST be either GET or POST.")
private WebSocketsChannelMethod method;

/**
* A Schema object containing the definitions for each query parameter. This schema MUST be of type
* object and have a properties key.
* A Schema object containing the definitions for each query parameter.
* <p>
* This schema <b>MUST</b> be of type object and have a properties key.
*/
@Nullable
@JsonProperty("query")
Expand All @@ -47,15 +51,16 @@ public class WebSocketsChannelBinding extends ChannelBinding {

/**
* A Schema object containing the definitions of the HTTP headers to use when establishing the connection.
* This schema MUST be of type object and have a properties key.
* <p>
* This schema <b>MUST</b> be of type object and have a properties key.
*/
@Nullable
@JsonProperty("headers")
@JsonPropertyDescription("A Schema object containing the definitions of the HTTP headers to use when establishing the connection. This schema MUST be of type object and have a properties key.")
private AsyncAPISchema headers;

/**
* The version of this binding. If omitted, "latest" MUST be assumed.
* The version of this binding. If omitted, "latest" <b>MUST</b> be assumed.
*/
@Nullable
@Builder.Default
Expand Down

0 comments on commit 087ede7

Please sign in to comment.