Skip to content

Commit c61574b

Browse files
committed
add description to events
1 parent 35dc6ac commit c61574b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

standards/application/waku-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -365,6 +365,7 @@ The node uses [P2P-RELIABILITY](/standards/application/p2p-reliability.md) strat
365365
types:
366366
MessageSentEvent:
367367
type: object
368+
description: "Event emitted when a message is sent to the network"
368369
fields:
369370
event_type:
370371
type: string
@@ -379,6 +380,7 @@ types:
379380
380381
MessageErrorEvent:
381382
type: object
383+
description: "Event emitted when a message send operation fails"
382384
fields:
383385
event_type:
384386
type: string
@@ -396,6 +398,7 @@ types:
396398
397399
MessagePropagatedEvent:
398400
type: object
401+
description: "Confirmation that a message has been correctly delivered to the network"
399402
fields:
400403
event_type:
401404
type: string

0 commit comments

Comments
 (0)