fix: update website link in website submodule (#3797). #4420
Conversation
viramhh98
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
sambhavgupta0705
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughUpdated the AsyncAPI Server API entry’s links.websiteUrl from https://api.asyncapi.com/v1 to https://www.asyncapi.com/docs/concepts/server in both config/tools-automated.json and config/tools.json. No other fields or logic changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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. Comment Pre-merge checks✅ Passed checks (3 passed)
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4420 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 22 22
Lines 778 778
Branches 144 144
=========================================
Hits 778 778 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4420--asyncapi-website.netlify.app/ |
![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
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
config/tools-automated.json(1 hunks)config/tools.json(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Learnt from: bandantonio
PR: asyncapi/website#4264
File: markdown/docs/tutorials/getting-started/coming-from-openapi.md:24-25
Timestamp: 2025-07-19T20:58:34.040Z
Learning: In the AsyncAPI website documentation, anchor references to specification sections can use camelCase format (e.g., #serverObject, #parameterObject, #messageObject) even if the actual HTML IDs on the spec page use hyphenated lowercase format. This is acceptable and should not be changed.
📚 Learning: 2025-01-19T04:51:41.255Z
Learnt from: anshgoyalevil
PR: asyncapi/website#3557
File: tests/fixtures/markdown/check-edit-links-data.js:3-11
Timestamp: 2025-01-19T04:51:41.255Z
Learning: In the AsyncAPI website repository, the test data in `tests/fixtures/markdown/check-edit-links-data.js` intentionally includes inconsistent paths (with and without 'docs' prefix) to verify the script's ability to normalize and handle ambiguous path structures.
Applied to files:
config/tools-automated.json
⏰ 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). (2)
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Lighthouse CI
🔇 Additional comments (1)
config/tools.json (1)
26-29: websiteUrl points at a concept doc — change to the API base or repowebsiteUrl currently resolves to https://www.asyncapi.com/docs/concepts/server (your check returned HTTP 200). docsUrl is https://api.asyncapi.com/v1/docs and repoUrl is https://github.com/asyncapi/server-api. Recommended: set websiteUrl to the API base (https://api.asyncapi.com/v1 — preferred) or to the repo.
Apply one of these diffs (preferred: restore previous):
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server", + "websiteUrl": "https://api.asyncapi.com/v1",or
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server", + "websiteUrl": "https://github.com/asyncapi/server-api",Run this verification and paste full output:
for u in \ "https://www.asyncapi.com/docs/concepts/server" \ "https://api.asyncapi.com/v1" \ "https://api.asyncapi.com/v1/docs" \ "https://github.com/asyncapi/server-api" do echo "----" echo "$u" curl -sS -I -L -o /dev/null -w 'HTTP_CODE:%{http_code} URL:%{url_effective}\n' "$u" || echo "curl failed for $u" done
| "websiteUrl": "https://www.asyncapi.com/docs/concepts/server", | ||
| "docsUrl": "https://api.asyncapi.com/v1/docs", | ||
| "repoUrl": "https://github.com/asyncapi/server-api" | ||
| }, |
There was a problem hiding this comment.
🧩 Analysis chain
Automated config drift: same incorrect link.
Mirror the fix here so both configs stay in sync; use the API base, docs, or repo instead of the Server concept page. (asyncapi.com)
Apply one of:
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
+ "websiteUrl": "https://api.asyncapi.com/v1",or
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
+ "websiteUrl": "https://github.com/asyncapi/server-api",Run the same URL check as above after updating.
🏁 Script executed:
#!/bin/bash
# Search repo for the exact problematic URL and related fields, and dump the config file if present.
set -euo pipefail
echo "---- 1) Find exact occurrences of the problematic URL ----"
rg -n --hidden -S "https://www.asyncapi.com/docs/concepts/server" -g '!*node_modules/*' -g '!*dist/*' || true
echo
echo "---- 2) Show config/tools-automated.json (first 300 lines) ----"
if [ -f config/tools-automated.json ]; then
sed -n '1,300p' config/tools-automated.json || true
else
echo "config/tools-automated.json not found"
fi
echo
echo "---- 3) Find all 'websiteUrl' entries across the repo (with surrounding context) ----"
rg -n --hidden -S '"websiteUrl"\s*:\s*".+?"' -g '!*node_modules/*' -g '!*dist/*' -C2 || true
echo
echo "---- 4) Search for api.asyncapi.com/v1 and github.com/asyncapi/server-api usages ----"
rg -n --hidden -S "api.asyncapi.com/v1" -g '!*node_modules/*' -g '!*dist/*' || true
rg -n --hidden -S "github.com/asyncapi/server-api" -g '!*node_modules/*' -g '!*dist/*' || true
echo
echo "---- 5) Print exit (script finished) ----"Length of output: 10723
Automated config drift — fix duplicate incorrect websiteUrl in config/tools-automated.json
config/tools-automated.json (toolsList entry "AsyncAPI Server API", lines 31–34) still uses "https://www.asyncapi.com/docs/concepts/server"; mirror the other config and replace with the API base or the repo.
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
+ "websiteUrl": "https://api.asyncapi.com/v1",or
- "websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
+ "websiteUrl": "https://github.com/asyncapi/server-api",Run the same URL check after updating.
📝 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.
| "websiteUrl": "https://www.asyncapi.com/docs/concepts/server", | |
| "docsUrl": "https://api.asyncapi.com/v1/docs", | |
| "repoUrl": "https://github.com/asyncapi/server-api" | |
| }, | |
| "websiteUrl": "https://api.asyncapi.com/v1", | |
| "docsUrl": "https://api.asyncapi.com/v1/docs", | |
| "repoUrl": "https://github.com/asyncapi/server-api" | |
| }, |
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 31 to 34, the toolsList entry
"AsyncAPI Server API" has an incorrect duplicate websiteUrl
("https://www.asyncapi.com/docs/concepts/server"); update that value to match
the other config entry (use the API base URL or the repository URL, e.g., the
repoUrl "https://github.com/asyncapi/server-api" or the proper API base like
"https://api.asyncapi.com/"), and then run the URL check/validation used by the
repo to ensure the new URL passes automated checks.
|
/rtm |
|
Hello, @viramhh98! 👋🏼 |
|
/help |
|
Hello, @viramhh98! 👋🏼 |
2 participants
Description
Related Issue(s)
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores