Skip to content

Commit 768ac3f

Browse files
authored
feat!: remove messageId from Message and MessageTraits objects (#984)
1 parent cc109fe commit 768ac3f

File tree

1 file changed

+0
-6
lines changed

1 file changed

+0
-6
lines changed

spec/asyncapi.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,7 +1227,6 @@ Describes a message received on a given channel and operation.
12271227

12281228
Field Name | Type | Description
12291229
---|:---:|---
1230-
<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.
12311230
<a name="messageObjectHeaders"></a>headers | [Multi Format Schema Object](#multiFormatSchemaObject) &#124; [Schema Object](#schemaObject) &#124; [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be a map of key-value pairs. It **MUST NOT** define the protocol headers. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
12321231
<a name="messageObjectPayload"></a>payload | [Multi Format Schema Object](#multiFormatSchemaObject) &#124; [Schema Object](#schemaObject) &#124; [Reference Object](#referenceObject) | Definition of the message payload. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
12331232
<a name="messageObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) &#124; [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
@@ -1248,7 +1247,6 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
12481247

12491248
```json
12501249
{
1251-
"messageId": "userSignup",
12521250
"name": "UserSignup",
12531251
"title": "User signup",
12541252
"summary": "Action to sign a user up.",
@@ -1312,7 +1310,6 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
13121310
```
13131311

13141312
```yaml
1315-
messageId: userSignup
13161313
name: UserSignup
13171314
title: User signup
13181315
summary: Action to sign a user up.
@@ -1360,7 +1357,6 @@ Example using Avro to define the payload:
13601357

13611358
```json
13621359
{
1363-
"messageId": "userSignup",
13641360
"name": "UserSignup",
13651361
"title": "User signup",
13661362
"summary": "Action to sign a user up.",
@@ -1380,7 +1376,6 @@ Example using Avro to define the payload:
13801376
```
13811377

13821378
```yaml
1383-
messageId: userSignup
13841379
name: UserSignup
13851380
title: User signup
13861381
summary: Action to sign a user up.
@@ -1411,7 +1406,6 @@ If you're looking to apply traits to an operation, see the [Operation Trait Obje
14111406

14121407
Field Name | Type | Description
14131408
---|:---:|---
1414-
<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.
14151409
<a name="messageTraitObjectHeaders"></a>headers | [Multi Format Schema Object](#multiFormatSchemaObject) &#124; [Schema Object](#schemaObject) &#124; [Reference Object](#referenceObject) | Schema definition of the application headers. Schema MUST be a map of key-value pairs. It **MUST NOT** define the protocol headers. If this is a [Schema Object](#schemaObject), then the `schemaFormat` will be assumed to be "application/vnd.aai.asyncapi+json;version=`asyncapi`" where the version is equal to the [AsyncAPI Version String](#A2SVersionString).
14161410
<a name="messageTraitObjectCorrelationId"></a>correlationId | [Correlation ID Object](#correlationIdObject) &#124; [Reference Object](#referenceObject) | Definition of the correlation ID used for message tracing or matching.
14171411
<a name="messageTraitObjectContentType"></a>contentType | `string` | The content type to use when encoding/decoding a message's payload. The value MUST be a specific media type (e.g. `application/json`). When omitted, the value MUST be the one specified on the [defaultContentType](#defaultContentTypeString) field.

0 commit comments

Comments
 (0)