chore: message example issue in migration guide #3673
Conversation
message never sat on the channel level in v2.
VisualBean
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
VisualBean
changed the title
VisualBean
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3673 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 20 20
Lines 732 732
=========================================
Hits 732 732 ☔ View full report in Codecov by Sentry. |
WalkthroughThe migration guide for AsyncAPI v3 has been updated to document the breaking changes from v2. The update details a reorganization of metadata (now under the Changes
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
markdown/docs/migration/migrating-to-v3.md (1)
412-414: Consider adding migration guidance for complex parameter types.While the simplification of parameters in v3 is well explained, it would be helpful to add guidance for users who need to migrate from v2's complex parameter types (objects, booleans) to v3's string-only approach.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/migration/migrating-to-v3.md(2 hunks)
🔇 Additional comments (2)
markdown/docs/migration/migrating-to-v3.md (2)
150-162: Well-documented explanation of the publish/subscribe changes!The explanation of the shift from
publish/subscribetosend/receiveis clear and comprehensive. The inclusion of references to further reading materials is particularly helpful for users who want to understand the reasoning behind this breaking change.
350-352: Excellent improvement in schema organization!The consolidation of schema format with the schema itself in v3 is a significant improvement that enhances reusability. This change makes the relationship between schema and its format more explicit and maintainable.
|
|
||
| asyncapi: 2.6.0 | ||
| ... | ||
| channels: | ||
| user/signedup: | ||
| message: | ||
| messageId: UserMessage | ||
| publish |
There was a problem hiding this comment.
Fix syntax error in v2 example code.
The publish keyword is missing a colon in the v2 example.
Apply this diff to fix the syntax:
- publish
+ publish:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| publish | |
| publish: |
Found an issue in the migration guide surrounding messages. Specifically the example under channels.
Where its stated that message sat on the channel level (which they do not in V2)
Summary by CodeRabbit