feat: add support to display examples

[ITman1]

Description

• When example attribute is specified alongside with type/record field definition it is propagated into examples attribute of AsyncAPI schema
• Tested locally and on REACT component playground

Related issue(s)
Implements example feature from #18

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. 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.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[derberg]

@ITman1 fyi, I asked the community to share their opinion on a related issue as I'm not sure if we should actually provide such a support

[ITman1]

@derberg That is good question, main problem I see that it is not standardized anywhere, but AFAIK Avro Schema does not disalow to define those attributes.

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 60 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.
Thank you for your contributions ❤️

[derberg]

@ITman1 please update with latest master

[ITman1]

@derberg Updated from upstream repo

[bpb54321]

When will this be merged? I would like to use this ASAP in my project.

[derberg]

@bpb54321 I want to wait at least until the end of the week. Maybe @iemejia called out by @ITman1 will have time to have a look and will share his opinion on this. Otherwise next week definitely.

[derberg]

@ITman1 please have a look at failing linter, it complains on the complexity of the code

[ITman1]

@derberg Tried to extract some code into seperate functions, Sonar does not complain anymore locally. Both tests started to fail after my change so I also adjusted expected test results. IMHO there was a bug, Avro can have 'null' as default values, before null was ignored from the spec files and so does also 0 I would guess.

[derberg]

one tiny request to add one additional comment to the code + please update readme with information of extra fields support

[M3lkior]

@ITman1 fyi, I asked the community to share their opinion on a related issue as I'm not sure if we should actually provide such a support

From my side, it could be nice to have this feature merged. Here is the result of my generation based on avsc files ; all the attributes are null ; handle the example attribute could improve the reader experience ;)

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[derberg]

@ITman1 hey, sorry I did not notice you made required changes, if @M3lkior would not add his comment, I would miss it. There are too many PRs in many different repos. Next time you contribute (I hope you will 😄 ) please use the button to re-request review to trigger a notification.

[asyncapi-bot]

🎉 This PR is included in version 0.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀