feat(rulesets): check uniqueness of AsyncAPI messages (#2224)

stoplightio · Aug 24, 2022 · 297531b · 297531b
1 parent 6e94cfa
commit 297531b
Show file tree

Hide file tree

Showing 8 changed files with 960 additions and 9 deletions.
diff --git a/docs/reference/asyncapi-rules.md b/docs/reference/asyncapi-rules.md
@@ -219,6 +219,40 @@ components:
 
 **Recommended:** Yes
 
+### asyncapi-message-messageId-uniqueness
+
+`messageId` must be unique across all the messages (except those one defined in the components).
+
+**Recommended:** Yes
+
+**Bad Example**
+
+```yaml
+channels:
+  smartylighting.streetlights.1.0.action.{streetlightId}.turn.on:
+    publish:
+      message:
+        messageId: turnMessage
+  smartylighting.streetlights.1.0.action.{streetlightId}.turn.off:
+    publish:
+      message:
+        messageId: turnMessage
+```
+
+**Good Example**
+
+```yaml
+channels:
+  smartylighting.streetlights.1.0.action.{streetlightId}.turn.on:
+    publish:
+      message:
+        messageId: turnOnMessage
+  smartylighting.streetlights.1.0.action.{streetlightId}.turn.off:
+    publish:
+      message:
+        messageId: turnOffMessage
+```
+
 ### asyncapi-operation-description
 
 Operation objects should have a description.