Skip to content

fix: update website link in website submodule (#3797). #4420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
viramhh98 wants to merge 2 commits into from
Closed

fix: update website link in website submodule (#3797). #4420

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d77ec96
Fix broken link in @asyncapi/generator documentation
viramhh98 Sep 16, 2025
c29ff57
Merge branch 'master' into fix-broken-link
asyncapi-bot Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/tools-automated.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"title": "AsyncAPI Server API",
"description": "Server API providing official AsyncAPI tools",
"links": {
"websiteUrl": "https://api.asyncapi.com/v1",
"websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
"docsUrl": "https://api.asyncapi.com/v1/docs",
"repoUrl": "https://github.com/asyncapi/server-api"
},
Comment on lines +31 to 34
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 16, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

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

Suggested change
"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.

Expand Down
2 changes: 1 addition & 1 deletion config/tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"title": "AsyncAPI Server API",
"description": "Server API providing official AsyncAPI tools",
"links": {
"websiteUrl": "https://api.asyncapi.com/v1",
"websiteUrl": "https://www.asyncapi.com/docs/concepts/server",
"docsUrl": "https://api.asyncapi.com/v1/docs",
"repoUrl": "https://github.com/asyncapi/server-api"
},
Expand Down
Loading