Show the Score of the Asyncapi file in the Asyncapi Studio

[AayushSaini101]

Many optional yet valuable parameters in the Async API specification can improve the developer experience. Like example, description, format, etc. When working with many specifications, I was asked, "How good is our documentation?". How do I measure if my documentation is good, mediocre, insufficient, or 1-100?

I propose a new command like score or evaluate that will reuse existing warnings and errors from the validate command. The command will extend the list of best practices and generate some final/aggregated scores. Hints that will increase the score should be provided.

A couple of examples

• if the specification has servers, then it increases the score
• if the specification has descriptions, then it increases the score
• if the specification has examples, then it increases the score
• if the specification has a format, then it increases the score
• if the specification has channels, then it increases the score
• if the specification has operations, then it increases the score
• if the specification has a license, then it increases the score

We can evaluate these parameters and based on the parameter, we can showcase the quality of the asyncapi in the studio.

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

[KhudaDad414]

@AayushSaini101 IMHO the quality of the AsyncAPI file is subjective. Some do not mention the server at all, this makes sense for them since they have only one server so why bother? Some only document the channels and it makes sense for their use case.
In the end, it is up to the user and how they use the Specification.

[Amzani]

As a second iteration, users could configure their score system.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️