event-catalog / event-catalog/generators

Message description showing only as summary if less than 150 chars in asyncapi generator

Open
#95 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
15
Forks
16
Avg merge
25m
Merged PRs (30d)
4

Description

### I tried this:

I am using the asyncapi generator

```
asyncapi: 3.0.0
info:
title: my-service
version: 1.0.0
description: my service description
defaultContentType: application/json
operations:
projectDeleted:
action: receive
channel:
$ref: '#/channels/projectDeletedChannel'
channels:
projectDeletedChannel:
address: /Message.ProjectDeleted
messages:
messageProjectDeleted:
$ref: '#/components/messages/messageProjectDeleted'
components:
messages:
messageProjectDeleted:
title: Message.ProjectDeleted
description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean volutpat est a ante suscipit pharetra. Pellentesque habitant morbi tristique senectus et nullam.
summary: Message summary
x-eventcatalog-message-type: event
payload: {}
```

### This happened:

The message description is handled as summary only if the lenght is <= 150 characters. If it is longer, it is not displayed anywhere.

### I expected this:

The `summary` and `description` fields of the message should be used instead of using only the first 150 characters of the description as summary.

### Is there a workaround?

_No response_

### Anything else?

Async API definition: https://www.asyncapi.com/docs/reference/specification/v3.0.0#messageObject

### EventCatalog Version

_No response_

### Node.js Version

_No response_

### Platform(s)

_No response_

### Community Notes

* Please vote by adding a 👍 reaction to the issue to help us prioritize.
* If you are interested to work on this issue, please leave a comment.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.