Output contain valid XML tags

[kjaquier]

Describe the bug

Context

I'm testing out templates for integrating an AsyncAPI spec into a Docusaurus website. Docusaurus uses MDX which allows integrating JSX components and code into Markdown documents. I assume it accepts XML tags as HTML/JSX components which other Markdown parsers might ignore and render as text.

Actual issue

The output contains elements like array<integer> that can look like unclosed HTML elements to some parsers.

How to Reproduce

Write an AsyncAPI schema that include a property like:

type: object
properties:
  prop1:
    type: object
    properties:
      prop2:
        type: array
        items:
            type: number

The generated document will contain a table with this:

... | array<number> | ...

Expected behavior

The line above should be formatted as code:

... | `array<number>` | ...

There should be no < and > in the generated document that isn't formatted as code or escaped appropriately.

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

[jonaslagoni]

Hey @kjaquier, pretty sure we just need to change these 2 lines:

markdown-template/helpers/schema.js

Lines 112 to 114 in c35fc69

	return `array<${SchemaCustomTypes.ANY}>`;
	}
	return `array<${this.toSchemaType(items) || SchemaCustomTypes.UNKNOWN}>`;

Wanna help provide a fix for it?

[asyncapi-bot]

Hello, @jonaslagoni! 👋🏼

I'm 🧞🧞🧞 Genie 🧞🧞🧞 from the magic lamp. Looks like somebody needs a hand!

At the moment the following comments are supported in issues:

• /good-first-issue {js | ts | java | go | docs | design | ci-cd} or /gfi {js | ts | java | go | docs | design | ci-cd} - label an issue as a good first issue.
  example: /gfi js or /good-first-issue ci-cd

[kjaquier]

Ok this is what I got so far but some tests still need updating: 827bd0d

[derberg]

@kjaquier can you please open a PR, it would be easier this way to help providing a mergable PR 🙏🏼

[Gmin2]

should i raise a PR fixing it ?
cc @derberg @jonaslagoni

[derberg]

@Min2who go ahead please

[asyncapi-bot]

🎉 This issue has been resolved in version 1.6.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀