Skip to content
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

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

Merged
merged 4 commits into from
Aug 24, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/reference/asyncapi-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,40 @@ components:

**Recommended:** Yes

### asyncapi-message-messageId-uniqueness

`messageId` must be unique across all the messages (except these one defined in the components).
jonaslagoni marked this conversation as resolved.
Show resolved Hide resolved
P0lip marked this conversation as resolved.
Show resolved Hide resolved

**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.
Expand Down