Skip to content

Conversation

@derberg
Copy link
Member

@derberg derberg commented Jan 28, 2026

Summary by CodeRabbit

  • Documentation
    • Added a new blog post announcing AsyncAPI Specification 3.1.0 with metadata, release notes, roadmap/look-ahead topics, tooling notes, acknowledgments, and photo attribution.
    • Updated numerous docs and tutorials to reference AsyncAPI v3.1.0 in examples and explanatory text across concepts, guides, and tutorials.
    • No public API or exported declarations were changed.

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

@netlify
Copy link

netlify bot commented Jan 28, 2026

Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit c75827a
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/697deee7c9cd7c0008d76ebe
😎 Deploy Preview https://deploy-preview-5034--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@derberg derberg mentioned this pull request Jan 28, 2026
27 tasks
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

Warning

Rate limit exceeded

@derberg has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 13 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Adds a new release notes blog post and updates numerous documentation Markdown files to reference AsyncAPI spec version 3.1.0 (replacing 3.0.0) in examples and spec links; no public or exported API declarations changed.

Changes

Cohort / File(s) Summary
Blog Post Addition
markdown/blog/release-notes-3.1.0.md
New release notes post with frontmatter and sections on protocol bindings, tooling support, look‑ahead, acknowledgments, and photo attribution.
Concepts & Document Samples
markdown/docs/concepts/asyncapi-document/adding-messages.md, markdown/docs/concepts/asyncapi-document/adding-operations.md, markdown/docs/concepts/asyncapi-document/dynamic-channel-address.md, markdown/docs/concepts/asyncapi-document/extending-specification.md, markdown/docs/concepts/asyncapi-document/index.md, markdown/docs/concepts/asyncapi-document/reply-info.md, markdown/docs/concepts/asyncapi-document/reusability-with-traits.md, markdown/docs/concepts/asyncapi-document/reusable-parts.md, markdown/docs/concepts/asyncapi-document/securing-operations.md, markdown/docs/concepts/asyncapi-document/server-security.md, markdown/docs/concepts/asyncapi-document/tags.md, markdown/docs/concepts/asyncapi-document/variable-url.md
Bumped AsyncAPI version strings and reference links from v3.0.0 to v3.1.0 inside YAML examples and spec reference URLs. No behavior changes.
Guides & Tutorials
markdown/docs/guides/message-validation.md, markdown/docs/tutorials/create-asyncapi-document.md, markdown/docs/tutorials/getting-started/asyncapi-documents.md, markdown/docs/tutorials/getting-started/hello-world.md, markdown/docs/tutorials/getting-started/request-reply.md, markdown/docs/tutorials/getting-started/security.md, markdown/docs/tutorials/getting-started/servers.md, markdown/docs/tutorials/studio-document-validation.md
Updated sample AsyncAPI YAML snippets and accompanying text to reference spec v3.1.0 instead of v3.0.0.
Kafka & WebSocket Tutorials
markdown/docs/tutorials/kafka/..., markdown/docs/tutorials/websocket/...
Replaced AsyncAPI version values in Kafka and WebSocket tutorial examples and consolidated docs to v3.1.0. No structural or logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hopped through docs with a curious nose,
I nudged each snippet where the version grows,
3.1.0 now shining in every line,
A gentle spring of changes — carrot cake time! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add v3.1 release notes' directly and clearly reflects the main change: adding release notes for AsyncAPI v3.1.0, which is evident from the new blog post and version updates across documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (0edc692) to head (c75827a).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #5034   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           22        22           
  Lines          796       796           
  Branches       146       146           
=========================================
  Hits           796       796           

☔ 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.

@asyncapi-bot
Copy link
Contributor

asyncapi-bot commented Jan 28, 2026

⚡️ 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-5034--asyncapi-website.netlify.app/

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@markdown/blog/release-notes-3.1.0.md`:
- Line 13: Update the excerpt text that currently reads 'AsyncAPI 3.1 is now
released with new RSO 2 binding.' to use the correct protocol name "ROS 2" by
changing 'RSO 2' to 'ROS 2' in the excerpt field (the line starting with
excerpt:). Ensure the corrected string reads 'AsyncAPI 3.1 is now released with
new ROS 2 binding.' so it matches the rest of the document.
- Line 32: Fix the typo in the release note sentence that currently reads "RSO 2
binding": locate the line containing "JSON Schema that supports validation of
AsyncAPI documents with RSO 2 binding is updated..." and change "RSO 2" to "ROS
2" so it reads "ROS 2 binding", leaving the rest of the sentence (and the
`@asyncapi/specs` version mention) unchanged.
- Around line 32-33: The release notes incorrectly reference AsyncAPI 3.1.0,
`@asyncapi/specs` v6.11.0, and an official ROS 2 binding; update the text to
reference the released AsyncAPI version 3.0.0 everywhere (replace "3.1.0" with
"3.0.0"), remove the claim that a ROS 2 binding is official (delete or mark as
"draft/community" if you must mention it), and correct the package statement
about `@asyncapi/specs` to reflect the actual published schemas (mention it
supports 3.0.0 only); also change the parser statement to say that parser-js
(parser-js) supports and validates 3.0.0 documents rather than 3.1.0.
🧹 Nitpick comments (1)
markdown/blog/release-notes-3.1.0.md (1)

45-45: Add newline at end of file.

The file is missing a trailing newline, which is a common best practice for text files and helps with version control and text processing tools.

@princerajpoot20
Copy link
Member

@thulieblack @Barbanio @TRohit20 Need your attention. Please take a look on this

@bandantonio
Copy link
Collaborator

LGTM

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@markdown/docs/tutorials/kafka/managing-schemas-using-schema-registry.md`:
- Line 108: There are two occurrences of the AsyncAPI declaration set to
"asyncapi: 3.1.0"; update both instances (the top-level YAML key string
"asyncapi: 3.1.0" found in the two example documents) to "asyncapi: 3.0.0" so
the examples use the official AsyncAPI 3.0.0 spec and retain the existing
structures like channels, operations, and components.messages/$ref references.

@derberg
Copy link
Member Author

derberg commented Jan 30, 2026

don't worry there are so many files changed - focus on blog, rest is just 3.0.0 -> 3.1.0 update in docs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@markdown/blog/release-notes-3.1.0.md`:
- Line 36: Replace the bare URL "https://studio.asyncapi.com/" with a proper
Markdown link; update the sentence that mentions "AsyncAPI Studio" so the URL is
wrapped (for example, link the text “AsyncAPI Studio” or the domain to
https://studio.asyncapi.com/) to satisfy MD034 and keep formatting consistent
with the existing line that references AsyncAPI Studio.
🧹 Nitpick comments (1)
markdown/blog/release-notes-3.1.0.md (1)

40-45: Reduce repetition in consecutive “Huge thanks” sentences.

Three successive sentences start with “Huge thanks,” which reads repetitive; consider varying phrasing.

- JSON Schema that supports validation of AsyncAPI documents with ROS 2 binding is updated in [this](https://github.com/asyncapi/spec-json-schemas/releases/tag/v6.11.1) repository. Also **@asyncapi/specs** package has been updated on NPM to version 6.11.1.
- [JavaScript Parser](https://github.com/asyncapi/parser-js/releases/tag/%40asyncapi%2Fparser%403.6.0) uses latest **@asyncapi/specs** package and can be used to parse and validate 3.1.0 documents. Upgrade to latest version.
- [JavaScript Converter](https://github.com/asyncapi/converter-js/releases/tag/v1.7.0) uses latest **@asyncapi/parser** package and can be used to convert to 3.1.0 documents. Upgrade to latest version. This conversion is just the version change in `asyncapi` field.
- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Avoid bare URL in Markdown.

Line 36 uses a bare URL; wrap it in a proper Markdown link to satisfy MD034 and keep formatting consistent.

✅ Suggested fix
-- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents.
+- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to [studio.asyncapi.com](https://studio.asyncapi.com/) and see you can already write 3.1.0 documents.
📝 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.

Suggested change
- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to https://studio.asyncapi.com/ and see you can already write 3.1.0 documents.
- [AsyncAPI Studio](https://github.com/asyncapi/studio) is also updated so just go to [studio.asyncapi.com](https://studio.asyncapi.com/) and see you can already write 3.1.0 documents.
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)

[warning] 36-36: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In `@markdown/blog/release-notes-3.1.0.md` at line 36, Replace the bare URL
"https://studio.asyncapi.com/" with a proper Markdown link; update the sentence
that mentions "AsyncAPI Studio" so the URL is wrapped (for example, link the
text “AsyncAPI Studio” or the domain to https://studio.asyncapi.com/) to satisfy
MD034 and keep formatting consistent with the existing line that references
AsyncAPI Studio.

derberg and others added 3 commits January 31, 2026 12:41
Updated release notes for AsyncAPI 3.1.0 to correct phrasing and improve clarity.
Copy link
Member

@thulieblack thulieblack left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also give you a round of applause 😉

@derberg
Copy link
Member Author

derberg commented Jan 31, 2026

/rtm

@asyncapi-bot asyncapi-bot merged commit d57c7cf into asyncapi:master Jan 31, 2026
20 checks passed
@github-project-automation github-project-automation bot moved this from To Be Triaged to Done in Website - Kanban Jan 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants