chore: update tools.json #4203
chore: update tools.json #4203
Conversation
asyncapi-bot
requested review from
Mayaleeeee,
akshatnema,
anshgoyalevil,
asyncapi-bot-eve,
derberg and
sambhavgupta0705
as code owners
WalkthroughThe changes reorganize, rename, and correct metadata for several tool and template entries in Changes
Sequence Diagram(s)sequenceDiagram
participant ConfigEditor
participant ToolsJSON
participant ToolsAutomatedJSON
ConfigEditor->>ToolsAutomatedJSON: Reorder and update tool/template metadata
ConfigEditor->>ToolsAutomatedJSON: Rename and correct fields (description, URL, language, etc.)
ConfigEditor->>ToolsJSON: Swap descriptions, URLs, and categories for two entries
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4203 +/- ##
=========================================
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:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 13
🧹 Nitpick comments (1)
config/tools-automated.json (1)
52-73: Consistent alphabetical ordering for Code-first tools
Entries in the “Code-first tools” list should be sorted by title (ignoring case) to improve maintainability and predictability when adding or locating tools.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
config/tools-automated.json(11 hunks)config/tools.json(3 hunks)
⏰ Context from checks skipped due to timeout of 180000ms (5)
- GitHub Check: Automerge PR autoapproved by a bot
- GitHub Check: Lighthouse CI
- GitHub Check: Test NodeJS PR - windows-latest
- GitHub Check: Test NodeJS PR - ubuntu-latest
- GitHub Check: Test NodeJS PR - macos-13
🔇 Additional comments (5)
config/tools.json (2)
1710-1710: Correct repository URLThe repository URL now correctly points to the generator action (
actions-marketplace-validations/asyncapi_github-action-for-generator).
1722-1722: Correct category identifierThe category has been updated to the singular
"github-action", aligning with other entries in the section.config/tools-automated.json (3)
510-534: ZenWave SDK entry under Mocking and Testing looks good
Metadata matches other instances of this tool (links, filters, technology, categories). No issues.
695-709: ZenWave SDK entry under CLIs looks good
This occurrence matches the Mocking and Testing entry exactly; filters and links are consistent.
721-734: Mokapi CLI entry is consistent
Links, filters, technology, and categories align with the Mocking and Testing entry. No changes needed.
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "links": { | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| "repoUrl": "https://github.com/asyncapi/cli" |
There was a problem hiding this comment.
Incorrect repository URL
This entry now points to https://github.com/asyncapi/cli (the CLI repo) instead of the generator action. It should reference the generator action repository (actions-marketplace-validations/asyncapi_github-action-for-generator).
🤖 Prompt for AI Agents
In config/tools.json at line 1689, the repoUrl is incorrectly set to the CLI
repository URL. Update the repoUrl value to point to the generator action
repository by replacing the current URL with
https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator.
| { | ||
| "title": "GitHub Action for Generator", | ||
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "description": null, |
There was a problem hiding this comment.
Missing description for generator action
The second “GitHub Action for Generator” entry has a null description. Please provide a concise description so it displays correctly in the tools list.
🤖 Prompt for AI Agents
In config/tools.json at line 1708, the description field for the second "GitHub
Action for Generator" is set to null. Replace the null value with a concise,
meaningful description string that accurately summarizes the purpose of this
generator action to ensure it displays properly in the tools list.
| "title": "GitHub Action for Generator", | ||
| "description": null, | ||
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "links": { |
There was a problem hiding this comment.
Description mismatch: CLI text in generator action
The first “GitHub Action for Generator” entry’s description describes the AsyncAPI CLI, not the generator action. Please correct or revert this description to accurately reflect the generator action’s functionality.
🤖 Prompt for AI Agents
In config/tools.json around lines 1686 to 1688, the description for the "GitHub
Action for Generator" incorrectly describes the AsyncAPI CLI instead of the
generator action. Update the description to accurately reflect the generator
action's purpose and functionality, or revert it to the original correct
description that matches the generator action.
| ], | ||
| "categories": [ | ||
| "github-action" | ||
| "github-actions" |
There was a problem hiding this comment.
Inconsistent category identifier
The category is set to "github-actions" (plural), whereas all other GitHub Actions use the singular "github-action". Please revert to "github-action" for consistency across the section.
🤖 Prompt for AI Agents
In config/tools.json at line 1701, the category identifier is set to
"github-actions" (plural), which is inconsistent with the rest of the GitHub
Actions entries that use the singular "github-action". Change the category value
from "github-actions" to "github-action" to maintain consistency across the
section.
| "title": "GitHub Action for Generator", | ||
| "description": "CLI to work with your AsyncAPI files. You can validate them and in the future use a generator and even bootstrap a new file. Contributions are welcomed!", | ||
| "description": null, | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/cli" | ||
| "repoUrl": "https://github.com/actions-marketplace-validations/asyncapi_github-action-for-generator" | ||
| }, | ||
| "filters": { | ||
| "technology": [ | ||
| "AsyncAPI Generator" | ||
| ], | ||
| "categories": [ | ||
| "github-actions" | ||
| "github-action" | ||
| ], | ||
| "hasCommercial": false, | ||
| "isAsyncAPIOwner": true | ||
| "isAsyncAPIOwner": false | ||
| } |
There was a problem hiding this comment.
Provide description and unify category for second GitHub Action entry
The description is set to null (resulting in no text on the site) and the category label mismatches the first entry. Add a meaningful description or remove the null, and align the categories array with the other entry.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 489 to 503, the GitHub Action entry
has a null description and a category label that does not match the first entry.
Replace the null description with a meaningful text describing the GitHub
Action, and update the categories array to use the same category label as the
first GitHub Action entry to ensure consistency.
| "title": "nestjs-asyncapi", | ||
| "description": "Utilize decorators to generate AsyncAPI document utilizing DTOs (similar to @nestjs/swagger) and a web UI.", | ||
| "links": { | ||
| "websiteUrl": "https://github.com/daler-rahimov/sio-asyncapi", | ||
| "docsUrl": "https://github.com/daler-rahimov/sio-asyncapi", | ||
| "repoUrl": "https://github.com/daler-rahimov/sio-asyncapi" | ||
| "repoUrl": "https://github.com/flamewow/nestjs-asyncapi" | ||
| }, | ||
| "filters": { | ||
| "language": "Python", | ||
| "language": "Typescript", | ||
| "technology": [ | ||
| "Socket.IO", | ||
| "Flask" | ||
| "Node.js", | ||
| "NestJS" | ||
| ], | ||
| "categories": [ | ||
| "code-first", | ||
| "api" | ||
| "code-first" |
There was a problem hiding this comment.
Fix inconsistent TypeScript casing and missing docsUrl
The language filter is spelled “Typescript” but should be “TypeScript” to match other entries. Also consider adding a docsUrl alongside the repoUrl if this project provides documentation.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 141 to 153, correct the casing of
the language filter from "Typescript" to "TypeScript" to maintain consistency.
Additionally, add a "docsUrl" field next to the existing "repoUrl" under the
"links" section if the project has a documentation URL available, ensuring the
entry includes both repository and documentation links.
| "title": "Java Spring Template", | ||
| "description": "Java Spring template for the AsyncAPI Generator", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-cloud-stream-template" | ||
| "repoUrl": "https://github.com/asyncapi/java-spring-template" | ||
| }, | ||
| "filters": { | ||
| "language": [ | ||
| "javascript" | ||
| ], | ||
| "technology": [ | ||
| "Spring Cloud Streams", | ||
| "Maven" | ||
| "Springboot", | ||
| "Maven", | ||
| "Gradle" |
There was a problem hiding this comment.
Correct language filter for Java Spring Template
The language is set to ["javascript"] but this is a Java template. Update to ["Java"] to ensure it appears under the correct filter.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 872 to 884, the language filter for
the Java Spring Template is incorrectly set to ["javascript"]. Change this value
to ["Java"] to correctly categorize the template under the Java language filter.
| "title": "HTML Template", | ||
| "description": "HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | ||
| "repoUrl": "https://github.com/asyncapi/html-template" | ||
| }, | ||
| "filters": { | ||
| "language": "javascript", | ||
| "technology": [ | ||
| "Node.js" | ||
| "HTML" |
There was a problem hiding this comment.
Standardize language filter type for HTML Template
Switch language from a string to an array (e.g. ["JavaScript"]) and use consistent casing.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 971 to 979, the language filter for
the HTML Template is currently a string with inconsistent casing. Change the
"language" field from a string to an array containing "JavaScript" with proper
capitalization, i.e., ["JavaScript"], to standardize the filter type and casing.
| "title": "Node.js Multiprotocol Template", | ||
| "description": "This template generates a server using your AsyncAPI document. It supports multiple different protocols, like Kafka or MQTT. It is designed in the way that generated code is a library and with it's API you can start the server, send messages or register a middleware for listening incoming messages. Runtime message validation included.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-ws-template" | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-template" | ||
| }, |
There was a problem hiding this comment.
Standardize language filter type for Node.js Multiprotocol Template
Use an array for language (e.g. ["JavaScript"]) rather than a string, and capitalize “JavaScript” to match the site’s conventions.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 894 to 898, the language filter for
the Node.js Multiprotocol Template is currently a string and uses lowercase
"javascript". Change the language field to be an array containing the
capitalized string "JavaScript" to standardize the format and match site
conventions.
| "title": "Node.js Websockets Template", | ||
| "description": "Node.js WebSockets template for the AsyncAPI Generator. It showcases how from a single AsyncAPI document you can generate a server and a client at the same time.", | ||
| "links": { | ||
| "repoUrl": "https://github.com/asyncapi/html-template" | ||
| "repoUrl": "https://github.com/asyncapi/nodejs-ws-template" | ||
| }, |
There was a problem hiding this comment.
Standardize language filter type for Node.js Websockets Template
Convert language from a string to ["JavaScript"] and use the proper casing.
🤖 Prompt for AI Agents
In config/tools-automated.json around lines 912 to 916, the language filter for
the Node.js Websockets Template is currently a string and not standardized.
Change the language field from a single string to an array containing
"JavaScript" with proper casing, i.e., ["JavaScript"], to maintain consistency
with other entries.
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/rtm |
Co-authored-by: asyncapi-bot <info@asyncapi.io> Co-authored-by: Eve <bot+eve@asyncapi.io>
Automated changes by create-pull-request GitHub action
Summary by CodeRabbit