docs: clarifications on publish and subscribe #521
Conversation
While keeping the meaning of the AsyncAPI spec entirely unchanged, i've added clarifying statements on the meaning of the `publish` and `subscribe` operations.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
GeraldLoeffler
changed the title
update from upstream
|
Thanks for the feedback @derberg : i've incorporated it, but left the 2 sentences |
|
Kudos, SonarCloud Quality Gate passed!
|
| Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received. For example, an operation might describe a chat application use case where a user sends a text message to a group. | ||
| Describes a publish or a subscribe operation. This provides a place to document how and why messages are sent and received. | ||
|
|
||
| For example, an operation might describe a chat application use case where a user sends a text message to a group. A publish operation describes messages that are received by the chat application, whereas a subscribe operation describes messages that are sent by the chat application. |
There was a problem hiding this comment.
Hello. New here but willing to collaborate.
While reading this, I think "chat application" is quite ambiguous of who's sending and receiving. Following to the Event Driven Architectures docs, it might be clearer to state "publish operation describes messages that are received by the chat application's message broker" and "subscribe operation describes messages that are sent by the chat application's message broker", or around those lines
There was a problem hiding this comment.
hi @ alexleonescalera, i agree that chat is not the best example, but this is the example currently used in the spec in this location. I wanted to provide a focused point change to the spec that just provides more clarity on the intent of the publish and subscribe operations - without making any other changes, such as changing the example used here.
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
It is actually not included in the release. This was an unintentional release caused by the release automation initial run. 1.0 version of the spec was released a long time ago. The release mentioned by the bot was removed. |
|
🎉 This PR is included in version 2.1.0-2021-06-release.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
@all-contributors please add @GeraldLoeffler for docs |
|
I've put up a pull request to add @GeraldLoeffler! 🎉 |
|
@GeraldLoeffler you contributed more than just docs. You are a very active member of the community and you push hard many topics around the spec, which is 🚀 @magicmatatjahu I'll work on a follow-up PR for a more complex update to |
|
I only added Gerald to area |
|
@magicmatatjahu no worries, you reacted fast which is super cool! |
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
Not included in release 2.1 yet, 2.1 was mistakenly triggered by our automation. |
|
🎉 This PR is included in version 2.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
While keeping the meaning of the AsyncAPI spec entirely unchanged, i've added clarifying statements on the meaning of the
publishandsubscribeoperations.Description
Related issue(s)