fix: testing for notify_triagers #3476
Conversation
sambhavgupta0705
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
|
Warning Rate limit exceeded@sambhavgupta0705 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 51 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (2)
WalkthroughThe pull request updates the "Validate AsyncAPI" documentation guide, focusing on refining language and expanding guidance around validation practices. The changes primarily involve enhancing the introduction, maintaining existing validation method descriptions, and providing more detailed information about linting practices using the Spectral tool. The document now offers a clearer and more comprehensive overview of AsyncAPI validation techniques. Changes
Possibly related PRs
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
|
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
markdown/docs/guides/validate.md (1)
Line range hint
82-117: Fix Spectral configuration examples formatThe Spectral configuration examples use invalid JSON format with JavaScript-style comments. They should use valid JSON format.
Here's the corrected format:
- { - "rules": { - // add your own rules here - } - } + { + "rules": { + } + }And for the second example:
- { - "rules": { - "valid-document-version": { - "message": "Application title must start with upper case", - "severity": "error", - "given": "$.info", - "then": [ - { - "field": "title", - "function": "pattern", - "functionOptions": { - "match": "^[A-Z]" - } - } - ] - } - } - } + { + "rules": { + "valid-document-version": { + "message": "Application title must start with upper case", + "severity": "error", + "given": "$.info", + "then": [ + { + "field": "title", + "function": "pattern", + "functionOptions": { + "match": "^[A-Z]" + } + } + ] + } + } + }
🧹 Nitpick comments (2)
markdown/docs/guides/validate.md (2)
8-8: Fix grammatical error in introductionRemove the extra space before the period and consider adding back "documents" for clarity.
-In this guide, you'll learn multiple ways to validate AsyncAPI . +In this guide, you'll learn multiple ways to validate AsyncAPI documents.
Line range hint
77-78: Add context about Spectral configuration file placementThe documentation should specify where to place the
.spectral.yamlfile and explain its scope (global vs project-level configuration).Consider adding this explanation:
2. Create a file named `.spectral.yaml` to begin writing your API description and document rules. + Place this file in your project root directory for project-specific rules, or in your home directory for global rules.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
markdown/docs/guides/validate.md(1 hunks)
🔇 Additional comments (1)
markdown/docs/guides/validate.md (1)
Line range hint 125-129: Verify external resource links
Let's ensure all referenced documentation links are accessible.
✅ Verification successful
All external resource links are valid and accessible
All referenced documentation links in the Additional resources section return HTTP 200 status codes, confirming they are accessible:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that all external links in the Additional resources section are accessible
# Extract and verify URLs from the markdown file
urls=(
"https://github.com/asyncapi/studio#readme"
"https://github.com/asyncapi/cli#readme"
"https://github.com/asyncapi/parser-js#readme"
"https://github.com/asyncapi/parser-go#readme"
)
for url in "${urls[@]}"; do
echo "Checking $url"
curl -s -L -I "$url" | head -n 1
done
Length of output: 1075
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3476 +/- ##
=======================================
Coverage 86.59% 86.59%
=======================================
Files 21 21
Lines 664 664
=======================================
Hits 575 575
Misses 89 89 ☔ View full report in Codecov by Sentry. |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3476--asyncapi-website.netlify.app/ |
asyncapi-bot
requested review from
BhaswatiRoy,
J0SAL,
TRohit20 and
VaishnaviNandakumar
sambhavgupta0705
requested review from
derberg,
akshatnema,
magicmatatjahu,
anshgoyalevil and
Mayaleeeee
as code owners
Summary by CodeRabbit