Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 2.12 KB

README.md

File metadata and controls

53 lines (27 loc) · 2.12 KB
Raw

WebSockets Bindings

This document defines how to describe WebSockets-specific information on AsyncAPI.

Version

Current version is 0.1.0.

Server Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Channel Binding Object

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.

Fixed Fields
Field Name Type Description
method string The HTTP method to use when establishing the connection. Its value MUST be either GET or POST.
query Schema Object | Reference Object A Schema object containing the definitions for each query parameter. This schema MUST be of type object and have a properties key.
headers Schema Object | Reference Object 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.
bindingVersion string The version of this binding. If omitted, "latest" MUST be assumed.

This object MUST contain only the properties defined above.

Operation Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.

Message Binding Object

This object MUST NOT contain any properties. Its name is reserved for future use.