feat(asyncapi-plugin): support externalLinks, owner and domain name from…

XaaXaaX commented 1 month ago

Motivation

This closes #518

The goal of this PR is to automate the discovery of extra useful information from Asyncapi spec while generating Domain, Service, and events. this helps to remove the extra manual markdown work.

By providing the following spec info object

asyncapi: 3.0.0
info:
  title: Account Service V3 In Domain 
  version: 1.0.0
  description: This service is in charge of processing user signups
  tags:
    - name: domain
      description: My Domain
    - name: owner
      description: myteam
  externalDocs:
    description: Find more info here
    url: 'https://example.com'

The service generated markdown will be

          ---
          name: 'Account Service V3'
          summary: 'This service is in charge of processing user signups'
          externalLinks:
            - {label: 'Find more info here', url: 'https://example.com'}
          owners:
            - myteam
          ---

          <NodeGraph />`

And the DomainName My Domain will be considered if no domainName is provided by plugin options

Have you read the Contributing Guidelines on pull requests?

YES

changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: 6f561354a551455d0cdfb42fa54b198c7cf72b7a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

event-catalog / eventcatalog