Skip to content

fix: correct displayName type in Sneak Peek AsyncAPI example - #5663

Open
swarupasaroogumma wants to merge 1 commit into
asyncapi:masterfrom
swarupasaroogumma:fix/displayname-type-example-v2
Open

fix: correct displayName type in Sneak Peek AsyncAPI example#5663
swarupasaroogumma wants to merge 1 commit into
asyncapi:masterfrom
swarupasaroogumma:fix/displayname-type-example-v2

Conversation

@swarupasaroogumma

@swarupasaroogumma swarupasaroogumma commented Jul 28, 2026

Copy link
Copy Markdown

Description

This PR updates the displayName field type in the AsyncAPI document shown in the Sneak Peek example.

Before:

displayName:
  type: object
  description: Name of the User

After:

displayName:
  type: string
  description: Name of the User

The AsyncAPI document example represents displayName as an object, while the generated TypeScript and documentation preview both represent it as a string. This change makes the three previews consistent.

Type of change

  • Bug fix

Testing

  • Verified the Sneak Peek example renders correctly locally.

Summary by CodeRabbit

  • Bug Fixes
    • Corrected the AsyncAPI example so the displayName payload property is displayed as a string.

@netlify

netlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 96d9ca0
🔍 Latest deploy log https://app.netlify.com/projects/asyncapi-website/deploys/6a6932e571a8000008c79cd9
😎 Deploy Preview https://deploy-preview-5663--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 738f699c-4a08-48e2-afa8-4e5a48362a6f

📥 Commits

Reviewing files that changed from the base of the PR and between 20216fd and 96d9ca0.

📒 Files selected for processing (1)
  • components/SneakPeek.tsx

📝 Walkthrough

Walkthrough

The rendered AsyncAPI example now represents the displayName payload property as a string instead of an object.

Changes

AsyncAPI Example Correction

Layer / File(s) Summary
Correct displayName property type
components/SneakPeek.tsx
The rendered AsyncAPI document changes the displayName property type from object to string.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: derberg, princerajpoot20, akshatnema

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: correcting the displayName type in the Sneak Peek AsyncAPI example.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@sonarqubecloud

Copy link
Copy Markdown

@asyncapi-bot

Copy link
Copy Markdown
Contributor

⚡️ Lighthouse report for the changes in this PR:

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Be Triaged

Development

Successfully merging this pull request may close these issues.

2 participants