feat: using CloudEvents with AsyncAPI

[Lazzaretti]

Description

• A new section, "Message Formats," to describe how message formats can be used in AsyncAPI.
• Starting with the use case to add CloudEvents envelopes.
• Currently, all links refer to repos outside of AsyncAPI to make the PR self-contained. When feat: add CloudEvents Message Traits as a component spec#1161 is merged, the links can be moved

Related issue(s)

• Discussion on the approach: Proposal to add official CloudEvents Traits to the AsyncAPI ownership spec#1102
• Adding the component to AsyncAPI Spec: feat: add CloudEvents Message Traits as a component spec#1161
• Intermediate solution in the CloudEvents repo was discussed in AsyncAPI v3 Trait for CloudEvents cloudevents/spec#1276 and merged into the cloudevents repo: https://github.com/cloudevents/spec/blob/main/cloudevents/working-drafts/asyncapi.md

Summary by CodeRabbit

• Documentation
  • Added new Message Formats reference section covering CloudEvents integration with AsyncAPI, including Structured Mode and Binary Mode details with practical examples
  • Included guidelines for contributing new message formats to the catalog

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[netlify]

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	1502ba8
🔍 Latest deploy log	https://app.netlify.com/projects/asyncapi-website/deploys/6954ed409d683600088a115b
😎 Deploy Preview	https://deploy-preview-4819--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

Three new documentation files are added to the reference section, establishing a message formats subsection. Files include metadata configuration, an index with contribution guidelines, and CloudEvents format documentation covering Structured and Binary modes.

Changes

Cohort / File(s)	Summary
Message Formats Documentation markdown/docs/reference/message-formats/_section.md, markdown/docs/reference/message-formats/index.md, markdown/docs/reference/message-formats/cloudevents.md	Creates new message formats reference section with metadata file, main index introducing message format concepts and contribution instructions, and detailed CloudEvents documentation including Structured/Binary modes, protocol bindings, serialization details, and example references

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 New sections bloom in the docs we adore,
Message Formats catalog opening its door!
CloudEvents explained with clarity so keen,
References refined in colors of green,
Our warren of knowledge grows ever more serene! 🌿

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'feat: using CloudEvents with AsyncAPI' clearly summarizes the main change: adding documentation and support for CloudEvents integration with AsyncAPI, as evidenced by the new CloudEvents documentation file and the broader Message Formats section.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c1473dc) to head (1502ba8).

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #4819   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          798       798           
  Branches       146       146           
=========================================
  Hits           798       798           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

markdown/docs/reference/message-formats/index.md (1)

17-17: Fix compound adjective hyphenation.

Line 17 uses "AsyncAPI specific trait" when it should be hyphenated as "AsyncAPI-specific trait" (compound adjectives before nouns require hyphens).

🔎 Proposed fix

-If an AsyncAPI specific trait is needed, a pull request to the [Components Catalog](https://github.com/asyncapi/spec/tree/master/components) can be made to include it.
+If an AsyncAPI-specific trait is needed, a pull request to the [Components Catalog](https://github.com/asyncapi/spec/tree/master/components) can be made to include it.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c1473dc and 1502ba8.

📒 Files selected for processing (3)

• markdown/docs/reference/message-formats/_section.md
• markdown/docs/reference/message-formats/cloudevents.md
• markdown/docs/reference/message-formats/index.md

🧰 Additional context used

🪛 LanguageTool

markdown/docs/reference/message-formats/index.md

[grammar] ~17-~17: Use a hyphen to join words.
Context: ...ference/message-formats). If an AsyncAPI specific trait is needed, a pull request...

(QB_NEW_EN_HYPHEN)

🪛 markdownlint-cli2 (0.18.1)

markdown/docs/reference/message-formats/cloudevents.md

10-10: Bare URL used

(MD034, no-bare-urls)

markdown/docs/reference/message-formats/index.md

10-10: Bare URL used

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: Redirect rules - asyncapi-website
• GitHub Check: Header rules - asyncapi-website
• GitHub Check: Pages changed - asyncapi-website
• GitHub Check: cypress-run
• GitHub Check: Lighthouse CI
• GitHub Check: Test NodeJS PR - windows-latest
• GitHub Check: Test NodeJS PR - macos-latest

🔇 Additional comments (3)

markdown/docs/reference/message-formats/_section.md (1)

1-4: LGTM!

The section header is correctly configured with an appropriate weight value to position it within the documentation hierarchy.

markdown/docs/reference/message-formats/index.md (1)

6-17: Excellent introductory content and clear contribution guidance.

The overview effectively explains message formats, provides practical guidance on usage in AsyncAPI documents, and includes actionable instructions for contributors. The structure and tone are well-suited for documentation.

markdown/docs/reference/message-formats/cloudevents.md (1)

6-67: Comprehensive and well-structured CloudEvents documentation.

The guide effectively covers both Structured and Binary modes with clear explanations, practical examples, and helpful references. The tables provide quick reference guidance, and the YAML examples demonstrate proper usage patterns. This is excellent foundational documentation for the message formats catalog.

[asyncapi-bot]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	37
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-4819--asyncapi-website.netlify.app/