[Doc] AsyncAPI: publish and subcribe confusion?

[fmvilas]

Search before asking

• I had searched in the issues and found no similar issues.

Documentation Related

There seem to be a few typos in this document regarding AsyncAPI.

If I'm understanding it correctly, you want to define the microservices using AsyncAPI. If that's the case, then subscribe and publish verbs must be exchanged in the following 4 places:

• https://github.com/apache/incubator-eventmesh/blob/master/docs/en/features/eventmesh-workflow-design.md?plain=1#L62
• https://github.com/apache/incubator-eventmesh/blob/master/docs/en/features/eventmesh-workflow-design.md?plain=1#L77
• https://github.com/apache/incubator-eventmesh/blob/master/docs/en/features/eventmesh-workflow-design.md?plain=1#L97
• https://github.com/apache/incubator-eventmesh/blob/master/docs/en/features/eventmesh-workflow-design.md?plain=1#L117

I know it can be confusing at first (and still is for me! 😅) but AsyncAPI operation verbs (publish and subscribe) represent operations the described application accepts instead of the operations it performs. So, for instance, when you say "publish" it means others can publish to this microservice (therefore the microservice should subscribe).

Here's a good article explaining the meaning: https://www.asyncapi.com/blog/publish-subscribe-semantics

Needless to say, we're working on changing this for version 3 of the spec which we want to release this year. Here you can track progress regarding this publish/subscribe meaning: asyncapi/spec#520.

Happy to submit a PR :)

Are you willing to submit PR?

• Yes I am willing to submit a PR!

[github-actions]

Welcome to the Apache EventMesh (incubating) community!!
We are glad that you are contributing by opening this issue. :D

Please make sure to include all the relevant context.
We will be here shortly.

If you are interested in contributing to our project, please let us know!
You can check out our contributing guide on contributing to EventMesh.

Want to get closer to the community?

WeChat Group：

Mailing Lists:

Name	Description	Subscribe	Unsubscribe	Archive
Users	User support and questions mailing list	Subscribe	Unsubscribe	Mail Archives
Development	Development related discussions	Subscribe	Unsubscribe	Mail Archives
Commits	All commits to repositories	Subscribe	Unsubscribe	Mail Archives

[fmvilas]

So having an offline chat with @tsurdilo, he rightly corrected my own confusion here 😅 It seems to be fine as it is because, for instance, the Online App Store is the one putting messages into store/order channel. Therefore the AsyncAPI verb should be "subscribe".

I'm closing the issue but feel free to reopen it again. Sorry for the noise 🙏