From 287b8a44ed62414a2c7cd60ef69485b60484bf39 Mon Sep 17 00:00:00 2001 From: Vladimir Gorej Date: Mon, 7 Feb 2022 22:10:13 +0100 Subject: [PATCH] docs(spec): indicate in detail how Channel Item Object field resolves Refs #612 --- spec/asyncapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/asyncapi.md b/spec/asyncapi.md index 8f04a83c..1b589eb6 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -565,7 +565,7 @@ Describes the operations available on a single channel. Field Name | Type | Description ---|:---:|--- -$ref | `string` | Allows for an external definition of this channel item. The referenced structure MUST be in the format of a [Channel Item Object](#channelItemObject). If there are conflicts between the referenced definition and this Channel Item's definition, the behavior is *undefined*.

**Deprecated:** Usage of the `$ref` property has been deprecated. +$ref | `string` | Allows for an internal or external definition of this channel item. The referenced structure MUST be in the format of a [Channel Item Object](#channelItemObject). If there are conflicts between the referenced definition and this Channel Item's definition, the behavior is *undefined*. Rules of resolving are defined by [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) specification.

**Deprecated:** Usage of the `$ref` property has been deprecated. description | `string` | An optional description of this channel item. [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation. servers | [`string`] | The servers on which this channel is available, specified as an optional unordered list of names (string keys) of [Server Objects](#serverObject) defined in the [Servers Object](#serversObject) (a map). If `servers` is absent or empty then this channel must be available on all servers defined in the [Servers Object](#serversObject). subscribe | [Operation Object](#operationObject) | A definition of the SUBSCRIBE operation, which defines the messages produced by the application and sent to the channel.