Skip to content

Commit

Permalink
chore: remove section on channels being optional
Browse files Browse the repository at this point in the history
This change (from asyncapi/spec#661) is now being held back to
version 3.0 so I've removed the reference to it from the
release notes for 2.3

Signed-off-by: Dale Lane <dale.lane@uk.ibm.com>
  • Loading branch information
dalelane committed Jan 23, 2022
1 parent 37c970f commit 5895ab1
Showing 1 changed file with 0 additions and 45 deletions.
45 changes: 0 additions & 45 deletions pages/blog/release-notes-2.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,51 +48,6 @@ These are added to the many other aspects of the AsyncAPI specification which ca
This new feature was contributed by [Sergio Moya](https://www.linkedin.com/in/smoya). For more detail, see this [pull request](https://github.com/asyncapi/spec/pull/665) and the [Github issue where this change was discussed](https://github.com/asyncapi/spec/issues/660).


## Channels are now optional

Related to the above change, and also in support of enabling greater flexibility in how AsyncAPI documents are structured and reused, `channels` are no longer a required section.

This change makes it easier, for example, to have an AsyncAPI document that only contains reusable component definitions.

For example, you could now have a document like this, which you use solely to hold reusable components for use in other documents.

```yaml
asyncapi: 2.3.0
info:
description: Dictionary for our definitions
servers:
production:
$ref: '#/components/servers/myserver'
components:
servers:
myserver:
url: "http://localhost:5000/ws"
protocol: ws
channels:
myChannel:
description: "mychannel"
myOtherChannel:
description: "another channel"
```

This could be then used in other documents, like:
```yaml
asyncapi: 2.3.0
info:
description: My awesome service API
servers:
myserver:
$ref: 'dictionary.yaml#/components/servers/myserver'
channels:
mychannel1:
$ref: 'dictionary.yaml#/components/channels/myChannel'
mychannel2:
$ref: 'dictionary.yaml#/components/channels/myOtherChannel'
```

For more detail, see the [Github issue where this change was discussed](https://github.com/asyncapi/spec/issues/661).


## New protocol bindings

The specification is now extended to support another custom protocol through the bindings feature:
Expand Down

0 comments on commit 5895ab1

Please sign in to comment.