Proposal to create new Message Example Object

[char0n]

Current situation is that Message.examples and MessageTrait.examples are using generic type of [Map[string, any]]. Then the description of examples field provide more structure:

An array of key/value pairs where keys MUST be either headers and/or payload. Values MUST contain examples that validate against the headers or payload fields, respectively. Example MAY also have the name and summary additional keys to provide respectively a machine-friendly name and a short summary of what the example is about.

IMHO this description warrants a new Message Example Object with fixed fields, instead of defining the structure with generic type and description. I propose to introduce new Message Example Object with following definition:

Message Example Object

<description placeholder>

Fixed Fields

Field Name	Type	Description
headers	Map[string, any]	<description placeholder>
payload	any	<description placeholder>
name	string	A machine-friendly name.
summary	string	A short summary of what the example is about.

---

Message.examples and MessageTrait.examples type will subsequently change to [Message Example Object]

[fmvilas]

Yeah, I think it would be a great idea 👍

Just a comment on the process side of things. For the proposal to be Stage 1 (RFC 1) it has to be a PR, not an issue: https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md#stage-1-proposal. It's ok as I don't want to be picky but thought you'd like to know 😊

[char0n]

Just a comment on the process side of things. For the proposal to be Stage 1 (RFC 1) it has to be a PR, not an issue: https://github.com/asyncapi/spec/blob/master/CONTRIBUTING.md#stage-1-proposal. It's ok as I don't want to be picky but thought you'd like to know

You're absolutely right ;] I'll read the document and align my efforts with the established processes.

[char0n]

Formal proposal has been issued via PR: #609

[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 ❤️

[char0n]

We can close this. The proposal has been accepted, merged and became part of 2.2.0.