diff --git a/sse/README.md b/sse/README.md index aa66229d..593f9da5 100644 --- a/sse/README.md +++ b/sse/README.md @@ -4,6 +4,8 @@ This document defines how to describe Server Sent Events-specific information on See the [Server-Sent Events protocol specification][protocolSpecification]. +Server-Sent Events requires `http` protocol, so the SSE [Message Binding Object](#message) below is appropriate for Servers with protocol `http`. + ## Version @@ -22,17 +24,8 @@ This object MUST NOT contain any properties. Its name is reserved for future use ## Channel Binding Object -When using Server Sent Events, the channel represents a single logical message stream flowing from server to client. - -##### Fixed Fields - -Field Name | Type | Description ----|:---:|--- -`query` | [Schema Object][schemaObject] \| [Reference Object](referenceObject) | 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][schemaObject] \| [Reference Object](referenceObject) | A Schema object containing the definitions of the HTTP headers to use when establishing the request. 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 NOT contain any properties. Its name is reserved for future use. -This object MUST contain only the properties defined above. @@ -51,12 +44,10 @@ This object contains information about the message representation in SSE. Field Name | Type | Description ---|:---:|--- -`event` | string | Server-sent event type, defaults to `message` if omitted, by the [SSE specification][protocolSpecification]. | +`event` | string | Server-sent event type, typically `message`, to specify allowed SSE message types. | `bindingVersion` | string | The version of this binding. If omitted, "latest" MUST be assumed. This object MUST contain only the properties defined above. -[schemaObject]: https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#schemaObject -[referenceObject]: https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#referenceObject [protocolSpecification]: https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events