chore: update examples so messages reference channel messages (#997)

asyncapi · Nov 29, 2023 · 1a8c669 · 1a8c669
1 parent 5fb88a0
commit 1a8c669
Show file tree

Hide file tree

Showing 21 changed files with 111 additions and 111 deletions.
diff --git a/examples/anyof-asyncapi.yml b/examples/anyof-asyncapi.yml
@@ -6,15 +6,15 @@ channels:
   test:
     address: test
     messages:
-      publish.message:
+      testMessages:
         $ref: '#/components/messages/testMessages'
 operations:
-  test.publish:
+  test:
     action: receive
     channel:
       $ref: '#/channels/test'
     messages:
-      - $ref: '#/components/messages/testMessages'
+      - $ref: '#/channels/test/messages/testMessages'
 components:
   messages:
     testMessages:

diff --git a/examples/application-headers-asyncapi.yml b/examples/application-headers-asyncapi.yml
@@ -37,7 +37,7 @@ operations:
       Inform about environmental lighting conditions of a particular
       streetlight.
     messages:
-      - $ref: '#/components/messages/lightMeasured'
+      - $ref: '#/channels/lightingMeasured/messages/lightMeasured'
 components:
   messages:
     lightMeasured:

diff --git a/examples/correlation-id-asyncapi.yml b/examples/correlation-id-asyncapi.yml
@@ -81,13 +81,13 @@ operations:
       Inform about environmental lighting conditions of a particular
       streetlight.
     messages:
-      - $ref: '#/components/messages/lightMeasured'
+      - $ref: '#/channels/lightingMeasured/messages/lightMeasured'
   dimLight:
     action: send
     channel:
       $ref: '#/channels/lightsDim'
     messages:
-      - $ref: '#/components/messages/dimLight'
+      - $ref: '#/channels/lightsDim/messages/dimLight'
 components:
   messages:
     lightMeasured:

diff --git a/examples/gitter-streaming-asyncapi.yml b/examples/gitter-streaming-asyncapi.yml
@@ -38,8 +38,8 @@ operations:
       http:
         method: POST
     messages:
-      - $ref: '#/components/messages/chatMessage'
-      - $ref: '#/components/messages/heartbeat'
+      - $ref: '#/channels/rooms/messages/chatMessage'
+      - $ref: '#/channels/rooms/messages/heartbeat'
 components:
   securitySchemes:
     httpBearerToken:

diff --git a/examples/kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml b/examples/kraken-websocket-request-reply-message-filter-in-reply-asyncapi.yml
@@ -49,21 +49,21 @@ operations:
       channel: 
         $ref: '#/channels/currencyExchange'
       messages:
-        - $ref: '#/components/messages/pong'
+        - $ref: '#/channels/currencyExchange/messages/pong'
     messages:
-      - $ref: '#/components/messages/ping'
+      - $ref: '#/channels/currencyExchange/messages/ping'
   sendHeartbeat:
     action: send
     channel: 
       $ref: '#/channels/currencyExchange'
     messages:
-      - $ref: '#/components/messages/heartbeat'
+      - $ref: '#/channels/currencyExchange/messages/heartbeat'
   systemStatus:
     action: send
     channel: 
       $ref: '#/channels/currencyExchange'
     messages:
-      - $ref: '#/components/messages/systemStatus'
+      - $ref: '#/channels/currencyExchange/messages/systemStatus'
   receiveSubscribeRequest:
     action: receive
     channel: 
@@ -72,10 +72,10 @@ operations:
       channel: 
         $ref: '#/channels/currencyExchange'
       messages:
-        - $ref: '#/components/messages/subscriptionStatus'
-        - $ref: '#/components/messages/dummyCurrencyInfo'
+        - $ref: '#/channels/currencyExchange/messages/subscriptionStatus'
+        - $ref: '#/channels/currencyExchange/messages/dummyCurrencyInfo'
     messages:
-      - $ref: '#/components/messages/subscribe'
+      - $ref: '#/channels/currencyExchange/messages/subscribe'
   receiveUnsubscribeRequest:
     action: receive
     channel: 
@@ -84,9 +84,9 @@ operations:
       channel: 
         $ref: '#/channels/currencyExchange'   
       messages:
-        - $ref: '#/components/messages/subscriptionStatus'
+        - $ref: '#/channels/currencyExchange/messages/subscriptionStatus'
     messages:
-      - $ref: '#/components/messages/unsubscribe'
+      - $ref: '#/channels/currencyExchange/messages/unsubscribe'
 
 
 components:

diff --git a/examples/kraken-websocket-request-reply-multiple-channels-asyncapi.yml b/examples/kraken-websocket-request-reply-multiple-channels-asyncapi.yml
@@ -93,7 +93,7 @@ operations:
       channel: 
         $ref: '#/channels/currencyInfo'
       messages:
-        - $ref: '#/components/messages/subscriptionStatus'   
+        - $ref: '#/channels/currencyInfo/messages/subscriptionStatus'   
 
 
 components:

diff --git a/examples/mercure-asyncapi.yml b/examples/mercure-asyncapi.yml
@@ -28,13 +28,13 @@ operations:
     channel:
       $ref: '#/channels/books'
     messages:
-      - $ref: '#/components/messages/book'
+      - $ref: '#/channels/books/messages/book'
   SendBooksInfo:
     action: send
     channel:
       $ref: '#/channels/books'
     messages:
-      - $ref: '#/components/messages/book'
+      - $ref: '#/channels/books/messages/book'
 components:
   messages:
     book:

diff --git a/examples/not-asyncapi.yml b/examples/not-asyncapi.yml
@@ -6,15 +6,15 @@ channels:
   test:
     address: test
     messages:
-      publish.message:
+      testMessages:
         $ref: '#/components/messages/testMessages'
 operations:
-  test.publish:
+  onTestMsg:
     action: receive
     channel:
       $ref: '#/channels/test'
     messages:
-      - $ref: '#/components/messages/testMessages'
+      - $ref: '#/channels/test/messages/testMessages'
 components:
   messages:
     testMessages:

diff --git a/examples/oneof-asyncapi.yml b/examples/oneof-asyncapi.yml
@@ -6,31 +6,31 @@ channels:
   test:
     address: test
     messages:
-      publish.message:
+      testMessages:
         $ref: '#/components/messages/testMessages'
   test2:
     address: test2
     messages:
-      subscribe.message.0:
+      objectWithKey:
         payload:
           $ref: '#/components/schemas/objectWithKey'
-      subscribe.message.1:
+      objectWithKey2:
         payload:
           $ref: '#/components/schemas/objectWithKey2'
 operations:
-  test.publish:
+  onTestMsg:
     action: receive
     channel:
       $ref: '#/channels/test'
     messages:
-      - $ref: '#/components/messages/testMessages'
-  test2.subscribe:
+      - $ref: '#/channels/test/messages/testMessages'
+  sendTest:
     action: send
     channel:
       $ref: '#/channels/test2'
     messages:
-      - $ref: '#/channels/test2/messages/subscribe.message.0'
-      - $ref: '#/channels/test2/messages/subscribe.message.1'
+      - $ref: '#/channels/test2/messages/objectWithKey'
+      - $ref: '#/channels/test2/messages/objectWithKey2'
 components:
   messages:
     testMessages:

diff --git a/examples/operation-security-asyncapi.yml b/examples/operation-security-asyncapi.yml
@@ -6,16 +6,16 @@ info:
     This contract defines HTTP Push notification for  application authorization
     revocation topic
 channels:
-  AUTHORIZATION_REVOCATION:
+  authRevoke:
     address: AUTHORIZATION_REVOCATION
     messages:
-      subscribe.message:
+      message:
         $ref: '#/components/messages/message'
 operations:
-  AUTHORIZATION_REVOCATION.subscribe:
+  sendAuthRevoke:
     action: send
     channel:
-      $ref: '#/channels/AUTHORIZATION_REVOCATION'
+      $ref: '#/channels/authRevoke'
     security:
       - type: oauth2
         description: The oauth security descriptions
@@ -31,7 +31,7 @@ operations:
         method: POST
 
     messages:
-      - $ref: '#/components/messages/message'
+      - $ref: '#/channels/authRevoke/messages/message'
 components:
   messages:
     message:

diff --git a/examples/simple-asyncapi.yml b/examples/simple-asyncapi.yml
@@ -15,7 +15,7 @@ operations:
     channel:
       $ref: '#/channels/userSignedup'
     messages:
-      - $ref: '#/components/messages/UserSignedUp'
+      - $ref: '#/channels/userSignedup/messages/UserSignedUp'
 components:
   messages:
     UserSignedUp:

diff --git a/examples/slack-rtm-asyncapi.yml b/examples/slack-rtm-asyncapi.yml
@@ -115,58 +115,58 @@ operations:
     channel:
       $ref: '#/channels/root'
     messages:
-      - $ref: '#/components/messages/outgoingMessage'
+      - $ref: '#/channels/root/messages/outgoingMessage'
   sendMessages:
     action: send
     channel:
       $ref: '#/channels/root'
     messages:
-      - $ref: '#/components/messages/hello'
-      - $ref: '#/components/messages/connectionError'
-      - $ref: '#/components/messages/accountsChanged'
-      - $ref: '#/components/messages/botAdded'
-      - $ref: '#/components/messages/botChanged'
-      - $ref: '#/components/messages/channelArchive'
-      - $ref: '#/components/messages/channelCreated'
-      - $ref: '#/components/messages/channelDeleted'
-      - $ref: '#/components/messages/channelHistoryChanged'
-      - $ref: '#/components/messages/channelJoined'
-      - $ref: '#/components/messages/channelLeft'
-      - $ref: '#/components/messages/channelMarked'
-      - $ref: '#/components/messages/channelRename'
-      - $ref: '#/components/messages/channelUnarchive'
-      - $ref: '#/components/messages/commandsChanged'
-      - $ref: '#/components/messages/dndUpdated'
-      - $ref: '#/components/messages/dndUpdatedUser'
-      - $ref: '#/components/messages/emailDomainChanged'
-      - $ref: '#/components/messages/emojiRemoved'
-      - $ref: '#/components/messages/emojiAdded'
-      - $ref: '#/components/messages/fileChange'
-      - $ref: '#/components/messages/fileCommentAdded'
-      - $ref: '#/components/messages/fileCommentDeleted'
-      - $ref: '#/components/messages/fileCommentEdited'
-      - $ref: '#/components/messages/fileCreated'
-      - $ref: '#/components/messages/fileDeleted'
-      - $ref: '#/components/messages/filePublic'
-      - $ref: '#/components/messages/fileShared'
-      - $ref: '#/components/messages/fileUnshared'
-      - $ref: '#/components/messages/goodbye'
-      - $ref: '#/components/messages/groupArchive'
-      - $ref: '#/components/messages/groupClose'
-      - $ref: '#/components/messages/groupHistoryChanged'
-      - $ref: '#/components/messages/groupJoined'
-      - $ref: '#/components/messages/groupLeft'
-      - $ref: '#/components/messages/groupMarked'
-      - $ref: '#/components/messages/groupOpen'
-      - $ref: '#/components/messages/groupRename'
-      - $ref: '#/components/messages/groupUnarchive'
-      - $ref: '#/components/messages/imClose'
-      - $ref: '#/components/messages/imCreated'
-      - $ref: '#/components/messages/imMarked'
-      - $ref: '#/components/messages/imOpen'
-      - $ref: '#/components/messages/manualPresenceChange'
-      - $ref: '#/components/messages/memberJoinedChannel'
-      - $ref: '#/components/messages/message'
+      - $ref: '#/channels/root/messages/hello'
+      - $ref: '#/channels/root/messages/connectionError'
+      - $ref: '#/channels/root/messages/accountsChanged'
+      - $ref: '#/channels/root/messages/botAdded'
+      - $ref: '#/channels/root/messages/botChanged'
+      - $ref: '#/channels/root/messages/channelArchive'
+      - $ref: '#/channels/root/messages/channelCreated'
+      - $ref: '#/channels/root/messages/channelDeleted'
+      - $ref: '#/channels/root/messages/channelHistoryChanged'
+      - $ref: '#/channels/root/messages/channelJoined'
+      - $ref: '#/channels/root/messages/channelLeft'
+      - $ref: '#/channels/root/messages/channelMarked'
+      - $ref: '#/channels/root/messages/channelRename'
+      - $ref: '#/channels/root/messages/channelUnarchive'
+      - $ref: '#/channels/root/messages/commandsChanged'
+      - $ref: '#/channels/root/messages/dndUpdated'
+      - $ref: '#/channels/root/messages/dndUpdatedUser'
+      - $ref: '#/channels/root/messages/emailDomainChanged'
+      - $ref: '#/channels/root/messages/emojiRemoved'
+      - $ref: '#/channels/root/messages/emojiAdded'
+      - $ref: '#/channels/root/messages/fileChange'
+      - $ref: '#/channels/root/messages/fileCommentAdded'
+      - $ref: '#/channels/root/messages/fileCommentDeleted'
+      - $ref: '#/channels/root/messages/fileCommentEdited'
+      - $ref: '#/channels/root/messages/fileCreated'
+      - $ref: '#/channels/root/messages/fileDeleted'
+      - $ref: '#/channels/root/messages/filePublic'
+      - $ref: '#/channels/root/messages/fileShared'
+      - $ref: '#/channels/root/messages/fileUnshared'
+      - $ref: '#/channels/root/messages/goodbye'
+      - $ref: '#/channels/root/messages/groupArchive'
+      - $ref: '#/channels/root/messages/groupClose'
+      - $ref: '#/channels/root/messages/groupHistoryChanged'
+      - $ref: '#/channels/root/messages/groupJoined'
+      - $ref: '#/channels/root/messages/groupLeft'
+      - $ref: '#/channels/root/messages/groupMarked'
+      - $ref: '#/channels/root/messages/groupOpen'
+      - $ref: '#/channels/root/messages/groupRename'
+      - $ref: '#/channels/root/messages/groupUnarchive'
+      - $ref: '#/channels/root/messages/imClose'
+      - $ref: '#/channels/root/messages/imCreated'
+      - $ref: '#/channels/root/messages/imMarked'
+      - $ref: '#/channels/root/messages/imOpen'
+      - $ref: '#/channels/root/messages/manualPresenceChange'
+      - $ref: '#/channels/root/messages/memberJoinedChannel'
+      - $ref: '#/channels/root/messages/message'
 components:
   securitySchemes:
     token:

diff --git a/examples/social-media/backend/asyncapi.yaml b/examples/social-media/backend/asyncapi.yaml
@@ -22,23 +22,23 @@ channels:
   notifyAllCommentLiked:
     address: comment/liked
     messages:
-      subscribe.message:
+      commentLiked:
         $ref: '../common/messages.yaml#/commentLiked'
     description: Notify all the services that a comment has been liked.
     servers:
       - $ref: '#/servers/mosquitto'
   newLikeComment:
     address: like/comment
     messages:
-      publish.message:
+      likeComment:
         $ref: '../common/messages.yaml#/likeComment'
     description: When a comment like is received from the frontend.
     servers:
       - $ref: '#/servers/websiteWebSocketServer'
   commentsCountChange:
     address: 'comment/{commentId}/changed'
     messages:
-      publish.message:
+      commentChanged:
         $ref: '../common/messages.yaml#/commentChanged'
     description: >-
       When an event from the broker arrives telling us to update the comment
@@ -51,7 +51,7 @@ channels:
   updateCommentsCount:
     address: update/comment/likes
     messages:
-      subscribe.message:
+      updateCommentLikes:
         $ref: '../common/messages.yaml#/updateCommentLikes'
     description: Update comment likes count in the frontend.
     servers:
@@ -62,22 +62,22 @@ operations:
     channel:
       $ref: '#/channels/notifyAllCommentLiked'
     messages:
-      - $ref: '../common/messages.yaml#/commentLiked'
+      - $ref: '#/channels/notifyAllCommentLiked/messages/commentLiked'
   receiveCommentLike:
     action: receive
     channel:
       $ref: '#/channels/newLikeComment'
     messages:
-      - $ref: '../common/messages.yaml#/likeComment'
+      - $ref: '#/channels/newLikeComment/messages/likeComment'
   receiveCommentChange:
     action: receive
     channel:
       $ref: '#/channels/commentsCountChange'
     messages:
-      - $ref: '../common/messages.yaml#/commentChanged'
+      - $ref: '#/channels/commentsCountChange/messages/commentChanged'
   sendCommentLikeUpdate:
     action: send
     channel:
       $ref: '#/channels/updateCommentsCount'
     messages:
-      - $ref: '../common/messages.yaml#/updateCommentLikes'
+      - $ref: '#/channels/updateCommentsCount/messages/updateCommentLikes'