From dcf6fdb15c521f2405c84ef49e9431901329dace Mon Sep 17 00:00:00 2001 From: Achintya Sharma Date: Sat, 13 Apr 2024 06:27:52 +0530 Subject: [PATCH] docs: changes in document create-asyncapi-document (#2860) Co-authored-by: Quetzalli --- pages/docs/tutorials/create-asyncapi-document.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pages/docs/tutorials/create-asyncapi-document.md b/pages/docs/tutorials/create-asyncapi-document.md index f6addf842c87..3277ea083fe3 100644 --- a/pages/docs/tutorials/create-asyncapi-document.md +++ b/pages/docs/tutorials/create-asyncapi-document.md @@ -14,7 +14,7 @@ You want to build a system that can turn streetlights on and off based on their - You will implement an event-driven architecture (EDA) with a message broker in its "center." -- The Streetlights application will receive information about environmental lighting. +- The Streetlights application will receive information about environmental lighting conditions. - The Streetlights application will connect to the broker and receive a stream of events from all the streetlights devices reporting their conditions. @@ -73,7 +73,7 @@ channels: id: type: integer minimum: 0 - description: Id of the streetlight. + description: ID of the streetlight. lumens: type: integer minimum: 0 @@ -90,7 +90,7 @@ operations: $ref: '#/channels/lightMeasured'`} -Let's break it down into pieces: +Let's break the above code snippet down into pieces: {`asyncapi: 3.0.0 @@ -134,7 +134,7 @@ Now, let's move on to the `channels` section. In the `servers` section, you spec In this example, `light/measured` is the channel address. From the Streetlight application example perspective, it means that `light/measured` is the topic's name in the MQTT broker. -Next is the `payload` property, which is used to understand how the event should look like when transfered over the specific channel: +Next is the payload property. It is used to understand how the event should look like when publishing to that channel {` payload: