Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: channel object / $ref note. #826

Merged
merged 8 commits into from
Oct 18, 2023
Merged

docs: channel object / $ref note. #826

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8733388
Update asyncapi.md
ponelat Aug 22, 2022
3dfb71d
Update asyncapi.md
ponelat Aug 22, 2022
c8f2cd4
Update asyncapi.md
ponelat Aug 23, 2022
4d113c2
Update asyncapi.md
ponelat Sep 5, 2022
235b242
Update spec/asyncapi.md
derberg Jul 20, 2023
a42281e
Merge branch 'master' into patch-1
derberg Jul 20, 2023
2425fc5
Merge branch 'master' into patch-1
derberg Sep 28, 2023
50dbafe
fix markdown lint
derberg Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion spec/asyncapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@ Describes the operations available on a single channel.

Field Name | Type | Description
---|:---:|---
<a name="channelItemObjectRef"></a>$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*. <br/><br/>**Deprecated:** Usage of the `$ref` property has been deprecated.
<a name="channelItemObjectRef"></a>$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*. <br/><br/>**Deprecated:** Using the $ref field has been deprecated when accompanied by other fields.
derberg marked this conversation as resolved.
Show resolved Hide resolved
<a name="channelItemObjectDescription"></a>description | `string` | An optional description of this channel item. [CommonMark syntax](https://spec.commonmark.org/) can be used for rich text representation.
<a name="channelItemObjectServers"></a>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).
<a name="channelItemObjectSubscribe"></a>subscribe | [Operation Object](#operationObject) | A definition of the SUBSCRIBE operation, which defines the messages produced by the application and sent to the channel.
Expand Down