-
-
Notifications
You must be signed in to change notification settings - Fork 689
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.
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
[📑 Docs]: add new tutorial Hello World for producer application #993
Comments
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request. |
On reading the document again, I suppose I'm coming from a pub/sub perspective where the publisher documents the events that it publishes on topics and then one or more subscribers subscribe to them. In the pub/sub scenario subscribers don't specify the events they expect to receive as they have no choice over the matter; they are subscribing to another system's events. The Hello World example is more akin to a application is defining the commands that it expects to be sent on a queue.
I think I got confused because reading the documents in sequence, the previous sections talked about event-driven architectures but the very first example was not really publishing or subscribing to an event, it was written from a receiver application being sent a command. Should we convert the example into an application publishing an event? |
it all depends on what is your use case for AsyncAPI. Is it only docs from consumer's point of view. Or maybe you are interested in code generation. Or maybe you have a WebSocket API where you send and receive messages. There is also a request/reply pattern in pub/sub, where you want to know what message you can sent to a services, and where you should specify where the reply should be sent. So yeah, it really depends on where you are coming from and what is your goal.
what about we just provide another tutorial for publishing. So we keep the current one, @alequetzalli thoughts? |
This issue has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
I mean... I'm confused too. |
@alequetzalli can you have a look? |
@alequetzalli ping pong |
Hey @derberg and @asos-andrewpotts, not sure how I missed this one! First, thank you for sharing your thoughts with such detail, @asos-andrewpotts. I had to consider and process them. Second, I must admit I align with Lukasz' recommendation. Let's keep the current one, |
so yeah, this issue was created before v3 release now, hello world document shows how to describe in AsyncAPI that app is receiving a message would be still nice to have an example where app is sending a message so |
Got it, thanks for the reply @derberg ! |
This issue has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation. There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
What Dev Docs changes are you proposing?
Regarding the Hello World example:
The description around this example confused me a little bit.
Why is this example written in the eyes of the subscriber? It starts with "Let's define an application that's capable of receiving".
Then the Async API document uses the word "publish:".
Normally I'd write a specification around the publisher and the messages it emits. I don't normally define the message that the subscriber expects to receive.
Wouldn't it be better describing it as "Let's define an application that's capable of publishing a message"......?
Code of Conduct
The text was updated successfully, but these errors were encountered: