Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

feat: add messageId property #751

Merged
merged 2 commits into from
Apr 22, 2022
Merged

feat: add messageId property #751

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c78a3e
feat: add messageId property
WaleedAshraf Apr 11, 2022
65ecc11
Update spec/asyncapi.md
WaleedAshraf Apr 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions spec/asyncapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1064,6 +1064,7 @@ Describes a message received on a given channel and operation.

Field Name | Type | Description
---|:---:|---
<a name="messageObjectMessageId"></a>messageId | `string` | Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is **case-sensitive**. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.
<a name="messageObjectHeaders"></a>headers | [Schema Object](#schemaObject) &#124; [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be of type "object". It **MUST NOT** define the protocol headers.
<a name="messageObjectPayload"></a>payload | `any` | Definition of the message payload. It can be of any type but defaults to [Schema object](#schemaObject). It must match the schema format, including encoding type - e.g Avro should be inlined as either a YAML or JSON object NOT a string to be parsed as YAML or JSON.
<a name="messageObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) &#124; [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
Expand Down Expand Up @@ -1103,6 +1104,7 @@ Name | Allowed values | Notes

```json
{
"messageId": "user#",
"name": "User#",
"title": "User #",
"summary": "Action to sign a user up.",
Expand Down Expand Up @@ -1166,6 +1168,7 @@ Name | Allowed values | Notes
```

```yaml
messageId: user#
name: User#
title: User #
summary: Action to sign a user up.
Expand Down Expand Up @@ -1213,6 +1216,7 @@ Example using Avro to define the payload:

```json
{
"messageId": "user#",
"name": "User#",
"title": "User #",
"summary": "Action to sign a user up.",
Expand All @@ -1230,6 +1234,7 @@ Example using Avro to define the payload:
```

```yaml
messageId: user#
name: User#
title: User #
summary: Action to sign a user up.
Expand Down Expand Up @@ -1259,6 +1264,7 @@ If you're looking to apply traits to an operation, see the [Operation Trait Obje

Field Name | Type | Description
---|:---:|---
<a name="messageTraitObjectMessageId"></a>messageId | `string` | Unique string used to identify the message. The id MUST be unique among all messages described in the API. The messageId value is **case-sensitive**. Tools and libraries MAY use the messageId to uniquely identify a message, therefore, it is RECOMMENDED to follow common programming naming conventions.
<a name="messageTraitObjectHeaders"></a>headers | [Schema Object](#schemaObject) &#124; [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be of type "object". It **MUST NOT** define the protocol headers.
<a name="messageTraitObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) &#124; [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
<a name="messageTraitObjectSchemaFormat"></a>schemaFormat | `string` | A string containing the name of the schema format/language used to define the message payload. If omitted, implementations should parse the payload as a [Schema object](#schemaObject).
Expand Down